Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 5 3
GetHashCode () [int]
Returns the hash code of an object previously created
by a control as an integer. e.g.
int = GetLocalSharedListenPortNum-
berForRemoteEntity(PortOb-
ject) [ushort]
Returns the port number on the remote system for the
specified Listen port object e.g.
ushort
= ControlMacro.GetLo- calSharedListenPortNumberForRemoteEntity(
object>); GetLocalSharedTalkPortNum-
berForRemoteEntity(PortOb-
ject) [ushort]
Returns the port number on the remote system for the
specified Talk port object e.g.
ushort
= ControlMacro.GetLo- calSharedTalkPortNumberForRemoteEntity(
object>); GetPartyLine(string) [EntityOb-
ject]
Returns an entity for the named party line talk label e.g.
EntityObject = ControlMacro.GetPartyL- ine(
); GetPartyLine(string string) [Enti-
tyObject]
Returns the talk and listen labels for the party line e.g.
EntityObject = ControlMacro.GetPartyL- ine(, ); GetPartylineMembers(EntityOb-
ject) [EntityObject[]]
Returns the members of a party line e.g.
EntityObject[] = ControlMacro.GetPartyL- ineMembers(EntityObject); GetPort (Guid) [PortObject]
Gets the Guid for a port e.g.
PortObject = ControlMacro.GetPort(
Guid>); GetPort (int) [PortObject]
Returns a reference for the specified port number e.g.
PortObject p = ControlMacro.GetPort(600) GetPort (string) [PortObject]
Returns a reference for a port with the given Talk label
e.g.
PortObject p = ControlMacro.GetPort("Talk ") GetPort(string string) [PortOb-
ject]
Returns the reference for a port with the given Talk and
Listen labels e.g.
PortObject p = ControlMacro.GetPort("Talk ", "Lstn ") GetPort(string string int) [PortO-
bject]
Returns the reference for a port with the given Talk and
Listen labels and port number e.g.
PortObject p = ControlMacro.GetPort("Talk ", "Lstn ", 600) Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 5 4
GetType () [Type]
Returns the type of an object previously created by a
control macro. e.g.
Type = Inhibits(ControlMacro) [void]
Causes a specified control action to be inhibited e.g.
.Inhibits(); Inhibits(ControlMacro, ushort)
[void]
Causes a specified control action to be inhibited e.g.
.Inhibits(, parameter>); NameExists(string) [bool]
Returns a boolean indicating whether a named entity
exists e.g.
bool = ControlMacro.NameExists( name>); Resets(ControlLatch) [void]
Resets the specified control latch e.g.
.Resets(latch name); SetDefaultGateway(string) [void]
Sets the default gateway address 1 on a frame to the
specified string e.g.
ControlMacro.SetDefaultGateway( address>); SetDefaultGateway2(string)
[void]
Sets the default gateway address 2 on a frame to the
specified string e.g.
ControlMacro.SetDefaultGateway2( 2 address>); Sets(ControlLatch) [void]
Set a control latch e.g.
.Sets(ControlLatch); SetSubnetMask(string) [void]
Sets the subnetmask 1 on a frame to the specified string
e.g.
ControlMacro.SetSubnetMask( string>); SetSubnetMask2(string) [void]
Sets the subnetmask 2 on a frame to the specified string
e.g.
ControlMacro.SetSubnetMask2( string>); Toggles(ControlLatch) [void]
Toggles the specified control latch e.g.
.Toggles(ControlLatch); ToString () [string]
Returns the string value of an object previously created
by a control macro. e.g.
string = Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 5 5
CROSSPOINT CONTROL
Triggers (ControlMacro) [void]
This command executes a previously defined control.
For example if an instance ‘GP23’ has been defined
using the GetControl control macro and the control
‘fireLED1’ has been defined using the ControlActions
macro the control ‘fireLED1 can be used as the parame-
ter to the Trigger macro e.g.
GP23.Triggers (fireLED1); Triggers (Action) [void]
This command executes a previously defined action.
For example if an instance ‘GP23’ has been defined
using the GetControl control macro and the action
‘fireLED1’ has been defined using the ControlActions
macro the action ‘fireLED1 can be used as the parame-
ter to the Trigger macro.e.g.
GP23.Triggers (fireLED1); TriggersIf (ControlMacro, Condi-
tion, ControlMacro) [void]
Triggers an action if the result of the condition test on
the two control macros is met e.g.
.TriggersIf(, tion>,); Triggerslf(CrosspointCon-
trol,Condition,ControlMacro)
[void]
Triggers a crosspoint control for a specified condition
e.g.
.TriggersIf(CrospointControl, tion>, ControlMacro); Triggerslf(CrosspointCon-
trol,Condition,CrosspointCon-
trol) [void]
Triggers a crosspoint control for a specified condition
e.g.
.TriggersIF(CrosspointControl, tion>, CrosspointControl); ControlObject [ControlObject]
Creates a control macro for an object e.g.
ControlMacro = Macro Description Macro Description Equals(Object) [bool]
Tests the equivalence of two objects and returns True or
False. e.g.
bool = .equals<(object2)>; GetDestination() [PortObject]
Returns the destination port for a crosspoint e.g.
PortObject =
.GetDestination; GetHashCode() [int]
Returns the hash code of an object previously created
by a control as an integer. e.g.
int =
