Balancing Sequencing Operator

Since R2025.2.4

Quick Facts

Quick Start

# Boilerplate Example
balancingSequencingOperator = ...  # obtained from the runtime context
result = balancingSequencingOperator.GetLoggerOperator()

Method Index

Query Methods

GetLoggerOperator

Since R2025.2.4

def GetLoggerOperator() -> CENPyOlpLogOperator

Retrieve the logger operator associated with this sequencing operator.

Returns: CENPyOlpLogOperator — CENPyOlpLogOperator: Instance for logging.

GetAllControllers

Since R2025.2.4

def GetAllControllers() -> list[CENPyOlpController]

Get a list of all available controllers.

Returns: list[CENPyOlpController] — list[CENPyOlpController]: All available controllers.

GetActiveController

Since R2025.2.4

def GetActiveController() -> CENPyOlpController

Get the currently active controller.

Returns: CENPyOlpController — CENPyOlpController: The controller selected as active.

GetComputeHandler

Since R2025.2.4

def GetComputeHandler(activeProgram: CENPyOlpProgram) -> CENPyOlpComputeHandler

Get a compute handler for active program on active controller.

Parameters:

Returns: CENPyOlpComputeHandler — CENPyOlpComputeHandler: Compute handler.

GetTeachHandler

Since R2025.2.4

def GetTeachHandler(activeProgram: CENPyOlpProgram) -> CENPyOlpTeachHandler

Get a teach handler for active program on active controller.

Parameters:

Returns: CENPyOlpTeachHandler — CENPyOlpTeachHandler: Teach handler.

GetEventHandler

Since R2025.2.4

def GetEventHandler(activeProgram: CENPyOlpProgram) -> CENPyOlpEventHandler

Get an event handler for active program on active controller.

Parameters:

Returns: CENPyOlpEventHandler — CENPyOlpEventHandler: Event handler.

CanSequenceOperations

Since R2025.2.4

def CanSequenceOperations(operationsToCheck: list[CENPyOlpOperation], referenceOperation: CENPyOlpOperation, insertLocation: SequenceInsertionType) -> int

Check if a set of operations can be sequenced relative to a reference.

Parameters:

Returns: int — int: Status code (0 = allowed, non-zero = not allowed).

CanSequenceOperationGroups

Since R2025.2.4

def CanSequenceOperationGroups(operationGroupsToCheck: list[CENPyOlpOperationGroup], referenceOperationGroup: CENPyOlpOperationGroup, insertLocation: SequenceInsertionType) -> int

Check if a set of operation groups can be sequenced relative to a reference group.

Parameters:

Returns: int — int: Status code (0 = allowed, non-zero = not allowed).

Mutation Methods

SetActiveController

Since R2025.2.4

def SetActiveController(controller: CENPyOlpController) -> int

Set the active controller.

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

RemoveAutomatedPathOptimizationOnOperations

Since R2025.2.4

def RemoveAutomatedPathOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> int

Removes automated path optimization from the given operations.

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

RemoveAutomatedLinkOptimizationOnOperations

Since R2025.2.4

def RemoveAutomatedLinkOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> int

Removes automated link-path optimization from the given operations.

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

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

Execution & Actions

RunAutomatedPathOptimizationOnOperations

Since R2025.2.4

def RunAutomatedPathOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> int

Performs automated path optimization on the given operations.

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

RunAutomatedLinkPathOptimizationOnOperations

Since R2025.2.4

def RunAutomatedLinkPathOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> int

Performs automated link-path optimization on the given operations.

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

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

Utilities

SequenceOperations

Since R2025.2.4

def SequenceOperations(operationsToMove: list[CENPyOlpOperation], referenceOperation: CENPyOlpOperation, insertLocation: SequenceInsertionType) -> int

Sequence a set of operations relative to a reference operation.

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

SequenceOperationGroups

Since R2025.2.4

def SequenceOperationGroups(operationGroupsToSequence: list[CENPyOlpOperationGroup], referenceOperationGroup: CENPyOlpOperationGroup, insertLocation: SequenceInsertionType) -> int

Sequence a set of operation groups relative to a reference group.

Parameters:

Returns: int — int: Status code (0 = success, non-zero = error).

Related Types

• Log Operator
• Controller
• Compute Handler
• Program
• Teach Handler
• Event Handler
• Operation
• Sequence Insertion Type
• Operation Group

Changes in R2025.2.4

Compared to R2025.1:

• New class added

• [NEW] GetLoggerOperator: New method added

• [NEW] GetAllControllers: New method added

• [NEW] GetActiveController: New method added

• [NEW] SetActiveController: New method added

• [NEW] GetComputeHandler: New method added

• [NEW] GetTeachHandler: New method added

• [NEW] GetEventHandler: New method added

• [NEW] SequenceOperations: New method added

• [NEW] CanSequenceOperations: New method added

• [NEW] SequenceOperationGroups: New method added

• [NEW] CanSequenceOperationGroups: New method added

• [NEW] RunAutomatedPathOptimizationOnOperations: New method added

• [NEW] RunAutomatedLinkPathOptimizationOnOperations: New method added

• [NEW] RemoveAutomatedPathOptimizationOnOperations: New method added

• [NEW] RemoveAutomatedLinkOptimizationOnOperations: New method added

Version Notes

This class is documented as of release R2025.2.4. This class was added in R2025.2.4.