as2fm.scxml_converter.ascxml_extensions.bt_entries.scxml_bt_in_port.BtGetValueInputPort

class as2fm.scxml_converter.ascxml_extensions.bt_entries.scxml_bt_in_port.BtGetValueInputPort(key_str: str)

Bases: AscxmlConfiguration

Get the value of an input port in a bt plugin.

__init__(key_str: str)

Methods

__init__(key_str)
as_plain_scxml(_, __)	Convert the object to its plain SCXML version.
as_xml()	Convert the object to an XML element.
check_validity()	Check if the object is valid.
from_xml_tree(xml_tree, custom_data_types, ...)	External interface to create a ScxmlBase object from an XML tree.
from_xml_tree_impl(xml_tree, _)	Child-specific implementation to create a ScxmlBase object from an XML tree.
get_config_request_response_events()	A method returning the events to request and receive the non-constant config values.
get_configured_value()	Retrieve the previously configured value.
get_custom_data_types()	Get the container with custom data types.
get_key_name()
get_tag_name()	Get the tag name of the XML element.
get_xml_origin()	Get the xml_element this object was made from.
has_blackboard_reference()	Check if the BT port getter refers to a blackboard entry.
is_constant_value()
is_plain_scxml([verbose])	Check if the object is compatible with the plain SCXML standard.
set_custom_data_types(custom_data_types)	Save container with custom data types.
set_xml_origin(xml_origin)	Set the xml_element this object was made from.
update_configured_value(ascxml_declarations)	Configure the entry value using the existing AscxmlDeclarations

as_plain_scxml(_, __)

Convert the object to its plain SCXML version.

Parameters:

• struct_declarations – List of custom structures defined in the model

• ascxml_declarations – Additional declarations, like ROS or BT specific ones

• kwargs – Additional framework specific entries, e.g. the BT plugin ID.

as_xml() → _Element

Convert the object to an XML element.

check_validity() → bool

Check if the object is valid.

classmethod from_xml_tree(xml_tree: _Element, custom_data_types: Dict[str, StructDefinition], **kwargs) → Self

External interface to create a ScxmlBase object from an XML tree.

classmethod from_xml_tree_impl(xml_tree: _Element, _: Dict[str, StructDefinition]) → BtGetValueInputPort

Child-specific implementation to create a ScxmlBase object from an XML tree.

get_config_request_response_events()

A method returning the events to request and receive the non-constant config values.

Returns:

None if the value is constant, a tuple with the request-receive events otherwise.

get_configured_value()

Retrieve the previously configured value.

get_custom_data_types() → Dict[str, StructDefinition]

Get the container with custom data types.

static get_tag_name() → str

Get the tag name of the XML element.

get_xml_origin() → _Element | None

Get the xml_element this object was made from.

has_blackboard_reference()

Check if the BT port getter refers to a blackboard entry.

is_plain_scxml(verbose: bool = False)

Check if the object is compatible with the plain SCXML standard.

set_custom_data_types(custom_data_types: Dict[str, StructDefinition])

Save container with custom data types.

set_xml_origin(xml_origin: _Element)

Set the xml_element this object was made from.

update_configured_value(ascxml_declarations: List[AscxmlDeclaration])

Configure the entry value using the existing AscxmlDeclarations