Balancing Sequencing Operator
Since R2025.2.4
Quick Facts
| Property | Value |
|---|---|
| Class | CENPyOlpBalancingSequencingOperator |
| Module | cenpylib.CENPyOlpBalancingSequencingOperator |
| Package | cenpylib |
| Release | R2026.1 |
| Methods | 22 |
Quick Start
# Boilerplate Example
balancingSequencingOperator = ... # obtained from the runtime context
result = balancingSequencingOperator.GetLoggerOperator()Method Index
| Method | Returns | Summary |
|---|---|---|
GetLoggerOperator | CENPyOlpLogOperator | Retrieve the logger operator associated with this sequencing operator. |
GetAllControllers | list[CENPyOlpController] | Get a list of all available controllers. |
GetActiveController | CENPyOlpController | Get the currently active controller. |
SetActiveController | int | Set the active controller. |
MoveOperationsToController | int | Moves operations to the active program of the specified controller. |
MoveOperationsToProgram | int | Moves operations to the specified program. |
CopyOperationsToController | int | Copies operations to the active program of the specified controller. |
CopyOperationsToProgram | int | Copies operations to the specified program. |
GetComputeHandler | CENPyOlpComputeHandler | Get a compute handler for active program on active controller. |
GetTeachHandler | CENPyOlpTeachHandler | Get a teach handler for active program on active controller. |
GetEventHandler | CENPyOlpEventHandler | Get an event handler for active program on active controller. |
SequenceOperations | int | Sequence a set of operations relative to a reference operation. |
CanSequenceOperations | int | Check if a set of operations can be sequenced relative to a reference. |
SequenceOperationGroups | int | Sequence a set of operation groups relative to a reference group. |
CanSequenceOperationGroups | int | Check if a set of operation groups can be sequenced relative to a reference group. |
MoveOperationGroupsToController | int | Moves operation groups to the active program of the specified controller. |
MoveOperationGroupsToProgram | int | Moves operation groups to the specified program. |
RunAutomatedPathOptimizationOnOperations | int | Performs automated path optimization on the given operations. |
RunAutomatedLinkPathOptimizationOnOperations | int | Performs automated link-path optimization on the given operations. |
RemoveAutomatedPathOptimizationOnOperations | int | Removes automated path optimization from the given operations. |
RemoveAutomatedLinkOptimizationOnOperations | int | Removes automated link-path optimization from the given operations. |
GetAllProcessGeometries | list[CENPyOlpProcessGeometryOperator] | Returns all process geometries. |
Query Methods
GetLoggerOperator
Since R2025.2.4
def GetLoggerOperator() -> CENPyOlpLogOperatorRetrieve 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() -> CENPyOlpControllerGet the currently active controller.
Returns: CENPyOlpController — CENPyOlpController: The controller selected as active.
GetComputeHandler
Since R2025.2.4
def GetComputeHandler(activeProgram: CENPyOlpProgram) -> CENPyOlpComputeHandlerGet a compute handler for active program on active controller.
Parameters:
| Name | Type | Description |
|---|---|---|
activeProgram | CENPyOlpProgram | — |
Returns: CENPyOlpComputeHandler — CENPyOlpComputeHandler: Compute handler.
GetTeachHandler
Since R2025.2.4
def GetTeachHandler(activeProgram: CENPyOlpProgram) -> CENPyOlpTeachHandlerGet a teach handler for active program on active controller.
Parameters:
| Name | Type | Description |
|---|---|---|
activeProgram | CENPyOlpProgram | — |
Returns: CENPyOlpTeachHandler — CENPyOlpTeachHandler: Teach handler.
GetEventHandler
Since R2025.2.4
def GetEventHandler() -> CENPyOlpEventHandlerGet the event handler.
Returns: CENPyOlpEventHandler — CENPyOlpEventHandler: Event handler.
CanSequenceOperations
Since R2025.2.4
def CanSequenceOperations(operationsToCheck: list[CENPyOlpOperation], referenceOperation: CENPyOlpOperation, insertLocation: SequenceInsertionType) -> intCheck if a set of operations can be sequenced relative to a reference.
Parameters:
| Name | Type | Description |
|---|---|---|
operationsToCheck | list[CENPyOlpOperation] | — |
referenceOperation | CENPyOlpOperation | — |
insertLocation | SequenceInsertionType | — |
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) -> intCheck if a set of operation groups can be sequenced relative to a reference group.
Parameters:
| Name | Type | Description |
|---|---|---|
operationGroupsToCheck | list[CENPyOlpOperationGroup] | — |
referenceOperationGroup | CENPyOlpOperationGroup | — |
insertLocation | SequenceInsertionType | — |
Returns: int — int: Status code (0 = allowed, non-zero = not allowed).
Mutation Methods
SetActiveController
Since R2025.2.4
def SetActiveController(controller: CENPyOlpController) -> intSet the active controller.
Parameters:
| Name | Type | Description |
|---|---|---|
controller | CENPyOlpController | — |
Returns: int — int: Status code (0 = success, non-zero = error).
MoveOperationsToController
Since R2026.1
def MoveOperationsToController(operationsToMove: list[CENPyOlpOperation], refController: CENPyOlpController, splitWithCopy: bool=False) -> intMoves the given operations to the active program of the specified controller.
Parameters:
| Name | Type | Description |
|---|---|---|
operationsToMove | list[CENPyOlpOperation] | Operations to move. |
refController | CENPyOlpController | Target controller. |
splitWithCopy | bool | If true, operations are copied instead of moved. |
Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.
MoveOperationsToProgram
Since R2026.1
def MoveOperationsToProgram(operationsToMove: list[CENPyOlpOperation], refProgram: CENPyOlpProgram, splitWithCopy: bool=False) -> intMoves the given operations to the specified program.
Parameters:
| Name | Type | Description |
|---|---|---|
operationsToMove | list[CENPyOlpOperation] | Operations to move. |
refProgram | CENPyOlpProgram | Target program. |
splitWithCopy | bool | If true, operations are copied instead of moved. |
Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.
CopyOperationsToController
Since R2026.1.1
def CopyOperationsToController(operationsToCopy: list[CENPyOlpOperation], refController: CENPyOlpController) -> intCopies the given operations to the active program of the specified controller.
Parameters:
| Name | Type | Description |
|---|---|---|
operationsToCopy | list[CENPyOlpOperation] | Operations to copy. |
refController | CENPyOlpController | Target controller. |
Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.
CopyOperationsToProgram
Since R2026.1.1
def CopyOperationsToProgram(operationsToCopy: list[CENPyOlpOperation], refProgram: CENPyOlpProgram) -> intCopies the given operations to the specified program.
Parameters:
| Name | Type | Description |
|---|---|---|
operationsToCopy | list[CENPyOlpOperation] | Operations to copy. |
refProgram | CENPyOlpProgram | Target program. |
Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.
RemoveAutomatedPathOptimizationOnOperations
Since R2025.2.4
def RemoveAutomatedPathOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> intRemoves automated path optimization from the given operations.
Parameters:
| Name | Type | Description |
|---|---|---|
listOfOperations | list[CENPyOlpOperation] | — |
Returns: int — int: Status code (0 = success, non-zero = error).
RemoveAutomatedLinkOptimizationOnOperations
Since R2025.2.4
def RemoveAutomatedLinkOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> intRemoves 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:
| Name | Type | Description |
|---|---|---|
listOfOperations | list[CENPyOlpOperation] | — |
Returns: int — int: Status code (0 = success, non-zero = error).
Execution & Actions
RunAutomatedPathOptimizationOnOperations
Since R2025.2.4
def RunAutomatedPathOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> intPerforms automated path optimization on the given operations.
Parameters:
| Name | Type | Description |
|---|---|---|
listOfOperations | list[CENPyOlpOperation] | — |
Returns: int — int: Status code (0 = success, non-zero = error).
RunAutomatedLinkPathOptimizationOnOperations
Since R2025.2.4
def RunAutomatedLinkPathOptimizationOnOperations(listOfOperations: list[CENPyOlpOperation]) -> intPerforms 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:
| Name | Type | Description |
|---|---|---|
listOfOperations | list[CENPyOlpOperation] | — |
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) -> intSequence a set of operations relative to a reference operation.
Parameters:
| Name | Type | Description |
|---|---|---|
operationsToMove | list[CENPyOlpOperation] | — |
referenceOperation | CENPyOlpOperation | — |
insertLocation | SequenceInsertionType | — |
Returns: int — int: Status code (0 = success, non-zero = error).
SequenceOperationGroups
Since R2025.2.4
def SequenceOperationGroups(operationGroupsToSequence: list[CENPyOlpOperationGroup], referenceOperationGroup: CENPyOlpOperationGroup, insertLocation: SequenceInsertionType) -> intSequence a set of operation groups relative to a reference group.
Parameters:
| Name | Type | Description |
|---|---|---|
operationGroupsToSequence | list[CENPyOlpOperationGroup] | — |
referenceOperationGroup | CENPyOlpOperationGroup | — |
insertLocation | SequenceInsertionType | — |
Returns: int — int: Status code (0 = success, non-zero = error).
MoveOperationGroupsToController
Since R2026.1
def MoveOperationGroupsToController(operationGroupsToMove: list[CENPyOlpOperationGroup], refController: CENPyOlpController) -> intMoves operation groups to the active program of the specified controller.
Parameters:
| Name | Type | Description |
|---|---|---|
operationGroupsToMove | list[CENPyOlpOperationGroup] | Operation groups to move. |
refController | CENPyOlpController | Target controller. |
Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.
MoveOperationGroupsToProgram
Since R2026.1
def MoveOperationGroupsToProgram(operationGroupsToMove: list[CENPyOlpOperationGroup], refProgram: CENPyOlpProgram) -> intMoves operation groups to the specified program.
Parameters:
| Name | Type | Description |
|---|---|---|
operationGroupsToMove | list[CENPyOlpOperationGroup] | Operation groups to move. |
refProgram | CENPyOlpProgram | Target program. |
Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.
GetAllProcessGeometries
Since R2026.1
def GetAllProcessGeometries() -> list[CENPyOlpProcessGeometryOperator]Returns all process geometries.
Returns: list[CENPyOlpProcessGeometryOperator] — Process geometries in the current context.
Related Types
- Log Operator
- Controller
- Compute Handler
- Program
- Teach Handler
- Event Handler
- Operation
- Sequence Insertion Type
- Operation Group
Changes in R2026.1.1
Compared to R2026.1:
-
Method count increased from 20 to 22
-
[NEW]
CopyOperationsToController: New method added -
[NEW]
CopyOperationsToProgram: New method added -
[CHANGED]
MoveOperationsToController: AddedsplitWithCopyparameter -
[CHANGED]
MoveOperationsToProgram: AddedsplitWithCopyparameter
Version Notes
This class is documented as of release R2026.1.1. This class was added in R2025.2.4.