Process Geometry Operator
Quick Facts
| Property | Value |
|---|---|
| Class | CENPyOlpProcessGeometryOperator |
| Module | cenpylib.CENPyOlpProcessGeometryOperator |
| Package | cenpylib |
| Release | R2026.1 |
| Methods | 21 |
Quick Start
# Boilerplate Example
processGeometryOperator = ... # obtained from the runtime context
result = processGeometryOperator.GetInteger("...")Method Index
| Method | Returns | Summary |
|---|---|---|
GetInteger | int | Gets the Integer Value for the given Integer attribute |
GetDouble | float | Gets the Double Value for the given Double attribute |
GetString | str | Gets the String Value for the given String attribute |
GetBool | bool | Gets the Bool Value for the given Bool attribute |
GetAttributeIntegerByName | CENPyOlpAttributeInt | Gets the Integer attribute by the given name. |
GetAttributeDoubleByName | CENPyOlpAttributeDouble | Gets the Double attribute by the given name. |
GetAttributeStringByName | CENPyOlpAttributeString | Gets the String attribute by the given name. |
GetAttributeBoolByName | CENPyOlpAttributeBool | Gets the Bool attribute by the given name. |
GetProcessGeometryName | str | Gets the Name of the current used Process Geometry |
IsRegshape | bool | Check if the process geometry is a regshape |
GetRegshapeType | int | Detects and returns the RegshapeType |
GetRegshapeCenter | CENPyOlpMatrix | Returns the center of the regshape with respect to the base frame coordinates given by the operation |
GetRegshapeLength | float | Gets the Length of the Regshape |
GetRegshapeHeight | float | Gets the Height of the Regshape |
GetRegshapeRadius | float | Gets the Radius of the Regshape |
GetRegshapeCornerRadius | float | Gets the CornerRadius of the Regshape (Keyhole) |
GetGeoType | int | Gets the Process geometry Type |
GetContourLength | float | Returns the curve length of the contour process geometry. |
IsProcessGeometryBoxWithinWorkingAreaOfController | bool | Checks if the bounding box is within the working area of a controller. |
GetBoundingBox | tuple[CENPyOlpPoint, CENPyOlpPoint] | Returns the process geometry bounding box. |
GetProcessGeometryIdentifier | str | Get the UUID of the process geometry. |
Query Methods
GetInteger
def GetInteger(name: str) -> intGets the Integer Value for the given Integer attribute
Parameters:
| Name | Type | Description |
|---|---|---|
name | str | name of the attribute. |
Returns: int — Value of the Integer Attribute.
GetDouble
def GetDouble(name: str) -> floatGets the Double Value for the given Double attribute
Parameters:
| Name | Type | Description |
|---|---|---|
name | str | name of the attribute. |
Returns: float — Value of the Double Attribute.
GetString
def GetString(name: str) -> strGets the String Value for the given String attribute
Parameters:
| Name | Type | Description |
|---|---|---|
name | str | name of the attribute. |
Returns: str — Value of the String Attribute.
GetBool
def GetBool(name: str) -> boolGets the Bool Value for the given Bool attribute
Parameters:
| Name | Type | Description |
|---|---|---|
name | str | name of the attribute. |
Returns: bool — Value of the Bool Attribute.
GetAttributeIntegerByName
def GetAttributeIntegerByName(attributeName: str) -> CENPyOlpAttributeIntGets the Integer attribute by the given name.
Parameters:
| Name | Type | Description |
|---|---|---|
attributeName | str | Name of the attribute to find. |
Returns: CENPyOlpAttributeInt — Integer attribute.
GetAttributeDoubleByName
def GetAttributeDoubleByName(attributeName: str) -> CENPyOlpAttributeDoubleGets the Double attribute by the given name.
Parameters:
| Name | Type | Description |
|---|---|---|
attributeName | str | Name of the attribute to find. |
Returns: CENPyOlpAttributeDouble — Double attribute.
GetAttributeStringByName
def GetAttributeStringByName(attributeName: str) -> CENPyOlpAttributeStringGets the String attribute by the given name.
Parameters:
| Name | Type | Description |
|---|---|---|
attributeName | str | Name of the attribute to find. |
Returns: CENPyOlpAttributeString — String attribute.
GetAttributeBoolByName
def GetAttributeBoolByName(attributeName: str) -> CENPyOlpAttributeBoolGets the Bool attribute by the given name.
Parameters:
| Name | Type | Description |
|---|---|---|
attributeName | str | Name of the attribute to find. |
Returns: CENPyOlpAttributeBool — Bool attribute.
GetProcessGeometryName
def GetProcessGeometryName() -> strGets the Name of the current used Process Geometry
Returns: str — Name of the Process Geometry.
IsRegshape
def IsRegshape() -> boolCheck if the process geometry is a regshape
Returns: bool — True if regshape detected, otherwise False.
GetRegshapeType
def GetRegshapeType() -> intDetects and returns the RegshapeType
Returns: int — detected RegshapeType as an Integer
GetRegshapeCenter
def GetRegshapeCenter() -> CENPyOlpMatrixReturns the center of the regshape with respect to the base frame coordinates given by the operation this regshape is assigned to. If this is no regshape nullptr is returned.
Returns: CENPyOlpMatrix — regshape center in a Matrix base frame coordinates
GetRegshapeLength
def GetRegshapeLength() -> floatGets the Length of the Regshape
Returns: float — Length of the Regshape in a Double
GetRegshapeHeight
def GetRegshapeHeight() -> floatGets the Height of the Regshape
Returns: float — Height of the Regshape in a Double
GetRegshapeRadius
def GetRegshapeRadius() -> floatGets the Radius of the Regshape
Returns: float — Radius of the Regshape in a Double
GetRegshapeCornerRadius
def GetRegshapeCornerRadius() -> floatGets the CornerRadius of the Regshape (Keyhole)
Returns: float — CornerRadius of the Regshape in a Double
GetGeoType
def GetGeoType() -> intGets the Process geometry Type
Returns: int — detected RegshapeType as an Integer
GetContourLength
def GetContourLength() -> floatReturns the curve length of the contour process geometry.
Returns: float — Contour curve length.
IsProcessGeometryBoxWithinWorkingAreaOfController
def IsProcessGeometryBoxWithinWorkingAreaOfController(controller: CENPyOlpController) -> boolChecks if the bounding box of the process geometry is within the working area of the specified controller.
Parameters:
| Name | Type | Description |
|---|---|---|
controller | CENPyOlpController | Controller to validate against. |
Returns: bool — True if within the controller working area, otherwise False.
GetBoundingBox
def GetBoundingBox() -> tuple[CENPyOlpPoint, CENPyOlpPoint]Returns the bounding box of a process geometry.
Returns: tuple[CENPyOlpPoint, CENPyOlpPoint] — Min and max points in world coordinates.
GetProcessGeometryIdentifier
def GetProcessGeometryIdentifier() -> strGet the UUID of the process geometry.
Returns: str — Process geometry UUID.
Related Types
Version Notes
This class is documented as of release R2026.1.1.