Class APIBase
Inheritance
System.Object
APIBase
Assembly: SMT.MastaAPI.15.0.dll
Syntax
public abstract class APIBase : MarshalByRefObjectPermanent, IEquatable<APIBase>
Constructors
APIBase()
Declaration
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
AllPropertiesAreInvalid
Declaration
public bool AllPropertiesAreInvalid { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllPropertiesAreReadOnly
Declaration
public bool AllPropertiesAreReadOnly { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
cacheRpds
Declaration
protected virtual bool cacheRpds { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
InvalidProperties
Declaration
public IReadOnlyList<string> InvalidProperties { get; }
Property Value
| Type |
Description |
| System.Collections.Generic.IReadOnlyList<System.String> |
|
isInvalid
Declaration
protected bool isInvalid { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
ReadOnlyProperties
Declaration
public IReadOnlyList<string> ReadOnlyProperties { get; }
Property Value
| Type |
Description |
| System.Collections.Generic.IReadOnlyList<System.String> |
|
Methods
callPartialMethod(String, [])
Declaration
protected object callPartialMethod(string methodName, params[] parameters)
Parameters
| Type |
Name |
Description |
| System.String |
methodName |
|
| System.[] |
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
callPartialMethod<T>(String, , out T)
Declaration
protected object callPartialMethod<T>(string methodName, parameter, out T outParameter)
Parameters
| Type |
Name |
Description |
| System.String |
methodName |
|
| System. |
parameter |
|
| T |
outParameter |
|
Returns
| Type |
Description |
| System.Object |
|
Type Parameters
callPartialMethod<T>(String, , , out T)
Declaration
protected object callPartialMethod<T>(string methodName, parameter1, parameter2, out T outParameter)
Parameters
| Type |
Name |
Description |
| System.String |
methodName |
|
| System. |
parameter1 |
|
| System. |
parameter2 |
|
| T |
outParameter |
|
Returns
| Type |
Description |
| System.Object |
|
Type Parameters
callPartialMethod<T>(String, , , , out T)
Declaration
protected object callPartialMethod<T>(string methodName, parameter1, parameter2, parameter3, out T outParameter)
Parameters
| Type |
Name |
Description |
| System.String |
methodName |
|
| System. |
parameter1 |
|
| System. |
parameter2 |
|
| System. |
parameter3 |
|
| T |
outParameter |
|
Returns
| Type |
Description |
| System.Object |
|
Type Parameters
callPartialMethod<T1, T2>(String, , out T1, out T2)
Declaration
protected object callPartialMethod<T1, T2>(string methodName, parameter, out T1 outParameter1, out T2 outParameter2)
Parameters
| Type |
Name |
Description |
| System.String |
methodName |
|
| System. |
parameter |
|
| T1 |
outParameter1 |
|
| T2 |
outParameter2 |
|
Returns
| Type |
Description |
| System.Object |
|
Type Parameters
clearCachedRpds()
Declaration
protected void clearCachedRpds()
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 |
|
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 |
|
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 Parameters
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 Parameters
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 Parameters
RunPythonCode<T>(String)
Declaration
public T RunPythonCode<T>(string scriptCode)
Parameters
| Type |
Name |
Description |
| System.String |
scriptCode |
|
Returns
Type Parameters
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 Parameters
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 |
|
ToListWithSelectedItem<T>(T, IEnumerable<T>)
Declaration
public ListWithSelectedItem<T> ToListWithSelectedItem<T>(T selectedValue, IEnumerable<T> possibleValues)
Parameters
| Type |
Name |
Description |
| T |
selectedValue |
|
| System.Collections.Generic.IEnumerable<T> |
possibleValues |
|
Returns
Type Parameters
ToListWithSelectedItem<T>(IEnumerable<T>)
Declaration
public ListWithSelectedItem<T> ToListWithSelectedItem<T>(IEnumerable<T> possibleValues)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.IEnumerable<T> |
possibleValues |
|
Returns
Type Parameters
ToString()
Declaration
public override string ToString()
Returns
| Type |
Description |
| System.String |
|
Operators
Equality(APIBase, APIBase)
Declaration
public static bool operator ==(APIBase lhs, APIBase rhs)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Inequality(APIBase, APIBase)
Declaration
public static bool operator !=(APIBase lhs, APIBase rhs)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Implements
System.IEquatable<T>
Extension Methods