server.spatial_object.FrameFolder

class documentation

class FrameFolder(ParentMixin['SpatialObject'], UaObject):

Constructor: FrameFolder(name, parent)

View In Hierarchy

A named UA folder for SpatialObject, and the CartesianFrame objects inside it.

Method __contains__ Check if given frame is in this folder.
Method __init__ Create a new frame folder.
Method __iter__ Return an iterator over the frames in the folder.
Method __len__ Return the number of frames in this folder.
Async Method add Add given frame to this frame folder. Given frame must not be initialized.
Async Method _ensure_node Undocumented
Async Method _get_definition Undocumented
Instance Variable _frames Undocumented
Instance Variable _lock Undocumented
def __contains__(self, frame: object) -> bool:

Check if given frame is in this folder.

def __init__(self, *, name: str, parent: SpatialObject):

Create a new frame folder.

Parameters
name:strThe name of the folder. See OPC UA RSL specification for valid names.
parent:SpatialObjectThe parent spatial object.
def __iter__(self) -> Iterator[CartesianFrame]:

Return an iterator over the frames in the folder.

def __len__(self) -> int:

Return the number of frames in this folder.

async def add(self, frame: CartesianFrame):

Add given frame to this frame folder. Given frame must not be initialized.

async def _ensure_node(self) -> Node:

Undocumented

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

Undocumented

_frames: set[CartesianFrame] =

Undocumented

_lock =

Undocumented