server.base_callable.BaseCallable

class documentation

class BaseCallable(UaObject, NotificationForwarderMixin, AbstractCallable):

Constructor: BaseCallable(name, minimum_access_level, **kwargs)

Abstract base class for all callables, i.e. skills (BaseSkill) and methods (BaseMethod).

Method	`__init__`	Create a new callable instance.
Async Method	`lifecycle_callable`	Lifecycle method which calls `_init` for initialization and `_shutdown` for shutdown.
Async Method	`lifecycle_ua_sub_node`	Initialize name, sub node, etc.
Method	`ua_node.setter`	Undocumented
Property	`ua_node`	Undocumented
Async Method	`_condition_access_allowed`	Undocumented
Async Method	`_condition_dependencies_ready`	Undocumented
Async Method	`_condition_startup_completed`	Undocumented
Async Method	`_get_sub_node`	Undocumented
Async Method	`_init`	Undocumented
Async Method	`_shutdown`	Undocumented
Instance Variable	`_ua_sub_node`	Undocumented

def __init__(self, *, name: str | None = None, minimum_access_level: int | None = None, **kwargs): ¶

Create a new callable instance.

Parameters
name:`str \| None`	name of the callable.
minimum_access_level:`int \| None`	Minimum required access level to start the callable (see User for more info)
**kwargs	Undocumented

@lifecycle(after=(ParameterSetMixin.lifecycle_parameter_set, MonitoringMixin.lifecycle_monitoring, FinalResultDataMixin.lifecycle_final_result_data))

async def lifecycle_callable(self) -> AsyncGenerator[None]: ¶

Lifecycle method which calls _init for initialization and _shutdown for shutdown.

@lifecycle(before=(ParameterSetMixin.lifecycle_parameter_set, MonitoringMixin.lifecycle_monitoring, FinalResultDataMixin.lifecycle_final_result_data))

async def lifecycle_ua_sub_node(self) -> AsyncGenerator[None]: ¶

Initialize name, sub node, etc.

@ua_node.setter

def ua_node(self, ua_node: Node): ¶

Undocumented

@property
@override

ua_node: Node = ¶

Undocumented

@override

async def _condition_access_allowed(self, user: UserAuthorization) -> bool: ¶

Undocumented

@override

async def _condition_dependencies_ready(self, _user: UserAuthorization) -> bool: ¶

Undocumented

@override

async def _condition_startup_completed(self, user: UserAuthorization) -> bool: ¶

Undocumented

@abstractmethod

async def _get_sub_node(self) -> Node: ¶

Undocumented

async def _init(self): ¶

Undocumented

async def _shutdown(self): ¶

Undocumented

_ua_sub_node: Node = ¶

Undocumented