as2fm.jani_generator.scxml_helpers.scxml_event.Event
- class as2fm.jani_generator.scxml_helpers.scxml_event.Event(name: str, data_struct: Dict[str, EventParamType] | None = None)
Bases:
object
- __init__(name: str, data_struct: Dict[str, EventParamType] | None = None)
Methods
__init__
(name[, data_struct])add_receiver
(automaton_name, edge_action_name)Add information about the edges triggered by the event.
add_sender_edge
(automaton_name, edge_action_name)Add information about the edge sending the event.
Get the data structure of the event.
Get the receivers of the event.
Get the senders of the event.
Check if the event has one or more receivers.
Check if the event has one or more senders.
Check if the event is an action feedback event.
Check if the event is an action rejected event.
Check if the action interface is to be ignored.
Check if the BT interface is to be ignored.
Indicate if the interface contained by this event shall be removed.
Check if this is a timer event.
Check if the event must be ignored.
set_data_structure
(data_struct)Set the data structure of the event.
- add_receiver(automaton_name: str, edge_action_name: str)
Add information about the edges triggered by the event.
- add_sender_edge(automaton_name: str, edge_action_name: str)
Add information about the edge sending the event.
- get_data_structure() Dict[str, EventParamType]
Get the data structure of the event.
- get_receivers() List[EventReceiver]
Get the receivers of the event.
- get_senders() List[EventSender]
Get the senders of the event.
- has_receivers() bool
Check if the event has one or more receivers.
- has_senders() bool
Check if the event has one or more senders.
- is_action_feedback_event()
Check if the event is an action feedback event.
- is_action_rejected_event()
Check if the event is an action rejected event.
- is_removable_action_event()
Check if the action interface is to be ignored.
- is_removable_bt_interface()
Check if the BT interface is to be ignored.
Relevant when an event receiver defined, but no sender is available. This is the case for BT nodes whose parent is never sending a halt request.
- is_removable_interface()
Indicate if the interface contained by this event shall be removed.
- is_timer_event() bool
Check if this is a timer event.
- must_be_skipped_in_jani_conversion()
Check if the event must be ignored.
Those are events related to specific interfaces providing only receivers, and no senders.
- set_data_structure(data_struct: Dict[str, EventParamType])
Set the data structure of the event.