beautypg.com

Control object macros, Control object macros -33 – Clear-Com Logic-Maestro User Manual

Page 99

background image

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.
.Dispose();

Equals (Object) [bool]

Tests the equivalence of two objects and returns True or
False. e.g:
bool = .equals<(object2)>;

GetGPSF () [GPSF]

Gets the GPSF e.g.
GPSF = .GetGPSF();

GetGPSF (TalkType) [GPSF]

Gets the talk type for GPSF e.g.
GPSF = .GetGPSF();

GetHashCode () [int]

Returns the hash code of an object previously created
by a control as an integer. e.g:
int = .GetHashCode();

GetID (TalkType) [Guid]

Returns the Guid of the talk/listen status of an object
created by a control macro e.g.
Guid = .GetID();

GetOwnerSystemGPSF(Talk-
Type) [GPSF]

Returns the GPSF of an object specified by TalkType
e.g.
GPSF = .GetOwnerSys-
temGPSF(TalkType.);

GetOwnerSystemRackOff-
set(TalkType) [ushort]

Returns the rack number of an object specified by Talk-
Type e.g.
ushort = .GetOwnerSystemRack-
Offset(TalkType.);

GetRackOffset () [ushort]

Returns an offset value as an unsigned short for the
object previously created by a control macro e.g.
ushort = .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 = .GetRackOffset();

GetType () [Type]

Returns the type of an object previously created by a
control macro. e.g.
Type = .GetType();

See also other documents in the category Clear-Com Accessories communication: