Clear-Com Logic-Maestro - Manual (Page 99)

Clear-Com Communication Systems
Eclipse Logic Maestro Instruction Manual 2 - 3 3
CONTROL OBJECT MACROS
These macros are accessed by expanding the ‘Clearcom’ > ‘Entities’ >
‘ControlObject’ entry in the Available Modules menu.
Macro Description
Dispose () [void] Disposes of an object created by a control macro e.g.
<object>.Dispose();
Equals (Object) [bool] Tests the equivalence of two objects and returns True or
False. e.g:
bool <result> = <object1>.equals<(object2)>;
GetGPSF () [GPSF] Gets the GPSF e.g.
GPSF <result> = <object>.GetGPSF();
GetGPSF (TalkType) [GPSF] Gets the talk type for GPSF e.g.
GPSF <result> = <object>.GetGPSF(<talk type>);
GetHashCode () [int] Returns the hash code of an object previously created
by a control as an integer. e.g:
int <result> = <object>.GetHashCode();
GetID (TalkType) [Guid] Returns the Guid of the talk/listen status of an object
created by a control macro e.g.
Guid <return> = <object>.GetID(<talk/listen type>);
GetOwnerSystemGPSF(Talk-
Type) [GPSF] Returns the GPSF of an object specified by TalkType
e.g.
GPSF <return> = <object>.GetOwnerSys-
temGPSF(TalkType.<talk/listen type>);
GetOwnerSystemRackOff-
set(TalkType) [ushort] Returns the rack number of an object specified by Talk-
Type e.g.
ushort <return> = <object>.GetOwnerSystemRack-
Offset(TalkType.<talk/listen type>);
GetRackOffset () [ushort] Returns an offset value as an unsigned short for the
object previously created by a control macro e.g.
ushort <value> = <object>.GetRackOffset();
GetRackOffset (TalkType) [ush-
ort] Returns an offset value as an unsigned short for the
object previously created by a control macro where the
type of route is specified ie Talk and/or Listen e.g.
ushort <value> = <object>.GetRackOffset(<type>);
GetType () [Type] Returns the type of an object previously created by a
control macro. e.g.
Type <result> = <object>.GetType();