Event Queue¶
-
class
acnportal.acnsim.events.
EventQueue
(events=None)¶ Queue which stores simulation events.
Parameters: events (List[Event]) – A list of Event-like objects. -
add_event
(event)¶ Add an event to the queue.
Parameters: event (Event like) – An Event-like object. Returns: None
-
add_events
(events)¶ Add multiple events at a time to the queue.
Parameters: events (List[Event like]) – A list of Event-like objects. Returns: None
-
empty
()¶ Return if the queue is empty.
Returns: True if the queue is empty. Return type: bool
-
get_current_events
(timestep)¶ Return all events occurring before or during timestep.
Parameters: timestep (int) – Time index in periods. Returns: List of all events occurring before or during timestep. Return type: List[Event]
-
get_event
()¶ Return the next event in the queue.
Returns: The next event in the queue. Return type: Event like
-
get_last_timestamp
()¶ Return the timestamp of the last event (chronologically) in the event queue
Returns: - Last timestamp in the event queue, or None if the
- event queue is empty.
Return type: int
-
queue
¶ Return the queue of events
-