Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 4 5
RouteToGroup (ushort, ushort,
bool, bool, ushort) [Action]
Returns an action for creating a route between two
groups e.g.
Action = ControlActions.RouteToGroup( port no>, , boolean>,
, number>); RouteToGroupAction ()
[RouteToGroupAction]
Returns an action for creating a route to a group e.g.
RouteToGroupAction = ControlAc- tions.RouteTo GroupAction(); RouteToGroupOn (ushort, ush-
ort) [Action]
Returns an action for enabling a route between two
groups e.g.
Action = ControlActions.RouteToGroupOn( port no>, ); RouteToIfbOn (PortObject, Por-
tObject) [Action]
Returns an action for enabling a route to an IFB e.g.
Action = ControlActions.RouteToIfbOn( object>, ); RouteToPartyLine (portObject,
EntityObject) [Action]
Returns an action for enabling a route to a party line e.g.
Action = ControlActions.RouteToPartyLine( port object>,
); RouteToPartyLine (ushort, ush-
ort, bool, bool, ushort) [Action]
Returns an action for enabling a route between two
party lines e.g.
Action = ControlActions.RouteToPartyLine( port number>,
, boolean>,
, remote system number>); RouteToPartyLineAction ()
[RouteToPartyLineAction]
Returns an action for creating a route to a party line e.g.
RouteToPartyLineAction = ControlAc- tions.RouteTo PartyLineAction(); SourceToIfbOn (PortObject,
PortObject) [Action]
Creates an action to enable a crosspoint linking the
source and destination ports for an IFB.
PortObject s = ControlMacro_Description_Equals_(object)_[bool]_Tests_the_equivalence_of_two_objects_and_returns_True_or_False._e.g._bool_=_.equals_;'>Macro.GetPort(sourceport); PortObject d = ControlMacro GetPort(destport); Action action; action = ControlActions.SourceToIfbOn(s, d); SpeedDial (PortObject, string)
[SpeedDialAction]
Returns an action for creating a speed dial with a port
object and a telephone number e.g.
SpeedDialAction = ControlAction.SpeedDi- alAction (
,); Macro Description
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 4 6
SpeedDialAction (ushort, ushort)
[Action]
Returns an action for creating a speed dial action with a
speed dial ID and a port number e.g.
Action = ControlAction.SpeedDialAction (,
); 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 - 4 7
CONTROL ATTACHMENT MACROS
These macros are accessed by expanding the ‘Clearcom’ > ‘ScriptLibrary’ >
‘ControlAttachment’ entry in the Available Modules menu.
Macro Description 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 = ToString () [string]
Returns the string value of an object previously created
by a control macro. e.g.
string = ActivationState [Attachment-
State]
Gets or sets the listen activation state of an object e.g.
AttachmentObject [Attachmen-
tObject]
Gets or sets the talk activation state of an object e.g.
Clear-Com
Eclipse Logic Maestro Instruction Manual
A - 4 8
CONTROL LATCH MACROS
These macros are accessed by expanding the ‘Clearcom’ > ‘ScriptLibrary’ >
‘ControlLatch’ entry in the Available Modules menu.
Macro Description CreateLatch() [ControlLatch]
Creates and returns a control latch e.g.
ControlLatch AlwaysOff = ControlLatch.Create- Latch() 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 = ResetsWhenOff(ControlLatch)
[void]
This control latch function will reset a latch when a con-
trol input is off. The example below shows sequence to
get a control reference, create a latch and set the latch
to reset when the control input is off.
ControlMacro INPUT1 = ControlMacro.GetCon- trol("INB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.ResetsWhenOff(INPUT1); ResetsWhenOn(ControlLatch)
[void]
This control latch function will reset a latch when a con-
trol input is on. The example below shows sequence to
get a control reference, create a latch and set the latch
to reset when the control input is on.
ControlMacro INPUT1 = ControlMacro.GetCon- trol("INB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.ResetsWhenOn(INPUT1); SetsWhenOff(ControlLatch)
[void]
This control latch function will set a latch when a control
input is off. 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 off.
ControlMacro INPUT1 = ControlMacro.GetCon- trol("INB", ""); ControlLatch LATCH1 = ControlLatch.CreateLatch(); LATCH1.SetsWhenOff(INPUT1);