[ComVisible(true)]
[ClassInterface(ClassInterfaceType.AutoDual)]
[Guid("F57FBFA2-2B28-4B6E-BE81-95491D480AEE")]
public abstract class APIBase : MarshalByRefObjectPermanent, IEquatable<APIBase>

Constructors

APIBase()

Declaration

protected APIBase()

APIBase(Object, APIBase, String)

Declaration

protected APIBase(object wrapped, APIBase parent = null, string attributeNameOnParent = null)

Parameters

Type	Name	Description
System.Object	wrapped
APIBase	parent
System.String	attributeNameOnParent

Properties

cacheRpds

Declaration

protected virtual bool cacheRpds { get; }

Property Value

Type	Description
System.Boolean

isInvalid

Declaration

protected bool isInvalid { get; }

Property Value

Type	Description
System.Boolean

Methods

callPartialMethod(String, (Type, Object)[])

Declaration

protected object callPartialMethod(string methodName, params (Type, object)[] parameters)

Parameters

Type	Name	Description
System.String	methodName
System.ValueTuple<System.Type, System.Object>[]	parameters

Returns

Type	Description
System.Object

callPartialMethod<T>(String, out T)

Declaration

protected object callPartialMethod<T>(string methodName, out T outParameter)

Parameters

Type	Name	Description
System.String	methodName
T	outParameter

Returns

Type	Description
System.Object

Type Parameters

Name	Description
T

callPartialMethod<T>(String, (Type, Object), out T)

Declaration

protected object callPartialMethod<T>(string methodName, (Type, object) parameter, out T outParameter)

Parameters

Type	Name	Description
System.String	methodName
System.ValueTuple<System.Type, System.Object>	parameter
T	outParameter

Returns

Type	Description
System.Object

Type Parameters

Name	Description
T

callPartialMethod<T>(String, (Type, Object), (Type, Object), out T)

Declaration

protected object callPartialMethod<T>(string methodName, (Type, object) parameter1, (Type, object) parameter2, out T outParameter)

Parameters

Type	Name	Description
System.String	methodName
System.ValueTuple<System.Type, System.Object>	parameter1
System.ValueTuple<System.Type, System.Object>	parameter2
T	outParameter

Returns

Type	Description
System.Object

Type Parameters

Name	Description
T

callPartialMethod<T>(String, (Type, Object), (Type, Object), (Type, Object), out T)

Declaration

protected object callPartialMethod<T>(string methodName, (Type, object) parameter1, (Type, object) parameter2, (Type, object) parameter3, out T outParameter)

Parameters

Type	Name	Description
System.String	methodName
System.ValueTuple<System.Type, System.Object>	parameter1
System.ValueTuple<System.Type, System.Object>	parameter2
System.ValueTuple<System.Type, System.Object>	parameter3
T	outParameter

Returns

Type	Description
System.Object

Type Parameters

Name	Description
T

callPartialMethod<T1, T2>(String, (Type, Object), out T1, out T2)

Declaration

protected object callPartialMethod<T1, T2>(string methodName, (Type, object) parameter, out T1 outParameter1, out T2 outParameter2)

Parameters

Type	Name	Description
System.String	methodName
System.ValueTuple<System.Type, System.Object>	parameter
T1	outParameter1
T2	outParameter2

Returns

Type	Description
System.Object

Type Parameters

Name	Description
T1
T2

clearCachedRpds()

Declaration

protected void clearCachedRpds()

CreateObjRef(Type)

Declaration

[ComVisible(false)]
public override ObjRef CreateObjRef(Type requestedType)

Parameters

Type	Name	Description
System.Type	requestedType

Returns

Type	Description
System.Runtime.Remoting.ObjRef

Overrides

System.MarshalByRefObject.CreateObjRef(System.Type)

createWrappedPosition3D(Double, Double, Double)

Declaration

protected IExposeAsVector3DInApi createWrappedPosition3D(double x, double y, double z)

Parameters

Type	Name	Description
System.Double	x
System.Double	y
System.Double	z

Returns

Type	Description
SMT.Utility.Vectors.IExposeAsVector3DInApi

createWrappedRange(Double, Double)

