WM_Rule Init Operator
Quick Facts
| Property | Value |
|---|---|
| Class | CENPyOlpWM_RuleInitOperator |
| Module | cenpylib.CENPyOlpWM_RuleInitOperator |
| Package | cenpylib |
| Release | R2025.2.4 |
| Methods | 7 |
Quick Start
# Boilerplate Example
wM_RuleInitOperator = ... # obtained from the runtime context
result = wM_RuleInitOperator.GetController()Method Index
| Method | Returns | Summary |
|---|---|---|
AddPyEvent | CENPyOlpEventObject | Add an event to the event rule. |
AddPyEventByUUID | CENPyOlpEventObject | Add an event to the event rule. |
RemoveEventFromRule | — | Remove an event from the event rule. |
SetActivePyEvent | — | Set the given event as active in the specified rule. |
OverrideEventRuleInsertPosition | — | Set the new insert position for the event rules with given name. |
GetController | CENPyOlpController | Get the parent controller interface. |
GetLoggerOperator | CENPyOlpLogOperator | Get the log operator interface. |
Query Methods
GetController
def GetController() -> CENPyOlpControllerGet the parent controller interface.
Returns: CENPyOlpController — Controller interface.
GetLoggerOperator
def GetLoggerOperator() -> CENPyOlpLogOperatorGet the log operator interface.
Returns: CENPyOlpLogOperator — Log operator interface.
Mutation Methods
AddPyEvent
def AddPyEvent(ruleName: str, pyEventName: str) -> CENPyOlpEventObjectAdd an event to the event rule.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleName | str | Kernel or Python-defined rule name. |
pyEventName | str | Kernel or Python-defined event name. |
Returns: CENPyOlpEventObject — Added event object.
AddPyEventByUUID
def AddPyEventByUUID(ruleName: str, eventUUID: str) -> CENPyOlpEventObjectAdd an event to the event rule.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleName | str | Kernel or Python-defined rule name. |
eventUUID | str | Kernel or Python-defined event uuid. |
Returns: CENPyOlpEventObject — Added event object.
RemoveEventFromRule
def RemoveEventFromRule(ruleName: str, eventName: str)Remove an event from the event rule.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleName | str | Kernel or Python-defined rule name. |
eventName | str | Kernel or Python-defined event name. |
SetActivePyEvent
def SetActivePyEvent(ruleName: str, eventBaseName: str)Set the given event as active in the specified rule.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleName | str | Kernel or Python-defined rule name. |
eventBaseName | str | Kernel or Python-defined event name. |
Utilities
OverrideEventRuleInsertPosition
def OverrideEventRuleInsertPosition(ruleName: str, insertPosition: int)Set the new insert position for the event rules with given name.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleName | str | Kernel or Python-defined rule name to search for. |
insertPosition | int | New insert position. |
Related Types
Version Notes
This class is documented as of release R2025.2.4.
Was this page helpful?