|
FACT++
1.0
|
|
FACT++
1.0
|
Class for a state machine implementation within a DIM network. More...
#include <StateMachineDim.h>
Inheritance diagram for StateMachineDim: Collaboration diagram for StateMachineDim:Public Member Functions | |
| StateMachineDim (std::ostream &out=std::cout, const std::string &name="DEFAULT") | |
| int | Write (const Time &time, const std::string &txt, int qos=kMessage) |
| Redirect our own logging to fLog. More... | |
| bool | AddStateName (const int state, const std::string &name, const std::string &doc="") |
| bool | MessageQueueEmpty () const |
| Public Member Functions inherited from DimCommandHandler | |
| DimCommand * | getCommand () |
| virtual | ~DimCommandHandler () |
| Public Member Functions inherited from DimInfoHandler | |
| DimInfo * | getInfo () |
| virtual | ~DimInfoHandler () |
| Public Member Functions inherited from DimErrorRedirecter | |
| DimErrorRedirecter (MessageImp &imp) | |
| ~DimErrorRedirecter () | |
| Public Member Functions inherited from DimErrorHandler | |
| virtual | ~DimErrorHandler () |
| Public Member Functions inherited from DimExitHandler | |
| virtual | ~DimExitHandler () |
| Public Member Functions inherited from StateMachineImp | |
| StateMachineImp (std::ostream &out=std::cout, const std::string &name="") | |
| ~StateMachineImp () | |
| delete all object stored in fListOfEvent and in fEventQueue More... | |
| std::function< int(const EventImp &)> | Wrap (const std::function< int(const EventImp &)> &func) |
| const std::string & | GetName () const |
| EventImp & | Subscribe (const std::string &name) |
| void | Unsubscribe (EventImp *evt) |
| int | GetCurrentState () const |
| return the current state of the machine More... | |
| void | SetReady () |
| void | SetNotReady () |
| virtual int | Run (bool dummy) |
| Start the mainloop. More... | |
| int | Run () |
| virtual void | Stop (int code=0) |
| Request to stop the mainloop. More... | |
| bool | IsRunning () const |
| Used to check if the main loop is already running or still running. More... | |
| void | EnableBuffer (bool b=true) |
| Used to enable or disable buffering of events outside of the main loop. More... | |
| bool | PostEvent (std::ostream &lout, const std::string &str) |
| Post an event to the event queue. More... | |
| bool | PostEvent (const std::string &evt) |
| bool | PostEvent (const EventImp &evt) |
| bool | PostEvent (const EventImp &evt, const char *ptr, size_t siz) |
| bool | HasEvent (const EventImp *cmd) |
| EventImp * | FindEvent (const std::string &evt) |
| bool | IsQueueEmpty () const |
| const std::vector< std::string > | GetEventNames () |
| void | PrintListOfEvents (std::ostream &out, const std::string &evt="") |
| void | PrintListOfEvents (const std::string &str="") |
| void | PrintListOfAllowedEvents (std::ostream &out) |
| void | PrintListOfAllowedEvents () |
| void | PrintListOfStates (std::ostream &out) const |
| void | PrintListOfStates () const |
| Print a list of all states with descriptions. More... | |
| int | GetStateIndex (const std::string &name) const |
| bool | HasState (int index) const |
| const std::string | GetStateName (int state) const |
| const std::string | GetStateName () const |
| const std::string | GetStateDesc (int state) const |
| const std::string | GetStateDesc () const |
| const std::string | GetStateDescription (int state) const |
| const std::string | GetStateDescription () const |
| Public Member Functions inherited from MainImp | |
| virtual | ~MainImp () |
| Public Member Functions inherited from MessageImp | |
| MessageImp (std::ostream &out=std::cout) | |
| virtual | ~MessageImp () |
| virtual void | IndicateStateChange (const Time &, const std::string &) |
| void | StateChanged (const Time &time, const std::string &server, const std::string &msg, int state) |
| int | Update (const std::string &txt, int severity=kMessage) |
| int | Update (const char *txt, int severity=kMessage) |
| int | Update (const std::ostringstream &str, int severity=kMessage) |
| int | Debug (const std::string &str) |
| int | Message (const std::string &str) |
| int | Info (const std::string &str) |
| int | Warn (const std::string &str) |
| int | Error (const std::string &str) |
| int | Alarm (const std::string &str) |
| int | Fatal (const std::string &str) |
| int | Comment (const std::string &str) |
| int | Debug (const char *txt) |
| int | Message (const char *txt) |
| int | Info (const char *txt) |
| int | Warn (const char *txt) |
| int | Error (const char *txt) |
| int | Alarm (const char *txt) |
| int | Fatal (const char *txt) |
| int | Comment (const char *txt) |
| int | Debug (const std::ostringstream &str) |
| int | Message (const std::ostringstream &str) |
| int | Info (const std::ostringstream &str) |
| int | Warn (const std::ostringstream &str) |
| int | Alarm (const std::ostringstream &str) |
| int | Error (const std::ostringstream &str) |
| int | Fatal (const std::ostringstream &str) |
| int | Comment (const std::ostringstream &str) |
| std::ostream & | operator() () const |
| std::ostream & | Out () const |
Protected Member Functions | |
| std::string | SetCurrentState (int state, const char *txt="", const std::string &cmd="") |
| void | Lock () |
| void | UnLock () |
| Protected Member Functions inherited from DimStart | |
| DimStart (const std::string &name, MessageImp &imp) | |
| ~DimStart () | |
| Protected Member Functions inherited from StateMachineImp | |
| virtual void | PushEvent (Event *cmd) |
| This is a flag which is set true if the main loop should stop. More... | |
| std::shared_ptr< Event > | PopEvent () |
| Pop a command from the fifo. More... | |
| bool | HandleNewState (int newstate, const EventImp *evt, const char *txt) |
| virtual int | Execute () |
| Is called continously to execute actions in the current state. More... | |
| bool | HandleEvent (const EventImp &evt) |
| EventImp & | AddEvent (const std::string &name, const std::string &states, const std::string &fmt) |
| EventImp & | AddEvent (const std::string &name, int s1=-1, int s2=-1, int s3=-1, int s4=-1, int s5=-1) |
| EventImp & | AddEvent (const std::string &name, const std::string &fmt, int s1=-1, int s2=-1, int s3=-1, int s4=-1, int s5=-1) |
| void | SetDefaultStateNames () |
Private Member Functions | |
| void | exitHandler (int code) |
| DimService offering fCurrentState. More... | |
| void | commandHandler () |
| Overwritten DimCommand::exitHandler. More... | |
| void | infoHandler () |
| Overwritten DimCommand::commandHandler. More... | |
| EventImp * | CreateEvent (const std::string &name, const std::string &fmt) |
| Overwritten DimInfo::infoHandler. More... | |
| EventImp * | CreateService (const std::string &name) |
Private Attributes | |
| DimDescribedService | fDescriptionStates |
| Version number. More... | |
| DimDescribedService | fSrvState |
| DimService propagating the state descriptions. More... | |
Static Private Attributes | |
| static const int | fVersion = 42 |
Additional Inherited Members | |
| Public Types inherited from StateMachineImp | |
| enum | DefaultStates_t { kSM_KeepState = -42, kSM_NotAvailable = -2, kSM_NotReady = -1, kSM_Ready = 0, kSM_UserMode = 1, kSM_Error = 0x100, kSM_FatalError = 0xffff } |
| Public Types inherited from MessageImp | |
| enum | Severity { kMessage = 10, kInfo = 20, kWarn = 30, kError = 40, kAlarm = 45, kFatal = 50, kComment = 90, kDebug = 99 } |
| Severity of a message. More... | |
| Public Attributes inherited from DimCommandHandler | |
| DimCommand * | itsCommand |
| Public Attributes inherited from DimInfoHandler | |
| DimInfo * | itsService |
| Protected Attributes inherited from StateMachineImp | |
| StateNames | fStateNames |
| Human readable names associated with the states. More... | |
| bool | fRunning |
| Flag if events should be buffered outside the event loop. More... | |
| int | fExitRequested |
| Machine is in main-loop. More... | |
Class for a state machine implementation within a DIM network.
This class implements a StateMachine within a Dim network. It redirects all output posted via MessageImp to a service called "NAME/MESSAGE" while name is the name of the machine given in the constructor. In addition two services are offered: NAME/STATE and NAME/VERSION. NAME/STATE propagates any state change to the netork.
When constructing the Dim network is started and while dstruction it is stopped.
Definition at line 71 of file StateMachineDim.h.
1.8.11 