Declaration

protected IExposeAsRangeInApi createWrappedRange(double min, double max)

Parameters

Type	Name	Description
System.Double	min
System.Double	max

Returns

Type	Description
SMT.Utility.Vectors.IExposeAsRangeInApi

createWrappedVector2D(Double, Double)

Declaration

protected IExposeAsVector2DInApi createWrappedVector2D(double x, double y)

Parameters

Type	Name	Description
System.Double	x
System.Double	y

Returns

Type	Description
SMT.Utility.Vectors.IExposeAsVector2DInApi

DisconnectFromMASTA()

Disconnect from RemotingServices. Attempting to use a disconnected object will cause a RemotingException

Declaration

public void DisconnectFromMASTA()

DocumentationUrl()

Declaration

public string DocumentationUrl()

Returns

Type	Description
System.String

Equals(APIBase)

Declaration

public virtual bool Equals(APIBase other)

Parameters

Type	Name	Description
APIBase	other

Returns

Type	Description
System.Boolean

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

getExpandableProperty<TReturnType>(String)

Declaration

protected TReturnType getExpandableProperty<TReturnType>(string rpdName)
    where TReturnType : APIBase

Parameters

Type	Name	Description
System.String	rpdName

Returns

Type	Description
TReturnType

Type Parameters

Name	Description
TReturnType

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

getNamedObjectList<TElementType>(String)

Declaration

protected ReadOnlyCollection<TElementType> getNamedObjectList<TElementType>(string rpdName)
    where TElementType : APIBase

Parameters

Type	Name	Description
System.String	rpdName

Returns

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<TElementType>

Type Parameters

Name	Description
TElementType

getPartialProperty(String)

Declaration

protected object getPartialProperty(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.Object

GetProperty<T>(String)

Declaration

public T GetProperty<T>(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
T

Type Parameters

Name	Description
T

IsReadOnly(String)

Declaration

public bool IsReadOnly(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.Boolean

IsValid(String)

Declaration

public bool IsValid(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Returns

Type	Description
System.Boolean

RunPython(String, String, Object)

Declaration

public void RunPython(string script, string methodName, object value)

Parameters

Type	Name	Description
System.String	script
System.String	methodName
System.Object	value

RunPython<T>(String, String)

Declaration

public T RunPython<T>(string script, string methodName)

Parameters

Type	Name	Description
System.String	script
System.String	methodName

Returns

Type	Description
T

Type Parameters

Name	Description
T

RunPython<T>(String, String, Object)

Declaration

public T RunPython<T>(string script, string methodName, object value)

Parameters

Type	Name	Description
System.String	script
System.String	methodName
System.Object	value

Returns

Type	Description
T

Type Parameters

Name	Description
T

RunPythonCode<T>(String)

Declaration

public T RunPythonCode<T>(string scriptCode)

Parameters

Type	Name	Description
System.String	scriptCode

Returns

Type	Description
T

Type Parameters

Name	Description
T

RunPythonCode<T>(String, String, Object)

Declaration

public T RunPythonCode<T>(string scriptCode, string argumentName, object value = null)

Parameters

Type	Name	Description
System.String	scriptCode
System.String	argumentName
System.Object	value

Returns

Type	Description
T

Type Parameters

Name	Description
T

setPartialProperty(String, Object)

Declaration

protected void setPartialProperty(string propertyName, object value)

Parameters

Type	Name	Description
System.String	propertyName
System.Object	value

SetProperty(String, Object)

Declaration

public void SetProperty(string name, object value)

Parameters

Type	Name	Description
System.String	name
System.Object	value

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Operators

Equality(APIBase, APIBase)

Declaration

[Pure]
public static bool operator ==(APIBase lhs, APIBase rhs)

Parameters

Type	Name	Description
APIBase	lhs
APIBase	rhs

Returns

Type	Description
System.Boolean

Inequality(APIBase, APIBase)

Declaration

[Pure]
public static bool operator !=(APIBase lhs, APIBase rhs)

Parameters

Type	Name	Description
APIBase	lhs
APIBase	rhs

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>

Extension Methods

UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)

UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)

UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)

UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)