Skip to Content
Python API ReferenceAPI DomainsOperatorsBalancing Sequencing Operator

Balancing Sequencing Operator

Since R2025.2.4

Quick Facts

PropertyValue
ClassCENPyOlpBalancingSequencingOperator
Modulecenpylib.CENPyOlpBalancingSequencingOperator
Packagecenpylib
ReleaseR2026.1
Methods22

Quick Start

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

Method Index

MethodReturnsSummary
GetLoggerOperatorCENPyOlpLogOperatorRetrieve the logger operator associated with this sequencing operator.
GetAllControllerslist[CENPyOlpController]Get a list of all available controllers.
GetActiveControllerCENPyOlpControllerGet the currently active controller.
SetActiveControllerintSet the active controller.
MoveOperationsToControllerintMoves operations to the active program of the specified controller.
MoveOperationsToProgramintMoves operations to the specified program.
CopyOperationsToControllerintCopies operations to the active program of the specified controller.
CopyOperationsToProgramintCopies operations to the specified program.
GetComputeHandlerCENPyOlpComputeHandlerGet a compute handler for active program on active controller.
GetTeachHandlerCENPyOlpTeachHandlerGet a teach handler for active program on active controller.
GetEventHandlerCENPyOlpEventHandlerGet an event handler for active program on active controller.
SequenceOperationsintSequence a set of operations relative to a reference operation.
CanSequenceOperationsintCheck if a set of operations can be sequenced relative to a reference.
SequenceOperationGroupsintSequence a set of operation groups relative to a reference group.
CanSequenceOperationGroupsintCheck if a set of operation groups can be sequenced relative to a reference group.
MoveOperationGroupsToControllerintMoves operation groups to the active program of the specified controller.
MoveOperationGroupsToProgramintMoves operation groups to the specified program.
RunAutomatedPathOptimizationOnOperationsintPerforms automated path optimization on the given operations.
RunAutomatedLinkPathOptimizationOnOperationsintPerforms automated link-path optimization on the given operations.
RemoveAutomatedPathOptimizationOnOperationsintRemoves automated path optimization from the given operations.
RemoveAutomatedLinkOptimizationOnOperationsintRemoves automated link-path optimization from the given operations.
GetAllProcessGeometrieslist[CENPyOlpProcessGeometryOperator]Returns all process geometries.

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:

NameTypeDescription
activeProgramCENPyOlpProgram

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:

NameTypeDescription
activeProgramCENPyOlpProgram

Returns: CENPyOlpTeachHandler — CENPyOlpTeachHandler: Teach handler.

GetEventHandler

Since R2025.2.4

def GetEventHandler() -> CENPyOlpEventHandler

Get the event handler.

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:

NameTypeDescription
operationsToChecklist[CENPyOlpOperation]
referenceOperationCENPyOlpOperation
insertLocationSequenceInsertionType

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:

NameTypeDescription
operationGroupsToChecklist[CENPyOlpOperationGroup]
referenceOperationGroupCENPyOlpOperationGroup
insertLocationSequenceInsertionType

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:

NameTypeDescription
controllerCENPyOlpController

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

MoveOperationsToController

Since R2026.1

def MoveOperationsToController(operationsToMove: list[CENPyOlpOperation], refController: CENPyOlpController, splitWithCopy: bool=False) -> int

Moves the given operations to the active program of the specified controller.

Parameters:

NameTypeDescription
operationsToMovelist[CENPyOlpOperation]Operations to move.
refControllerCENPyOlpControllerTarget controller.
splitWithCopyboolIf 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) -> int

Moves the given operations to the specified program.

Parameters:

NameTypeDescription
operationsToMovelist[CENPyOlpOperation]Operations to move.
refProgramCENPyOlpProgramTarget program.
splitWithCopyboolIf 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) -> int

Copies the given operations to the active program of the specified controller.

Parameters:

NameTypeDescription
operationsToCopylist[CENPyOlpOperation]Operations to copy.
refControllerCENPyOlpControllerTarget 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) -> int

Copies the given operations to the specified program.

Parameters:

NameTypeDescription
operationsToCopylist[CENPyOlpOperation]Operations to copy.
refProgramCENPyOlpProgramTarget program.

Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.

RemoveAutomatedPathOptimizationOnOperations

Since R2025.2.4

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

Removes automated path optimization from the given operations.

Parameters:

NameTypeDescription
listOfOperationslist[CENPyOlpOperation]

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:

NameTypeDescription
listOfOperationslist[CENPyOlpOperation]

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:

NameTypeDescription
listOfOperationslist[CENPyOlpOperation]

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:

NameTypeDescription
listOfOperationslist[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) -> int

Sequence a set of operations relative to a reference operation.

Parameters:

NameTypeDescription
operationsToMovelist[CENPyOlpOperation]
referenceOperationCENPyOlpOperation
insertLocationSequenceInsertionType

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:

NameTypeDescription
operationGroupsToSequencelist[CENPyOlpOperationGroup]
referenceOperationGroupCENPyOlpOperationGroup
insertLocationSequenceInsertionType

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

MoveOperationGroupsToController

Since R2026.1

def MoveOperationGroupsToController(operationGroupsToMove: list[CENPyOlpOperationGroup], refController: CENPyOlpController) -> int

Moves operation groups to the active program of the specified controller.

Parameters:

NameTypeDescription
operationGroupsToMovelist[CENPyOlpOperationGroup]Operation groups to move.
refControllerCENPyOlpControllerTarget controller.

Returns: int — ERR_NO_ERROR (0) on success, an error code otherwise.

MoveOperationGroupsToProgram

Since R2026.1

def MoveOperationGroupsToProgram(operationGroupsToMove: list[CENPyOlpOperationGroup], refProgram: CENPyOlpProgram) -> int

Moves operation groups to the specified program.

Parameters:

NameTypeDescription
operationGroupsToMovelist[CENPyOlpOperationGroup]Operation groups to move.
refProgramCENPyOlpProgramTarget 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.

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: Added splitWithCopy parameter

  • [CHANGED] MoveOperationsToProgram: Added splitWithCopy parameter

Version Notes

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

Was this page helpful?