as2fm.scxml_converter.scxml_entries.scxml_executable_entries.ScxmlAssign

class as2fm.scxml_converter.scxml_entries.scxml_executable_entries.ScxmlAssign(location: str, expr: str | BtGetValueInputPort)

Bases: ScxmlBase

This class represents a variable assignment.

__init__(location: str, expr: str | BtGetValueInputPort)

Methods

`__init__`(location, expr)
`as_plain_scxml`(struct_declarations, _)	Convert the object to its plain SCXML version.
`as_xml`()	Convert the object to an XML element.
`check_valid_ros_instantiations`(_)	Check if the ros instantiations have been declared.
`check_validity`()	Check that the ScxmlAssign instance 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, custom_data_types)	Create a ScxmlAssign object from an XML tree.
`get_body`()	Get the body of the object.
`get_custom_data_types`()	Get the container with custom data types.
`get_expr`()	Get the expression to assign.
`get_id`()	Get the ID of the object.
`get_location`()	Get the location to assign.
`get_tag_name`()	Get the tag name of the XML element.
`get_xml_origin`()	Get the xml_element this object was made from.
`has_bt_blackboard_input`(bt_ports_handler)	Check whether the If entry reads content from the BT Blackboard.
`instantiate_bt_events`(_, __)	This functionality is not needed in this class.
`is_plain_scxml`()	Check if the object is compatible with the plain SCXML standard.
`replace_strings_types_with_integer_arrays`()	Replace all string literals in the contained expressions.
`set_callback_type`(cb_type)	Set the cb type for this assignment.
`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_bt_ports_values`(bt_ports_handler)	Update the values of potential entries making use of BT ports.

as_plain_scxml(struct_declarations: ScxmlStructDeclarationsContainer, _) → List[ScxmlAssign]: Convert the object to its plain SCXML version.

as_xml() → _Element: Convert the object to an XML element.

check_valid_ros_instantiations(_) → bool: Check if the ros instantiations have been declared.

check_validity() → bool

Check that the ScxmlAssign instance is valid.

Note that this assumes all values from BT ports are already substituted.

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, custom_data_types: Dict[str, StructDefinition]) → ScxmlAssign

Create a ScxmlAssign object from an XML tree.

Parameters:: xml_tree – The XML tree to create the object from.

get_body(): Get the body of the object.

get_custom_data_types() → Dict[str, StructDefinition]: Get the container with custom data types.

get_expr() → str | BtGetValueInputPort: Get the expression to assign.

get_id() → str: Get the ID of the object.

get_location() → str: Get the location to assign.

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_bt_blackboard_input(bt_ports_handler: BtPortsHandler): Check whether the If entry reads content from the BT Blackboard.

instantiate_bt_events(_, __) → List[ScxmlAssign]: This functionality is not needed in this class.

is_plain_scxml() → bool: Check if the object is compatible with the plain SCXML standard.

replace_strings_types_with_integer_arrays() → ScxmlAssign: Replace all string literals in the contained expressions.

set_callback_type(cb_type: CallbackType) → None: Set the cb type for this assignment.

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_bt_ports_values(bt_ports_handler: BtPortsHandler) → None: Update the values of potential entries making use of BT ports.