SC.StateChart (sc v1.0.2)

@type t() :: %SC.StateChart{
  configuration: SC.Configuration.t(),
  current_event: SC.Event.t() | nil,
  data_model: map(),
  document: SC.Document.t(),
  external_queue: [SC.Event.t()],
  internal_queue: [SC.Event.t()]
}

Functions

active_states(state_chart)

@spec active_states(t()) :: MapSet.t(String.t())

Get all currently active states including ancestors.

dequeue_event(state_chart)

@spec dequeue_event(t()) :: {SC.Event.t() | nil, t()}

Remove and return the next event from internal queue (higher priority). Falls back to external queue if internal queue is empty.

enqueue_event(state_chart, event)

@spec enqueue_event(t(), SC.Event.t()) :: t()

Add an event to the appropriate queue based on its origin.

has_events?(state_chart)

@spec has_events?(t()) :: boolean()

Check if there are any events in either queue.

new(document)

@spec new(SC.Document.t()) :: t()

Create a new state chart from a document with empty configuration.

new(document, configuration)

@spec new(SC.Document.t(), SC.Configuration.t()) :: t()

Create a new state chart with a specific configuration.

set_current_event(state_chart, event)

@spec set_current_event(t(), SC.Event.t() | nil) :: t()

Set the current event being processed.

update_configuration(state_chart, configuration)

@spec update_configuration(t(), SC.Configuration.t()) :: t()

Update the configuration of the state chart.

update_data_model(state_chart, data_model)

@spec update_data_model(t(), map()) :: t()

Update the data model of the state chart.