Event Operator — Mutation Methods

`AddEvent`


def AddEvent(uuId: str, pTpElement: CENPyOlpTpElement, iInsertPosition: int, execute: bool=True) -> CENPyOlpEventObject

Add Technology Event on input toolpath element or at the end of the toolpath segment.

Parameters:

Name	Type	Description
`uuId`	`str`	unique id of the event to be added
`pTpElement`	`CENPyOlpTpElement`	reference toolpath element
`iInsertPosition`	`int`	before or after the reference toolpath element
`execute`	`bool`	True = event will be computed immediately; False = event will be created but not computed, compute must be triggered separately. Default is True. (default: `True`)

Returns: CENPyOlpEventObject — The Event object added

`AddEventWaitForBoolSensor`


def AddEventWaitForBoolSensor(target: CENPyOlpTpElement, sensor: CENPyOlpSensor, iInsertPosition: int) -> CENPyOlpWaitForBoolSensorEvent

Adds a WaitForBoolSensor event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`sensor`	`CENPyOlpSensor`	the sensor to be set
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpWaitForBoolSensorEvent — the added event

`AddEventBoolActor`


def AddEventBoolActor(target: CENPyOlpTpElement, actor: CENPyOlpActor, iInsertPosition: int) -> CENPyOlpBoolActorEvent

Adds a BoolActor event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`actor`	`CENPyOlpActor`	the actor to be set
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpBoolActorEvent — the added event

`AddEventFloatArrayActor`


def AddEventFloatArrayActor(target: CENPyOlpTpElement, actor: CENPyOlpActor, iInsertPosition: int) -> CENPyOlpFloatArrayActorEvent

Adds a FloatArrayActor event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`actor`	`CENPyOlpActor`	the actor to be set
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpFloatArrayActorEvent — the added event

`AddEventSetBoolSignal`


def AddEventSetBoolSignal(value: bool, target: CENPyOlpTpElement, signalNumber: int, iInsertPosition: int) -> CENPyOlpSetBoolSignalEvent

Adds a SetBoolSignal event to target toolpath element.

Parameters:

Name	Type	Description
`value`	`bool`	the bool value to be set
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`signalNumber`	`int`	the signal number
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpSetBoolSignalEvent — the added event

`AddEventSetFloatSignal`


def AddEventSetFloatSignal(value: float, target: CENPyOlpTpElement, signalNumber: int, iInsertPosition: int) -> CENPyOlpSetFloatSignalEvent

Adds a SetFloatSignal event to target toolpath element.

Parameters:

Name	Type	Description
`value`	`float`	the float value to be set
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`signalNumber`	`int`	the signal number
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpSetFloatSignalEvent — the added event

`AddEventSetIntSignal`


def AddEventSetIntSignal(value: int, target: CENPyOlpTpElement, signalNumber: int, iInsertPosition: int) -> CENPyOlpSetIntSignalEvent

Adds a SetIntSignal event to target toolpath element.

Parameters:

Name	Type	Description
`value`	`int`	the integer value to be set
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`signalNumber`	`int`	the signal number
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpSetIntSignalEvent — the added event

`AddEventWaitForBoolSignal`


def AddEventWaitForBoolSignal(value: bool, target: CENPyOlpTpElement, signalNumber: int, iInsertPosition: int) -> CENPyOlpWaitForBoolSignalEvent

Adds a WaitForBoolSignalEvent to target toolpath element.

Parameters:

Name	Type	Description
`value`	`bool`	the bool value to be set
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`signalNumber`	`int`	the signal number
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpWaitForBoolSignalEvent — the added event

`AddEventWaitForFloatSignal`


def AddEventWaitForFloatSignal(value: float, target: CENPyOlpTpElement, signalNumber: int, iInsertPosition: int) -> CENPyOlpWaitForFloatSignalEvent

Adds a WaitForFloatSignalEvent to target toolpath element.

Parameters:

Name	Type	Description
`value`	`float`	the float value to be set
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`signalNumber`	`int`	the signal number
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpWaitForFloatSignalEvent — the added event

`AddEventWaitForIntSignal`


def AddEventWaitForIntSignal(value: int, target: CENPyOlpTpElement, signalNumber: int, iInsertPosition: int) -> CENPyOlpWaitForIntSignalEvent

Adds a WaitForIntSignalEvent to target toolpath element.

Parameters:

Name	Type	Description
`value`	`int`	the integer value to be set
`target`	`CENPyOlpTpElement`	toolpath element where the event to be added
`signalNumber`	`int`	the signal number
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpWaitForIntSignalEvent — the added event

`AddSpeed`


def AddSpeed(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpSpeedEvent

Adds a Speed event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where speed event to be added
`iInsertPosition`	`int`	Insert position - before or after the reference toolpath element

Returns: CENPyOlpSpeedEvent — The added event

`AddToolEvent`


def AddToolEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpToolEvent

Adds a Tool event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where tool event to be added
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpToolEvent — The tool Event added

`AddToolEvent`


def AddToolEvent(target: CENPyOlpTpElement, iInsertPosition: int, exactStop: bool) -> CENPyOlpToolEvent

Adds a Tool event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where tool event to be added
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element
`exactStop`	`bool`	Exact stop on event.

Returns: CENPyOlpToolEvent — The tool Event added

`AddAccuracyEvent`


def AddAccuracyEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpAccuracyEvent

Adds a Accuracy event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where accuracy event to be added.
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpAccuracyEvent — The accuracy Event added

`AddDwellEvent`


def AddDwellEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpDwellEvent

Adds a Dwell event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	The element on which the event is to be added.
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpDwellEvent — The added event; null if adding the event fails

`AddSyncRobotsEvent`


def AddSyncRobotsEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpSyncRobotsEvent

Adds a Synchronize Robots event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where synchronize robots event to be added.
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpSyncRobotsEvent — The Synchronize Robots Event added

`AddAccelerationEvent`


def AddAccelerationEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpAccelerationEvent

Adds a Acceleration event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	toolpath element where Acceleration event to be added.
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpAccelerationEvent — The Acceleration Event added

`AddSetResourcePortEvent`


def AddSetResourcePortEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpSetResourcePortEvent

Adds a SetResourcePort event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	Toolpath element where the event will be added
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpSetResourcePortEvent — The created event

`AddSetResourcePortEvent`


def AddSetResourcePortEvent(target: CENPyOlpTpElement, iInsertPosition: int, exactStop: bool) -> CENPyOlpSetResourcePortEvent

Adds a SetResourcePort event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	Toolpath element where the event will be added
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element
`exactStop`	`bool`	Exact stop on event.

Returns: CENPyOlpSetResourcePortEvent — The created event

`AddWaitForResourcePortEvent`


def AddWaitForResourcePortEvent(target: CENPyOlpTpElement, iInsertPosition: int) -> CENPyOlpWaitForResourcePortEvent

Adds a WaitForResourcePort event to target toolpath element.

Parameters:

Name	Type	Description
`target`	`CENPyOlpTpElement`	Toolpath element where the event will be added
`iInsertPosition`	`int`	Insert position - before or after the target toolpath element

Returns: CENPyOlpWaitForResourcePortEvent — The created event

Was this page helpful?