as2fm.scxml_converter.scxml_entries.scxml_executable_entry.ScxmlExecutableEntry

class as2fm.scxml_converter.scxml_entries.scxml_executable_entry.ScxmlExecutableEntry

Bases: ScxmlBase

Generic class for entries that can be part of an executable block.

__init__()

Methods

__init__()
add_events_targets(events_to_models)	Add the target models for all events sent by this executable entry.
as_plain_scxml(struct_declarations, ...)	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, custom_data_types)	Child-specific implementation to create a ScxmlBase object from an XML tree.
get_config_request_receive_events()	Return the events for requesting-receiving the updated value of a conf.
get_custom_data_types()	Get the container with custom data types.
get_tag_name()	Get the tag name of the XML element.
get_xml_origin()	Get the xml_element this object was made from.
is_plain_scxml([verbose])	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 with plain scxml ones.
set_callback_prefixes(cb_prefixes)	Set the callback prefixes of the body this entry belongs to.
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_configurable_entry(ascxml_declarations)	Update possible configurable entries in the executable object.

abstract add_events_targets(events_to_models: Dict[str, Set[str]]) → List[ScxmlExecutableEntry]

Add the target models for all events sent by this executable entry.

abstract as_plain_scxml(struct_declarations, ascxml_declarations, **kwargs) → List[ScxmlBase]

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.

abstract as_xml()

Convert the object to an XML element.

abstract 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.

abstract classmethod from_xml_tree_impl(xml_tree: _Element, custom_data_types: Dict[str, StructDefinition]) → Self

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

abstract get_config_request_receive_events() → Tuple[str, str] | None

Return the events for requesting-receiving the updated value of a conf. entry, if any.

get_custom_data_types() → Dict[str, StructDefinition]

Get the container with custom data types.

abstract classmethod 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.

abstract is_plain_scxml(verbose: bool = False) → bool

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

abstract replace_strings_types_with_integer_arrays()

Replace all string literals in the contained expressions with plain scxml ones.

abstract set_callback_prefixes(cb_prefixes: List[str])

Set the callback prefixes of the body this entry belongs to.

It needs to be done for this entry and its children.

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.

abstract update_configurable_entry(ascxml_declarations: List[AscxmlDeclaration])

Update possible configurable entries in the executable object.