ros2_snapshot.snapshot.builders.parameter_builder module
Module for ParameterBuilder.
Represent ROS Entities and are responsible for allowing themselves to be populated with basic information and then further populating themselves from that information for the purpose of extracting metamodel instances
- class ros2_snapshot.snapshot.builders.parameter_builder.ParameterBuilder(name)
Bases:
_EntityBuilderDefine a ParameterBuilder.
Represents a ROS Parameter and is responsible for allowing itself to be populated with basic information relevant to a Parameter and then further populating itself from that information for the purpose of extracting a metamodel instance
- add_description(descriptor)
Collect description information associated with the parameter.
- add_info(parameter_info)
Collect information and initializes each parameter in the bank.
- property construct_type
Return the type of the Parameter’s value.
- Returns:
the Python type of the Parameter’s value
- Return type:
str
- property description
Return the description associated with the parameter.
- Returns:
description
- Return type:
str
- extract_metamodel()
Extract Parameter metamodel.
Allow the ParameterBuilder to create / extract a Parameter instance from its internal state
- Returns:
the created / extracted metamodel instance
- Return type:
- property node_name
Return the node name associated with the parameter.
- Returns:
node_name
- Return type:
str
- property value
Return the value of the Parameter.
- Returns:
the value of the Parameter
- Return type:
str
- property value_type
Return the Python type of the Parameter’s value.
- Returns:
the Python type of the Parameter’s value
- Return type:
str