server.spatial_object.SpatialObject

class documentation

class SpatialObject(UaObject, ParentMixin[UaObject]):

Constructor: SpatialObject(name, position_frame, **kwargs)

View In Hierarchy

Spatial Object contains a PositionFrame and further CartesianFrame can be attached.

See OPC UA Relative Spatial Location specification.

Method __init__ Cooperative constructor.
Async Method add_attach_point Add given cartesian frame to the spatial object.
Async Method lifecycle_spatial_object Initialize the spatial object.
Property attach_points Return all attached cartesian frames.
Property position_frame Return the position frame of the spatial object.
Async Method _get_definition Undocumented
Instance Variable _attach_points Undocumented
Instance Variable _position_frame Undocumented
Instance Variable _ua_attach_points Undocumented
def __init__(self, *, name: str | None = 'SpatialObject', position_frame: PositionFrame, **kwargs):

Cooperative constructor.

async def add_attach_point(self, attach_point: CartesianFrame):

Add given cartesian frame to the spatial object.

@lifecycle
async def lifecycle_spatial_object(self) -> AsyncGenerator[None]:

Initialize the spatial object.

@property
attach_points: set[CartesianFrame] =

Return all attached cartesian frames.

@property
position_frame: PositionFrame =

Return the position frame of the spatial object.

@override
async def _get_definition(self) -> UaObjectDefinition:

Undocumented

_attach_points: set[CartesianFrame] =

Undocumented

_position_frame: PositionFrame =

Undocumented

_ua_attach_points: Node | None =

Undocumented