StateTransitor

struct StateTransitor(StateType, EventType, StateType defaultStateParameter = StateType.init, ProcHandler = void delegate()[], ExceptionHandler = void delegate(Exception)[], EventHandler = void delegate(EventType)[], StateChangedHandler = void delegate(StateType newSts, StateType oldSts)[], ConsumeMode consumeMode = ConsumeMode.combined, EventContainer = SList!EventType)
struct StateTransitor (
StateType
EventType
StateType defaultStateParameter = StateType.init
ProcHandler = void delegate(
)[]
ExceptionHandler = void delegate(
Exception
)[]
EventHandler = void delegate(
EventType
)[]
StateChangedHandler = void delegate(
StateType newSts
,
StateType oldSts
)[]
ConsumeMode consumeMode = ConsumeMode.combined
EventContainer = SList!EventType
) {
alias State = StateType;
alias Event = EventType;
enum size_t stateCount;
enum size_t eventCount;
enum State defaultState;
struct Cell;
this(Cell[stateCount][eventCount] tbl);
void initialize(Cell[stateCount][eventCount] tbl);
void matrixName(string str);
string matrixName();
void setEventName(Event ev, string evname);
string getEventName(Event ev);
void eventNames(in string[eventCount] names);
const(string)[] eventNames();
void setStateName(State st, string stname);
string getStateName(State st);
void stateNames(in string[stateCount] names);
const(string)[] stateNames();
State currentState();
void enforceState(State sts);
void setNextState(State s, Event e, State nextState);
void setHandler(State s, Event e, Func handler);
void addHandler(State s, Event e, Func handler);
void removeHandler(State s, Event e, Func handler);
void clearHandler(State s, Event e);
void setExceptionHandler(Func handler);
void addExceptionHandler(Func handler);
void removeExceptionHandler(Func handler);
void clearExceptionHandler();
void setEventHandler(Func handler);
void addEventHandler(Func handler);
void removeEventHandler(Func handler);
void clearEventHandler();
void setStateChangedHandler(Func handler);
void addStateChangedHandler(Func handler);
void removeStateChangedHandler(Func handler);
void clearStateChangedHandler();
void put(Event e);
void consume();
bool emptyEvents();
}
template StateTransitor(alias Policy)

Constructors

this this(Cell[stateCount][eventCount] tbl): Constractor

Members

Aliases

Event alias Event = EventType: State type of this StateTransitor
State alias State = StateType: State type of this StateTransitor

Functions

addEventHandler void addEventHandler(Func handler): Add event handler
addExceptionHandler void addExceptionHandler(Func handler): Add exception handler
addHandler void addHandler(State s, Event e, Func handler): Add handler
addStateChangedHandler void addStateChangedHandler(Func handler): Add state changed handler
clearEventHandler void clearEventHandler(): Remove all event handler.
clearExceptionHandler void clearExceptionHandler(): Remove all exception handler.
clearHandler void clearHandler(State s, Event e): Remove all handler related s and e.
clearStateChangedHandler void clearStateChangedHandler(): Remove all state changed handler.
consume void consume(): Consume a event
currentState State currentState(): Check current state
emptyEvents bool emptyEvents(): Check for unconsumed events
enforceState void enforceState(State sts): Change current state enforcely
eventNames void eventNames(in string[eventCount] names)
const(string)[] eventNames()
getEventName string getEventName(Event ev): Set/Get event names
getStateName string getStateName(State st): Set/Get state names
initialize void initialize(Cell[stateCount][eventCount] tbl): Initialize of table
matrixName void matrixName(string str)
string matrixName(): Get/Set matrix name
put void put(Event e): Add a event
removeEventHandler void removeEventHandler(Func handler): Remove event handler.
removeExceptionHandler void removeExceptionHandler(Func handler): Remove exception handler.
removeHandler void removeHandler(State s, Event e, Func handler): Remove handler related s and e.
removeStateChangedHandler void removeStateChangedHandler(Func handler): Remove state changed handler.
setEventHandler void setEventHandler(Func handler): Set event handler
setEventName void setEventName(Event ev, string evname): Set/Get event names
setExceptionHandler void setExceptionHandler(Func handler): Set exception handler
setHandler void setHandler(State s, Event e, Func handler): Set handler
setNextState void setNextState(State s, Event e, State nextState): Set next state
setStateChangedHandler void setStateChangedHandler(Func handler): Set state changed handler
setStateName void setStateName(State st, string stname)
stateNames void stateNames(in string[stateCount] names)
const(string)[] stateNames(): Set/Get state names

