Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 3 8
PortNumber [ushort]
Sets or returns the port number of an object created by
a control macro as an unsigned short e.g.
ushort
= or
PortSubType [EntityType]
Sets or returns the port subtype of an object created by
a control macro as a port subtype entity e.g.
PortObject
= or
PortType [BasicType]
Sets or returns the port type of an object created by a
control macro as a port type entity e.g.
PortObject = or
PreventReplySignalisation [bool]
Sets the status of the prevent reply signalization setting
for the port using the boolean e.g.
.PreventReplySignalization = True; PreventTally [bool]
Sets or returns the status of the prevent tally setting for
the port using the boolean e.g.
.PreventTally = False; or
PortObject =
.PreventTally; ProtectPortAssignment [bool]
Sets or returns the status of the port protection setting
for the port using the boolean e.g.
.ProtectPortAssignment = True; or
PortObject protectPortAssignment =
object>.ProtectPortAssignment; SecondaryAction [Guid]
Sets or returns the secondary action of an object cre-
ated by a control macro e.g.
Guid = or
SplitLabel [bool]
Sets or returns the split label status of a port using the
boolean e.g.
.SplitLabel = True; or
PortObject =
.SplitLa- bel; Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 3 9
StackedKey [bool]
Sets or returns a boolean indicating whether a key is a
stacked key e.g.
bool = or
TalkAlias [string]
Sets or returns the talk alias of an object created by a
control macro e.g.
ControlObject = or
TalkLabel [string]
Sets or returns the talk label of an object created by a
control macro e.g.
ControlObject = or
VoxAction [Guid]
Sets or returns the vox action of an object created by a
control macro e.g.
Guid = or
Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 4 0
CONDITION MACROS
These macros are accessed by expanding the ‘Clearcom’ > ‘ScriptLibrary’ >
‘Condition’ entry in the Available Modules menu.
Macro Description CompareTo (Object) [int]
Returns an integer value from the comparison of two
objects e.g.
int = .CompareTo(); Equals (Object) [bool]
Tests the equivalence of two objects and returns True or
False. e.g:
bool = .equals<(object2)>; GetHashCode () [int]
Returns the hash code of an object previously created
by a control as an integer. e.g:
int = GetType () [Type]
Returns the type of an object previously created by a
control macro. e.g.
Type = GetTypeCode () [TypeCode]
Returns the type code of an object previously created by
a control macro. e.g.
TypeCode = ToString () [string]
Returns the string value of an object previously created
by a control macro. e.g.
string = ToString (IFormatProvider)
[string]
Returns the string value of an object previously created
by a control macro formatted by a format specifier e.g.
string = ToString (string) [string]
Returns the string value of an object previously created
by a control macro formatted by a format provded as a
parameter e.g.
string = ToString (string, IFormatPro-
vider) [string]
Returns the string value of an object previously created
by a control macro formatted by a format provded as two
parameters e.g.
string =
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 4 1
CONTROL ACTIONS MACRO
Control action macros act on system configuration objects to change
the state of the object. The format of a control action macro command
is:
ControlActions. ; The ‘ControlActionMacro’ command is used to change the state of a
system configuration object
For example, the command:
Action fireLed1 = ControlActions.ActivateLED(
); will create an action ‘fireLED1’ that changes the state of the system
object LED1 in accordance with the parameters supplied.
These macros are accessed by expanding the ‘Clearcom’ >
‘ScriptLibrary’ > ‘ControlActions’ entry in the Available Modules menu.
value__ [int]
Returns the value of a condition eg.
Condition = .value__; Macro Description Macro Description ActivateLED(EntityObject,
LedRate, LedIndication) [Action]
Returns a control object to set the flash rate and color
for a specified LED e.g.
Action = ControlActions.ActivateLED( ject>, Ledrate, Off, LedIndications.Red); ActivateLED (EntityObject[],
LedRate, LedIndication) [Action]
Returns a control object to set the flash rate and color
for specified LED e.g.
Action = ControlActions.ActivateLED( ject>, LedRate.Off, LedIndictions.Red); ActivateLED (PortObject, Entity-
Object, LedRate, LedIndication)
[Action]
Returns a control object to set the flash rate and color
for a specified LED on a specified port e.g.
Action = ControlActions.ActivateLED(
, , LedRate.Off, LedIndication.Red);
