caret_analyze.value_objects.node_path module
- class caret_analyze.value_objects.node_path.NodePathStructValue(node_name: str, subscription: SubscriptionStructValue | None, publisher: PublisherStructValue | None, child: tuple[CallbackStructValue | VariablePassingStructValue, ...] | None, message_context: MessageContext | None)
Bases:
ValueObject,SummarizableStructValue object class for representing a node path.
This class is a structure that includes other related StructValue classes, such as callbacks, and used as the return value of Architecture object. In CARET, the node path is defined as from subscribe to publish.
- property callback_names: tuple[str, ...] | None
Get callback names.
Returns
- tuple[str, …] | None
Callback names of all child elements that comprise the node path.
- property callbacks: tuple[CallbackStructValue, ...] | None
Get callbacks.
Returns
- tuple[CallbackStructValue, …] | None
Callbacks in all child elements that comprise the node path.
- property child: tuple[CallbackStructValue | VariablePassingStructValue, ...] | None
Get child elements.
Returns
- tuple[CallbackStructValue | VariablePassingStructValue, …] | None
Child elements for this node path.
- property message_context: MessageContext | None
Get message context.
Returns
- MessageContext | None
Message context for this node path.
- property message_context_type: MessageContextType | None
Get message context type.
Returns
- MessageContextType | None
Message context type for this node path.
- property publish_topic_name: str | None
Get a topic name to publish.
Returns
- str | None
Topic name to publish.
- property publisher: PublisherStructValue | None
Get publisher.
Returns
- PublisherStructValue | None
Node path publisher.
- property publisher_construction_order: int | None
Get a construction order of publisher.
Returns
- int | None
Construction order of publisher.
- property subscribe_topic_name: str | None
Get a topic name to subscribe to.
Returns
- str | None
Topic name to subscribe to.
- property subscription: SubscriptionStructValue | None
Get subscription.
Returns
- SubscriptionStructValue | None
Subscription to subscribe to.
- property subscription_callback: SubscriptionCallbackStructValue | None
Get subscription callback.
Returns
- SubscriptionCallbackStructValue | None
Subscription callback for this node path.
- property subscription_construction_order: int | None
Get a construction order of subscription.
Returns
- int | None
Construction order of subscription.
- property summary: Summary
Get summary.
Returns
- Summary
Summary about value objects and runtime data objects.
- property variable_passings: tuple[VariablePassingStructValue, ...] | None
Get variable passings.
Returns
- tuple[VariablePassingStructValue, …] | None
Variable passings in all child elements that comprise the node path.
- class caret_analyze.value_objects.node_path.NodePathValue(node_name: str, subscribe_topic_name: str | None, publish_topic_name: str | None, publisher_construction_order: int | None, subscription_construction_order: int | None)
Bases:
ValueObjectValue object class for representing a node path.
This class has minimal information and no structure, and used as the return value of ArchitectureReader. In CARET, the node path is defined as from subscribe to publish.
- property publish_topic_name: str | None
Get a topic name to publish.
Returns
- str | None
Topic name to publish.
- property publisher_construction_order: int | None
Get a construction order of publisher.
Returns
- int | None
Construction order of publisher.