Sepasoft MES Module Suite
Tigger Operation Begin Property
Operations Definitions can be linked together to form routes. The Trigger Operation Begin Property object is used to create and hold information about what and how triggers Operations Definition objects to begin. These triggers can be seen as the arrow between Operations in the MES Object Editor when Routes are selected.
|
This object is not derived from the MESAbstractObject. Instead it derives from AbstractMESComplexProperty object and inherits all its functions and properties. |
Object Creation
This object can be created by using the MES Object Editor component.
Object Properties
These properties are accessible through the MES Object Editor component and with the provided object functions, but not directly as obj.properties. Property values can be accessed and changed for an object by using the getPropertyValue() and setPropertyValue() method.
| Name | Scripting | Description | ||
|---|---|---|---|---|
| Name | TriggerOperBegin | Name of the Trigger Operation Begin property. The name of the custom property that can be used to reference this Trigger Operation Begin event in script. | ||
| Mode | TriggerOperationBeginMode | Mode of the property. Options are:
| ||
| Auto | TriggerOperationBeginAuto | If this is set to True, the trigger will execute automatically. | ||
| Preceding Operation Reference | TriggerOperationBeginPrecedingRef | Reference to the previous operation. |
Object Functions
This object provides the following functions:
|
References can be set in one of two ways:
|
getMode()
Description
Returns the mode of the complex property.
Syntax
getMode()
- Parameters
None
- Returns
String mode - The mode of this property.
- Scope
All
getPrecedingRef()
Description
Gets the preceding reference to this complex property.
Syntax
getPrecedingRef()
- Parameters
None
- Returns
MESObjectLink - The MES object link to the preceding reference to this complex property.
- Scope
All
getPrecedingRefProperty()
Description
Gets the preceding reference property.
Syntax
getPrecedingRefProperty()
- Parameters
None
- Returns
MESTriggerOperationBeginPrecedingRefProperty - The preceding reference property.
- Scope
All
getPrecedingRefType()
Description
Gets the preceding reference type.
Syntax
getPrecedingRefType()
- Parameters
None
- Returns
String precedingRefType - Type of the preceding reference to this complex property.
- Scope
All
getPrecedingRefUUID()
Description
Gets the preceding reference uuid.
Syntax
getPrecedingRefUUID()
- Parameters
None
- Returns
String precedingRefUUID - The uuid corresponding to the preceding reference.
- Scope
All
isAuto()
Description
Checks whether the auto execute property is set to True.
Syntax
isAuto()
- Parameters
None
- Returns
boolean - True if the begin trigger auto execute property is true and False otherwise.
- Scope
All
isDefault()
Description
Checks whether the default trigger property is set to True.
Syntax
isDefault()
- Parameters
None
- Returns
boolean - True if the default trigger property is true and False otherwise.
- Scope
All
isModePrimary()
Description
Checks whether the mode of the property is primary.
Syntax
isModePrimary()
- Parameters
None
- Returns
boolean - True if the property mode is primary and False otherwise.
- Scope
All
requiresReference()
Description
Checks whether the property is in reference mode.
Syntax
requiresReference()
- Parameters
None
- Returns
boolean - True if the property is in reference mode and False otherwise.
- Scope
All
setAuto(auto)
Description
Sets the auto execute property to a boolean.
Syntax
setAuto(auto)
- Parameters
boolean - True to set the begin trigger execute automatically and False otherwise.
- Returns
Nothing
- Scope
All
setDefault(value)
Description
Sets a default value to the complex property.
Syntax
setDefault(value)
- Parameters
Boolean value - True to set the default value to True and False otherwise.
- Returns
Nothing
- Scope
All
setMode(mode)
Description
Sets the mode of the complex property.
Syntax
setMode(mode)
- Parameters
String mode - The mode to set for this property.
- Returns
Nothing
- Scope
All
setPrecedingRef(mesObjectLink)
Description
Sets the preceding reference of this complex property.
Syntax
setPrecedingRef(mesObjectLink)
- Parameters
MESObjectlink precedingRef - The MES object link to the preceding reference to set for.
- Returns
Nothing
- Scope
All
setPrecedingRefType(precedingRefType)
Description
Sets the preceding reference type.
Syntax
setPrecedingRefType(precedingRefType)
- Parameters
String precedingRefType - The type to set for the preceding reference.
- Returns
Nothing
- Scope
All
setPrecedingRefUUID(precedingRefUUID)
Description
Sets the preceding reference uuid.
Syntax
setPrecedingRefUUID(precedingRefUUID)
- Parameters
String precedingRefUUID - The uuid to set for the preceding reference.
- Returns
Nothing
- Scope
All
Sepasoft MES Module Suite