as2fm.scxml_converter.ascxml_extensions.bt_entries.scxml_bt_base.BtGenericRequestSend

class as2fm.scxml_converter.ascxml_extensions.bt_entries.scxml_bt_base.BtGenericRequestSend(child_seq_id: str | int)

Bases: ScxmlSend

A generic class representing the sender of a BT related request (i.e. tick and halt)

__init__(child_seq_id: str | int)

Generate a new BtGenericRequestSend instance.

Parameters:

child_seq_id – Which BT control node children to tick (relative the the BT-XML file).

Methods

__init__(child_seq_id)	Generate a new BtGenericRequestSend instance.
add_events_targets(events_to_models)	Add the target models for all events sent by this executable entry.
append_param(param)
as_plain_scxml(struct_declarations, ...)	Convert the object to its plain SCXML version.
as_xml()	Return the instance content as an XML Element.
check_valid_ros_instantiations(_)	Check if the ros instantiations have been declared.
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, _)	Create a ScxmlSend object from an XML tree.
generate_bt_event_name(instance_id)	Generate the plain scxml event associated to the BT Transition instance_id.
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_event()	Get the event to send.
get_params()	Get the parameters to send.
get_tag_name()	Get the tag name of the XML element.
get_target_automaton()	Get the target automata associated to this send event.
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.
set_callback_prefixes(cb_prefixes)	Set the cb type for this entry and its children.
set_custom_data_types(custom_data_types)	Save container with custom data types.
set_target_automaton(target_automaton)	Set the target automata associated to this send event.
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.

add_events_targets(events_to_models: Dict[str, Set[str]])

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

as_plain_scxml(struct_declarations, ascxml_declarations, **kwargs)

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

Return the instance content as an XML Element.

check_valid_ros_instantiations(_) → bool

Check if the ros instantiations have been declared.

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]) → BtGenericRequestSend

Create a ScxmlSend object from an XML tree.

Parameters:

• xml_tree – The XML tree to create the object from.

• cb_type – The kind of callback executing this SCXML entry.

abstract classmethod generate_bt_event_name(instance_id: int)

Generate the plain scxml event associated to the BT Transition instance_id.

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.

get_event() → str

Get the event to send.

get_params() → List[ScxmlParam]

Get the parameters to send.

abstract classmethod get_tag_name()

Get the tag name of the XML element.

get_target_automaton() → str | None

Get the target automata associated to this send event.

get_xml_origin() → _Element | None

Get the xml_element this object was made from.

is_plain_scxml(verbose: bool = False) → bool

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

replace_strings_types_with_integer_arrays() → ScxmlSend

Replace all string literals in the contained expressions.

set_callback_prefixes(cb_prefixes: List[str]) → None

Set the cb type for this entry and its children.

set_custom_data_types(custom_data_types: Dict[str, StructDefinition])

Save container with custom data types.

set_target_automaton(target_automaton: str) → None

Set the target automata associated to this send event.

set_xml_origin(xml_origin: _Element)

Set the xml_element this object was made from.

update_configurable_entry(ascxml_declarations: List[AscxmlDeclaration])

Update possible configurable entries in the executable object.