Response Trigger Segment Begin Property

Sepasoft MES Module Suite

Response Trigger Segment Begin Property

This object is created whenever an operations segment is started and a corresponding operations response object is created. It is related to the Trigger Segment Begin Property and stores information about the actual operation that triggered it.

Success This object is not derived from the MESAbstractObject. Instead it derives from AbstractMESComplexProperty object and inherits all its functions and properties.

Object Creation

The following methods return a Response Trigger Segment Begin Property object...

  • Response Segment.getPrimaryBeginTrigger()
Copy Code
Python
obj = system.mes.loadMESObject('Maintenance','OperationsSegment')
print obj.getPrimaryBeginTrigger()

 Output

Copy Code
Python
{Mode=At Operation Begin, Auto=false,
PrecedingRef=Operations Definition, Maintenance,
PrecedingRefType=OperationsDefinition,
PrecedingRefUUID=64decd8a-75aa-4c55-b390-0d4811bbf62f,
InitialDelay=0, RepeatMode=No Repeat,
RepeatInterval=0, CustomTriggerEvent=null, Default=true}
>>>

Object Functions

This object provides the following functions:

 

getCustomRef()

Description

 Get reference to the custom property.

Syntax

getCustomRef()

Parameters

 None

Returns

 MESObjectLink customRef - Reference to the custom property.

Scope

All

 

getInitialDelay()

Description

 Get the initial delay.

Syntax

getInitialDelay()

Parameters

 None

Returns

 Integer delay - The initial delay of the trigger segment begin property.

Scope

All

 

getMode()

Description

 Get the mode of trigger segment begin property.

Syntax

getMode()

Parameters

 None

Returns

 String mode - The mode of trigger segment begin property.

Scope

All

 getPrecedingRef()

Description

 Get the MES object link that reference the preceding object.

Syntax

getPrecedingRef()

Parameters

 None

Returns

 MESObjectLink precedingRef - The MES object link that reference the preceding object.

Scope

All

 getPrecedingRefProperty()

Description

 Get the preceding reference property.

Syntax

getPrecedingRefProperty()

Parameters

 None

Returns

 MESTriggerOperationBeginPrecedingRefProperty precedingRefProperty - The preceding reference property.

Scope

All

 

getPrecedingRefType()

Description

 Get the type of preceding reference object.

Syntax

getPrecedingRefType()

Parameters

 None

Returns

 String precedingRefType - The type of preceding reference object.

Scope

All

 

getPrecedingRefUUID()

Description

 Get the uuid of preceding reference object.

Syntax

getPrecedingRefUUID()

Parameters

 None

Returns

 String precedingRefUUID - The UUID of preceding reference object.

Scope

All

 

getRepeatInterval()

Description

Get the repeat interval.

Syntax

getRepeatInterval()

Parameters

 None

Returns

 Integer interval - The repeat interval.

Scope

All

 

getRepeatMode()

Description

Get the repeat mode.

Syntax

getRepeatMode()

Parameters

 None

Returns

 Integer mode - The repeat mode.

Scope

All

 

isAuto()

Description

 Check whether the response segment trigger begin property is set to auto or not.

Syntax

isAuto()

Parameters

 None

Returns

 boolean True if the property is set to auto and False otherwise.

Scope

All

 

isModePrimary()

Description

 Check whether the mode of response segment trigger begin property is set to primary or not.

Syntax

isModePrimary()

Parameters

 None

Returns

 boolean True if the mode is set to primary and False otherwise.

Scope

All

 setAuto()

Description

 Sets the Boolean to auto property.

Syntax

setAuto()

Parameters

 Boolean True to set to auto and False otherwise.

Returns

 Nothing

Scope

All

 

setCustomRef(customRef)

Description

 Set reference to the custom property.

Syntax

setCustomRef(customRef)

Parameters

 String customRef - Reference to the custom property.

Returns

Nothing

Scope

All

 

setInitialDelay(delay)

Description

 Set the initial delay.

Syntax

setInitialDelay(delay)

Parameters

 Integer delay - The initial delay of the trigger segment begin property.

Returns

 Nothing

Scope

All

 

setMode(mode)

Description

 Set the mode of trigger segment begin property.

Syntax

setMode(mode)

Parameters

 String mode - The mode of trigger segment begin property.

Returns

 Nothing

Scope

All

 setPrecedingRef(precedingRef)

Description

Set the MES object link that reference the preceding object.

Syntax

setPrecedingRef(precedingRef)

Parameters

 MESObjectLink precedingRef - MES object link that reference the preceding object.

Returns

 Nothing

Scope

All

 

setPrecedingRefType(precedingRefType)

Description

 Set the type of preceding reference object.

Syntax

setPrecedingRefType(precedingRefType)

Parameters

String precedingRefType - The type of preceding reference object.

Returns

 Nothing

Scope

All

 

setPrecedingRefUUID(precedingRefUUID)

Description

 Set the uuid of preceding reference object.

Syntax

setPrecedingRefUUID(precedingRefUUID)

Parameters

 String precedingRefUUID - The uuid of preceding reference object.

Returns

 Nothing

Scope

All

 

setRepeatInterval(interval)

Description

Set the repeat interval.

Syntax

setRepeatInterval(interval)

Parameters

 Integer interval - The repeat interval.

Returns

 Nothing

Scope

All

 

setRepeatMode(mode)

Description

Set the repeat mode.

Syntax

setRepeatMode(mode)

Parameters

 Integer mode - The repeat mode.

Returns

 Nothing

Scope

All


Sepasoft MES Module Suite