caret_analyze.architecture.architecture_loaded module

class caret_analyze.architecture.architecture_loaded.ArchitectureLoaded(reader: ArchitectureReader, ignore_topics: list[str], max_callback_construction_order_on_path_searching: int)

Bases: object

property communications: list[CommunicationStruct]

property executors: list[ExecutorStruct]

property nodes: list[NodeStruct]

property paths: list[PathStruct]

class caret_analyze.architecture.architecture_loaded.CallbackGroupsLoaded(reader: ArchitectureReader, callbacks_loaded: CallbacksLoaded, node: NodeValue)

Bases: object

property data: list[CallbackGroupStruct]

find_callback_group(callback_group_id: str)

class caret_analyze.architecture.architecture_loaded.CallbackPathSearched(node: NodeStruct, max_callback_construction_order: int)

Bases: object

property data: list[NodePathStruct]

class caret_analyze.architecture.architecture_loaded.CallbacksLoaded(reader: ArchitectureReader, node: NodeValue)

Bases: object

property data: list[CallbackStruct]

find_callback(callback_id: str) → CallbackStruct

property node_name: str

search_callbacks(callback_ids: list[str]) → list[CallbackStruct]

Search callbacks.

Parameters

callback_idslist[str, …]: target callback ids

Returns

list[CallbackStruct, …]: If the callback is not found, it returns an empty tuple.

class caret_analyze.architecture.architecture_loaded.CommValuesLoaded(nodes_loaded: NodeValuesLoaded)

Bases: object

class IsTargetPubCallback(publish: PublisherStruct): Bases: object

class IsTargetSubCallback(subscription: SubscriptionStruct): Bases: object

property data: list[CommunicationStruct]

find_communication(topic_name: str, publish_node_name: str, publisher_construction_order: int | None, subscribe_node_name: str, subscription_construction_order: int | None) → CommunicationStruct

class caret_analyze.architecture.architecture_loaded.ExecutorValuesLoaded(reader: ArchitectureReader, nodes_loaded: NodeValuesLoaded)

Bases: object

property data: list[ExecutorStruct]

class caret_analyze.architecture.architecture_loaded.MessageContextsLoaded(reader: ArchitectureReader, node: NodeStruct, node_paths: Sequence[NodePathStruct])

Bases: object

property data: list[MessageContextStruct]

static get_node_path(node_paths: Sequence[NodePathStruct], publisher_topic_name: str, subscription_topic_name: str, subscription_construction_order: int, publisher_construction_order: int) → NodePathStruct

class caret_analyze.architecture.architecture_loaded.NodePathCreated(subscription_values: list[SubscriptionStruct], publisher_values: list[PublisherStruct])

Bases: object

property data: list[NodePathStruct]

class caret_analyze.architecture.architecture_loaded.NodeValuesLoaded(reader: ArchitectureReader, max_callback_construction_order_on_path_searching: int)

Bases: object

property data: list[NodeStruct]

find_callback(callback_id: str) → CallbackStruct

find_callback_group(callback_group_id: str) → CallbackGroupStruct

find_callbacks(callback_ids: list[str]) → list[CallbackStruct]

find_node(node_name: str) → NodeStruct

find_node_path(node_path_value: NodePathValue) → NodePathStruct

get_callbacks(node_name: str) → list[CallbackStruct]

class caret_analyze.architecture.architecture_loaded.PathValuesLoaded(reader: ArchitectureReader, nodes_loaded: NodeValuesLoaded, communications_loaded: CommValuesLoaded)

Bases: object

property data: list[PathStruct]

class caret_analyze.architecture.architecture_loaded.PublishersLoaded(reader: ArchitectureReader, callbacks_loaded: CallbacksLoaded, node: NodeValue)

Bases: object

property data: list[PublisherStruct]

class caret_analyze.architecture.architecture_loaded.ServicesLoaded(reader: ArchitectureReader, callbacks_loaded: CallbacksLoaded, node: NodeValue)

Bases: object

property data: list[ServiceStruct]

class caret_analyze.architecture.architecture_loaded.SubscriptionsLoaded(reader: ArchitectureReader, callbacks_loaded: CallbacksLoaded, node: NodeValue)

Bases: object

property data: list[SubscriptionStruct]

class caret_analyze.architecture.architecture_loaded.TimersLoaded(reader: ArchitectureReader, callbacks_loaded: CallbacksLoaded, node: NodeValue)

Bases: object

property data: list[TimerStruct]

class caret_analyze.architecture.architecture_loaded.TopicIgnoredReader(reader: ArchitectureReader, ignore_topics: list[str])

Bases: ArchitectureReader

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

Get callback group values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[CallbackGroupValue]: callback group values

get_executors() → Sequence[ExecutorValue]

Get executor values.

Returns

Sequence[ExecutorValue]: executor values

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

Get message contexts.

Parameters

nodeNodeValue: target node

Returns

Sequence[dict]

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)

get_nodes() → Sequence[NodeValueWithId]

Get nodes.

Returns

Sequence[NodeValue]: node values.

get_paths() → Sequence[PathValue]

Get path value.

Returns

Sequence[PathInfo]: path values

get_publishers(node: NodeValue) → list[PublisherValue]

Get publishers info.

Parameters

node_infoNodeValue: target node

Returns

Sequence[PublisherValue]: publisher values

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

Get service callback values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[ServiceCallbackInfo]: service callback values

get_services(node: NodeValue) → list[ServiceValue]

Get service values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[ServiceValue]: service values

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

Get subscription callback values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[SubscriptionCallbackInfo]: subscription callback values

get_subscriptions(node: NodeValue) → list[SubscriptionValue]

Get subscription values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[SubscriptionValue]: subscription values

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

Get timer callback values.

Parameters

nodeNodeValue: target node

Returns

Sequence[TimerCallbackStructInfo]: timer callback values

get_timers(node: NodeValue) → list[TimerValue]

Get timers info.

Parameters

nodeNodeValue: target node

Returns

Sequence[TimerValue]: timers values

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

Get variable passing values.

Parameters

nodeNodeInfo: target node

Returns

Sequence[VariablePassingvalue]: variable passing values

class caret_analyze.architecture.architecture_loaded.VariablePassingsLoaded(reader: ArchitectureReader, callbacks_loaded: CallbacksLoaded, node: NodeValue)

Bases: object

property data: list[VariablePassingStruct]

caret_analyze.architecture.architecture_loaded.indexed_name(base_name: str, i: int, num_digit: int)