caret_analyze.architecture.struct.callback module

class caret_analyze.architecture.struct.callback.CallbackStruct(node_name: str, symbol: str, subscribe_topic_name: str | None, service_name: str | None, publish_topics: list[PublishTopicInfoValue] | None, construction_order: int, callback_name: str)

Bases: object

Callback value base class.

property callback_name: str

Get callback name.

Returns

str: callback name

abstract property callback_type: CallbackType

Get callback type name.

Returns

CallbackType: callback type

property callback_type_name: str

property construction_order: int

Get construction order.

Returns

int: construction order

insert_publisher(publish_topic_info: PublishTopicInfoValue) → None

property node_name: str

Get node name.

Returns

str: node name

property publish_topics: list[PublishTopicInfoValue] | None

Get publisher topic info.

Returns

PublishTopicInfo: publish topics

remove_publisher(publish_topic_info: PublishTopicInfoValue) → None

rename_node(src: str, dst: str) → None

rename_topic(src: str, dst: str) → None

property service_name: str | None

property subscribe_topic_name: str | None

property symbol: str

Get callback symbol name.

Returns

str: callback symbol name

abstract to_value() → CallbackStructValue

class caret_analyze.architecture.struct.callback.ServiceCallbackStruct(node_name: str, symbol: str, service_name: str, publish_topics: list[PublishTopicInfoValue] | None, construction_order: int, callback_name: str)

Bases: CallbackStruct

Structured service callback value.

property callback_type: CallbackType

Get callback type name.

Returns

CallbackType: callback type

property service_name: str

to_value() → ServiceCallbackStructValue

class caret_analyze.architecture.struct.callback.SubscriptionCallbackStruct(node_name: str, symbol: str, subscribe_topic_name: str, publish_topics: list[PublishTopicInfoValue] | None, construction_order: int, callback_name: str)

Bases: CallbackStruct

Structured subscription callback value.

property callback_type: CallbackType

Get callback type name.

Returns

CallbackType: callback type

rename_topic(src: str, dst: str) → None

property subscribe_topic_name: str

to_value() → SubscriptionCallbackStructValue

class caret_analyze.architecture.struct.callback.TimerCallbackStruct(node_name: str, symbol: str, period_ns: int, publish_topics: list[PublishTopicInfoValue] | None, construction_order: int, callback_name: str)

Bases: CallbackStruct

Structured timer callback value.

property callback_type: CallbackType

Get callback type name.

Returns

CallbackType: callback type

property period_ns: int

to_value() → TimerCallbackStructValue