caret_analyze.architecture.reader_interface module

class caret_analyze.architecture.reader_interface.ArchitectureReader

Bases: object

Architecture reader base class.

abstract get_callback_groups(node: NodeValue) → Sequence[CallbackGroupValue]

Get callback group values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[CallbackGroupValue]: callback group values

abstract get_executors() → Sequence[ExecutorValue]

Get executor values.

Returns

Sequence[ExecutorValue]: executor values

abstract get_message_contexts(node: NodeValue) → Sequence[dict]

Get message contexts.

Parameters

nodeNodeValue: target node

Returns

Sequence[dict]

abstract get_node_names_and_cb_symbols(callback_group_id: str) → Sequence[tuple[str | None, str | None]]

Get node names and callback symbols from callback group id.

Returns

Sequence[tuple[str | None, str | None]]: node names and callback symbols. tuple structure: (node_name, callback_symbol)

abstract get_nodes() → Sequence[NodeValueWithId]

Get nodes.

Returns

Sequence[NodeValue]: node values.

abstract get_paths() → Sequence[PathValue]

Get path value.

Returns

Sequence[PathInfo]: path values

abstract get_publishers(node_info: NodeValue) → Sequence[PublisherValue]

Get publishers info.

Parameters

node_infoNodeValue: target node

Returns

Sequence[PublisherValue]: publisher values

abstract get_service_callbacks(node: NodeValue) → Sequence[ServiceCallbackValue]

Get service callback values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[ServiceCallbackInfo]: service callback values

abstract get_services(node: NodeValue) → Sequence[ServiceValue]

Get service values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[ServiceValue]: service values

abstract get_subscription_callbacks(node: NodeValue) → Sequence[SubscriptionCallbackValue]

Get subscription callback values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[SubscriptionCallbackInfo]: subscription callback values

abstract get_subscriptions(node: NodeValue) → Sequence[SubscriptionValue]

Get subscription values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[SubscriptionValue]: subscription values

abstract get_timer_callbacks(node: NodeValue) → Sequence[TimerCallbackValue]

Get timer callback values.

Parameters

nodeNodeValue: target node

Returns

Sequence[TimerCallbackStructInfo]: timer callback values

abstract get_timers(node: NodeValue) → Sequence[TimerValue]

Get timers info.

Parameters

nodeNodeValue: target node

Returns

Sequence[TimerValue]: timers values

abstract get_variable_passings(node: NodeValue) → Sequence[VariablePassingValue]

Get variable passing values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[VariablePassingvalue]: variable passing values