Event Object

Quick Facts

Property	Value
Class	`CENPyOlpEventObject`
Module	`cenpylib.CENPyOlpEventObject`
Package	`cenpylib`
Release	R2025.2.4
Methods	12

Quick Start


# Boilerplate Example
# Acquire the event object from the runtime context
eventObject = ...  # provided by the framework

Method Index

Method	Returns	Summary
`SetEnumIndex`	`—`	Sets the index of the active enum literal of the attribute with the given name
`GetEnumIndex`	`int`	Gets the index of the active enum literal of the attribute with the given name
`SetInteger`	`—`	Sets a new value to the given attribute
`GetInteger`	`int`	Gets the integer attribute value for the given attribute name
`SetDouble`	`—`	Sets a new value to the given attribute
`GetDouble`	`float`	Gets a the value for the given attribute
`SetString`	`—`	Sets a new value to the given attribute
`GetString`	`str`	Gets a the value for the given attribute
`SetBool`	`—`	Sets a new value to the given attribute
`GetBool`	`bool`	Gets a the value for the given attribute
`GetOlpEventInsertPosition`	`int`	Get the event’s insert Position before/after.
`GetOlpEventName`	`str`	Get the event’s Name.

Query Methods

`GetEnumIndex`


def GetEnumIndex(name: str) -> int

Gets the index of the active enum literal of the attribute with the given name

Parameters:

Name	Type	Description
`name`	`str`	name of the enum attribute

Returns: int — literal index

`GetInteger`


def GetInteger(name: str) -> int

Gets the integer attribute value for the given attribute name

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute

Returns: int — Attribute value.

`GetDouble`


def GetDouble(name: str) -> float

Gets a the value for the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute

Returns: float — Attribute value.

`GetString`


def GetString(name: str) -> str

Gets a the value for the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute

Returns: str — Attribute value.

`GetBool`


def GetBool(name: str) -> bool

Gets a the value for the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute

Returns: bool — Attribute value.

`GetOlpEventInsertPosition`


def GetOlpEventInsertPosition() -> int

Get the event’s insert Position before/after.

Returns: int — insert Position before/after

`GetOlpEventName`


def GetOlpEventName() -> str

Get the event’s Name.

Returns: str — the Name of the OlpEvent

Mutation Methods

`SetEnumIndex`


def SetEnumIndex(name: str, iVal: int)

Sets the index of the active enum literal of the attribute with the given name

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute
`iVal`	`int`	new literal index

`SetInteger`


def SetInteger(name: str, iVal: int)

Sets a new value to the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute
`iVal`	`int`	new value of the attribute

`SetDouble`


def SetDouble(name: str, iVal: float)

Sets a new value to the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute
`iVal`	`float`	new value of the attribute

`SetString`


def SetString(name: str, iVal: str)

Sets a new value to the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute
`iVal`	`str`	new value of the attribute

`SetBool`


def SetBool(name: str, iVal: bool)

Sets a new value to the given attribute

Parameters:

Name	Type	Description
`name`	`str`	name of the attribute
`iVal`	`bool`	new value of the attribute

Version Notes

This class is documented as of release R2025.2.4.

Was this page helpful?