BalanceAndSequenceOperator

The scope of this operator is to allow access to modify active programs from controllers and move the operations, operation groups between controllers.

[Example]

def ExecuteBalancingSequencingScript(Operator: CENPyOlpBalancingSequencingOperator):

pass

Methods

ℜ•	GetLoggerOperator(): CENPyOlpLogOperator

return

Log operator interface

[Example]

logger = Operator.GetLoggerOperator()

ℜ•	GetAllControllers(): list<CENPyOlpController>

return

Controllers available in project as a list CENPyOlpController objects

[Example]

allProjectController = Operator.GetAllControllers()

ℜ•	GetActiveController(): CENPyOlpController

return

Returns the active controller

[Example]

activeController = Operator.GetActiveController()

ℜ•	*SetActiveController(const CENPyOlpController controller)**

o	controller

The controller that should be set as active

[Example]

Operator.SetActiveController(otherController)

ℜ•	*SequenceOperations(const std::vector<CENPyOlpOperation>& operationsToMove, const CENPyOlpOperation* referenceOperation, SequenceInsertionType insertLocation):** int

o	operationsToMove

Operations to sequence

oreferenceOperation

Referenced operation, after or before the operationsToMove will be sequenced

oinsertLocation

The insert-type: SequenceInsertionType::InsertAfterRef or SequenceInsertionType::InsertBeforeRef

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

This method reorders operations by sequencing the given operations after or before a referenced operation.

For example :

operations of the operation-group : [O1, O2, O3, O4, O5]

Switch O4 and O1 after O2.

Input :

operationsToSequence = [O4, O1],

refOperation = O2,

insertType = SequenceInsertionType::InsertAfterRef

Result -> (operations after sequencing) : [O2, O4, O1, O3, O5]

ℜ•	*CanSequenceOperations(const std::vector<CENPyOlpOperation>& operationsToCheck, const CENPyOlpOperation* referenceOperation, SequenceInsertionType insertLocation):** int

o	operationsToCheck

The operations to be checked

oreferenceOperation

Referenced operation, after or before the operationsToMove will be sequenced

oinsertLocation

The insert-type: SequenceInsertionType::InsertAfterRef or SequenceInsertionType::InsertBeforeRef

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

Checks if operations could be sequenced with SequenceOperations() method.

ℜ•	*SequenceOperationGroups(const std::vector<CENPyOlpOperationGroup>& operationGroupsToSequence, const CENPyOlpOperationGroup* referenceOperationGroup, SequenceInsertionType insertLocation): int**

o	operationGroupsToSequence

The operation groups to sequence

oreferenceOperationGroup

Referenced operation group, after or before the operationGroupsToSequence will be sequenced

oinsertLocation

The insert-type: SequenceInsertionType::InsertAfterRef or SequenceInsertionType::InsertBeforeRef

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

This method reorders operation groups by sequencing the given groups to a new position

For example :

operation groups of the program: [C0, C1, C2, C3, C4, C5]

Switch C4 and C1 after C2.

Input :

operationGroupsToSequence = [CO4, CO1],

refOperationGroup = CO2,

insertType = SequenceInsertionType::InsertAfterRef

Resulting operation groups after sequencing: [C0 C2, C4, C1, C3, C5]

ℜ•	*CanSequenceOperationGroups(const std::vector<CENPyOlpOperationGroup>& operationGroupsToCheck, const CENPyOlpOperationGroup* refOperationGroup, SequenceInsertionType insertLocation):** int

o	operationGroupsToCheck

The operation groups to check

oreferenceOperationGroup

Referenced operation group, after or before the operationGroupsToSequence will be sequenced

oinsertLocation

The insert-type: SequenceInsertionType::InsertAfterRef or SequenceInsertionType::InsertBeforeRef

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

Checks if operation groups could be sequenced using SequenceOperationGroups() method

ℜ•	*GetComputeHandler(const CENPyOlpProgram activeProgram):** CENPyOlpComputeHandler

o	activeProgram

The active program on the active controller

oreturns

CENPyOlpComputeHandler

[Example]

computeHandler = Operator.GetComputeHandler(activeProgram)

ℜ•	*GetInterpolationHandler(const CENPyOlpProgram activeProgram):** CENPyOlpInterpolationHandler

o	activeProgram

The active program on the active controller

oreturns

CENPyOlpInterpolationHandler

[Example]

interpolationHandler = Operator.GetInterpolationHandler(activeProgram)

ℜ•	*GetTeachHandler(const CENPyOlpProgram activeProgram):** CENPyOlpTeachHandler

o	activeProgram

The active program on the active controller

oreturns

CENPyOlpTeachHandler

[Example]

teachHandler = Operator.GetTeachHandler(activeProgram)

ℜ•	*GetEventHandler(const CENPyOlpProgram activeProgram):** CENPyOlpEventHandler

o	activeProgram

The active program on the active controller

oreturns

CENPyOlpEventHandler

[Example]

eventHandler = Operator.GetEventHandler(activeProgram)

ℜ•	*RunAutomatedPathOptimizationOnOperations(const std::vector<CENPyOlpOperation>& listOfOperations):** int

o	listOfOperations

The operations to optimize

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

Performs automated path optimization on the given operations

ℜ•	*RemoveAutomatedPathOptimizationOnOperations(const std::vector<CENPyOlpOperation>& listOfOperations):** int

o	listOfOperations

The operations to remove path optimization from

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

Removes automated path optimization from the given operations

ℜ•	*RunAutomatedLinkPathOptimizationOnOperations(const std::vector<CENPyOlpOperation>& listOfOperations):** int

o	listOfOperations

The list of operations whose link paths should be optimized

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

Performs automated link-path optimization on the given operations.

A link path is the path up to approach of an given operation, starting from the retract of the previous operation.

ℜ•	*RemoveAutomatedLinkOptimizationOnOperations(const std::vector<CENPyOlpOperation>& listOfOperations):** int

o	listOfOperations

The operations to remove link-path optimization from.

oreturns

ERR_NO_ERROR (0) on success, an error code otherwise

Removes automated link-path optimization from the given operations.

A link path is the path up to approach of an given operation, starting from the retract of the previous operation.

Chapter page