Clear-Com Logic-Maestro - Manual (Page 95)

Clear-Com Communication Systems
Eclipse Logic Maestro Instruction Manual 2 - 2 9
MACRO REFERENCE
The objects from the Available Modules are described in this section.
These macros are used to construct control macros using the control
macro editor. The meanings of the parameters used by the macros
are:
• () - required parameter(s)
• [] - type of argument returned
• object - the name of the object being tested, normally an object
created by a control macro such as ‘GetPort’
• bool - boolean operator, set to True or False
• int - integer value in the range 0 - 32767
• string - alphanumeric string parameter
• Guid - an ECS internal global identifier. Every entity has a unique
internal identifier and while these may be used as input parameters
for some control macros they are not generally used.
ATTACHMENTOBJECT MACROS
These macros are accessed by expanding the ‘Clearcom’ > ‘Entities’ >
‘AttachmentObject’ 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 <result> = <object1>.equals<(object2)>;
GetHashCode () [int] Returns the hash code of an object previously created
by a control as an integer. e.g.
int <result> = <object>.GetHashCode();
GetType () [Type] Returns the type of an object previously created by a
control macro. e.g.
Type <result> = <object>.GetType();
ToString () [string] Returns the string value of an object previously created
by a control macro. e.g.
string <result> = <object>.ToString();
ActivateWithListen [bool] Either returns the listen status of an object created by a
control macro as a boolean True or False or sets the lis-
ten status of an object to a boolean True or False e.g.
AttachmentObject <result> = <object>.ActivateWith-
Listen;
or
<object>.ActivateWithListen = <listen state>;