Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 4 9
SetsWhenOn(ControlLatch)
[void]
This control latch function will set a latch when a control
input is on. The example below shows sequence to get
a control reference, create a latch and assign the latch
to be set when the control input is on.
Macro_INPUT1_=_ControlMacro.GetCon-_trol("INB",_"");_ControlLatch_LATCH1_=_ControlLatch.CreateLatch();_LATCH1.TogglesWhenOff(INPUT1);'>ControlMacro INPUT1 = ControlMacro.GetCon- trol("INB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.SetsWhenOn(INPUT1); TogglesWhenOff(ControlLatch)
[void]
This control latch function will toggle a latch when a con-
trol input is off. The example below shows sequence to
get a control reference, create a latch and assign the
latch to be toggled when the control input is off.
ControlMacro INPUT1 = ControlMacro.GetCon- trol("INB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.TogglesWhenOff(INPUT1); TogglesWhenOn(ControlLatch)
[void]
This control latch function will toggle a latch when a con-
trol input is on. The example below shows sequence to
get a control reference, create a latch and assign the
latch to be toggled when the control input is on.
ControlMacro INPUT1 = ControlMacro.GetCon- trol("INB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.TogglesWhenOn(INPUT1); ToString() [string]
Returns the string value of an object previously created
by a control macro. e.g.
string = TriggersWhenOff(Control-
Macro] [void]
Triggers a control macro object when the input condition
is OFF e.g.
.TriggersWhenOff(ControlMacro); TriggersWhenOff(Action) [void]
This control latch function will trigger an action on a
crosspoint when the
ControlMacro OUTPUT1 = ControlMacro.GetCon- trol("OUTB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.TriggersWhenOff(OUTPUT1); Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 5 0
TriggersWhenOn(Control-
Macro) [void]
This control latch function will trigger an output to the
specified control when the input to the latch is on. The
example below shows sequence to get a control refer-
ence, create a latch and set the latch to trigger the con-
trol when the input is on.
ControlMacro OUTPUT1 = ControlMacro.GetCon- trol("OUTB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.TriggersWhenOn(OUTPUT1); TriggersWhenOn(Action) [void]
This control latch function will trigger an output to the
specified control when the input to the latch is on. The
example below shows sequence to get a control refer-
ence, create a latch and set the latch to trigger the con-
trol when the input is on e.g.
ControlMacro OUTPUT1 = ControlMacro.GetCon- trol("OUTB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.TriggersWhenOn(OUTPUT1); GetId [ushort]
Returns the ID of an object e.g.
ControlLatch = .GetId; Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 5 1
CONTROL MACROS
Control macros act on system configuration objects to get or set
parameters or to change the state of the object. The format of a
control macro command is:
ControlMacro. ; The ‘ControlMacro’ command is used to create a copy of a system
configuration object which can then to used in the control macro.
For example, the command:
ControlMacro GP19 = ControlMacro.GetControl(“GP19”); will create a copy of the GPIO control object called GP19 created by
ECS called GP19 which can be used in the control macro.
These macros are accessed by expanding the ‘Clearcom’ >
‘ScriptLibrary’ > ‘ControlMacro’ entry in the Available Modules menu.
Macro Description CreateControl (string) [Control-
Macro]
Creates a control named by the string e.g.
ControlMacro AND_60 = ControlMacro.CreateCon- trol(“AND_60”); CreateControl(string,bool) [Con-
trolMacro]
Creates a control named by the string with a state set by
the boolean e.g.
ControlMacro AND_60 = ControlMacro.CreateCon- trol("AND_60", true); Equals (Object) [bool]
Tests the equivalence of two objects and returns True or
False. e.g.
bool = .equals<(object2)>; GetAllEntities[(bool) [EntityOb-
ject[]]
Returns a list of all known entities e.g.
EntityObject[] = ControlMacro.GetAll Entities( system only boolean>); GetAllPorts() [PortObject[]]
Returns all the known ports in a system to an allay of
PortObject e.g.
PortObject[] allportsknown = ControlMacro.GetAll- Ports(); GetAllPorts(bool) [PortObject[]]
Returns a list of port objects e.g.
PortObject[] = ControlMacro.GetAllPorts( tem only boolean>);
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 5 2
GetAllStations() [PortObject[]]
Returns an array of PortObject containing all the panels
in a system e.g.
PortObject[] stationsToCut = ControlMacro.GetAll- Stations(); GetControl (Guid) [Control-
Macro]
Gets the control information for the item named in the
string parameter e.g.
ControlMacro. trol(); GetControl (string) [Control-
Macro]
Returns a reference to a control label with the given Talk
label e.g.
ControlMacro CONTROL = ControlMacro.GetCon- trol("CTLA ") GetControl(string,string) [Con-
trolMacro]
Returns a reference to a control label with the given Talk
and Listen labels e.g.
ControlMacro CONTROL = ControlMacro.GetCon- trol("CTLA ", " ") GetControl(string,string,int)
[ControlMacro]
Returns a reference to a control label with the given Talk
and Listen labels on the specified system e.g.
ControlMacro CONTROL = ControlMacro.GetCon- trol("CTLA ", " ", 1) GetEntities(string) [EntityOb-
ject[]]
Return the entities specified in the string e.g.
EntityObject[] = ControlMacro.GetEnti- ties(“”); GetEntity(string) [EntityObject]
Returns the entity specified in the string e.g.
EntityObject = ControlMacro.GetEn- tity(); GetGroup(string) [EntityObject]
Returns the talk label for a group e.g.
EntityObject = ControlMacro.Get- Group(“”); GetGroup(string string) [Entity-
Object]
Returns the talk and listen labels for the group specified
as strings e.g.
EntityObject = ControlMacro.get- Group(“”, “”); GetGroup(string,string,int) [Enti-
tyObject]
Returns the talk and listen labels for a group on the
given system number e.g.
EntityObject = ControlMacro.Get- Group(“, , number>); GetGroupMembers(EntityOb-
ject) [EntityObject[]]
Returns the members of a specified group e.g.
EntityObject[] = ControlMacro.GetGroup- Members(); Macro Description