Structs

Cell struct Cell: Cell of table

Variables

defaultState enum State defaultState;: Default state of this StateTransitor
eventCount enum size_t eventCount;: Count of kind of event in this StateTransitor(Not a count of unconsumed event)
stateCount enum size_t stateCount;: Count of kind of state in this StateTransitor

Examples

1 enum State { a, b }
2 enum Event { e1, e2, e3 }
3 
4 alias Stm = StateTransitor!(State, Event);
5 
6 alias C = Stm.Cell;
7 string msg;
8 // STM
9 auto sm = Stm([
10 	// Event     StateA                      StateB
11 	/* e1:   */ [C(State.b, {msg = "a-1";}), C(State.b, forbiddenHandler)],
12 	/* e2:   */ [C(State.a, ignoreHandler),  C(State.a, {msg = "b-2";})],
13 	/* e3:   */ [C(State.a, {msg = "a-3";}), C(State.a, forbiddenHandler)]
14 ]);
15 static assert(isOutputRange!(typeof(sm), Event));
16 
17 assert(sm.currentState == State.a);
18 std.range.put(sm, Event.e1);
19 assert(sm.currentState == State.b);
20 assert(msg == "a-1");
21 sm.put(Event.e2);
22 assert(sm.currentState == State.a);
23 assert(msg == "b-2");
24 sm.put(Event.e3);
25 assert(sm.currentState == State.a);
26 assert(msg == "a-3");
27 sm.put(Event.e2);
28 assert(sm.currentState == State.a);
29 assert(msg == "a-3");
30 sm.put(Event.e1);
31 assert(sm.currentState == State.b);
32 assert(msg == "a-1");

1 struct Policy
2 {
3 	enum State { a, b }
4 	enum Event { e1, e2, e3 }
5 	enum consumeMode = ConsumeMode.separate;
6 }
7 alias Stm = StateTransitor!Policy;
8 alias State = Policy.State;
9 alias Event = Policy.Event;
10 alias C = Stm.Cell;
11 string[] msg;
12 State[]  statesOnEvent;
13 // STM
14 auto sm = Stm([
15 	// Event     StateA                      StateB
16 	/* e1:   */ [C(State.b, {msg ~= "a-1";}), C(State.b, forbiddenHandler)],
17 	/* e2:   */ [C(State.a, ignoreHandler),   C(State.a, {msg ~= "b-2";})],
18 	/* e3:   */ [C(State.a, {msg ~= "a-3";}), C(State.a, forbiddenHandler)]
19 ]);
20 sm.addEventHandler((Event e)
21 {
22 	statesOnEvent ~= sm.currentState;
23 });
24 static assert(isOutputRange!(typeof(sm), Event));
25 
26 assert(sm.currentState == State.a);
27 put(sm, [Event.e1, Event.e2, Event.e3, Event.e2, Event.e1]);
28 assert(sm.currentState == State.a);
29 
30 while (!sm.emptyEvents)
31 	sm.consume();
32 with (State)
33 	assert(statesOnEvent == [a, b, a, a, a]);
34 assert(sm.currentState == State.b);
35 assert(msg == ["a-1", "b-2", "a-3", "a-1"]);

StateTransitor

Constructors

Members

Aliases

Functions

Structs

Variables

Examples

Meta

Source