as2fm.scxml_converter.scxml_entries.scxml_executable_entries.ScxmlSend

class as2fm.scxml_converter.scxml_entries.scxml_executable_entries.ScxmlSend(event: str, params: List[ScxmlParam] | None = None, target_automaton: str | None = None)

Bases: ScxmlBase

This class represents a send action.

__init__(event: str, params: List[ScxmlParam] | None = None, target_automaton: str | None = None)

Construct a new ScxmlSend object.

Parameters:

event – The name of the event sent when executing this entry.
params – The parameters to send as part of the event.
target_automaton – The target automaton for this send event.

Methods

`__init__`(event[, params, target_automaton])	Construct a new ScxmlSend object.
`append_param`(param)
`as_plain_scxml`(_)	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 if the object is valid.
`from_xml_tree`(xml_tree)	Create a ScxmlSend object from an XML tree.
`get_body`()	Get the body of the object.
`get_event`()	Get the event to send.
`get_id`()	Get the ID of the object.
`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.
`has_bt_blackboard_input`(bt_ports_handler)	Check whether the If entry reads content from the BT Blackboard.
`instantiate_bt_events`(instance_id, _)	Instantiate the behavior tree events in the send action, if available.
`is_plain_scxml`()
`set_callback_type`(cb_type)	Set the cb type for this entry and its children.
`set_target_automaton`(target_automaton)	Set the target automata associated to this send event.
`update_bt_ports_values`(bt_ports_handler)	Update the values of potential entries making use of BT ports.

as_plain_scxml(_) → ScxmlSend: 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 if the object is valid.

static from_xml_tree(xml_tree: Element) → ScxmlSend

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.

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

get_event() → str: Get the event to send.

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

get_params() → List[ScxmlParam]: Get the parameters to send.

static get_tag_name() → str: Get the tag name of the XML element.

get_target_automaton() → str | None: Get the target automata associated to this send event.

has_bt_blackboard_input(bt_ports_handler: BtPortsHandler): Check whether the If entry reads content from the BT Blackboard.

instantiate_bt_events(instance_id: int, _) → List[ScxmlSend]: Instantiate the behavior tree events in the send action, if available.

set_callback_type(cb_type: CallbackType) → None: Set the cb type for this entry and its children.

set_target_automaton(target_automaton: str) → None: Set the target automata associated to this send event.

update_bt_ports_values(bt_ports_handler: BtPortsHandler): Update the values of potential entries making use of BT ports.