CMS 3D CMS Logo
dqm::StateMachine

dqm::StateMachine Class Reference

#include <DQMServices/XdaqCollector/interface/StateMachine.h>

Inheritance diagram for dqm::StateMachine:

DQMBaseClient

List of all members.

Public Member Functions

virtual void configureAction (toolbox::Event::Reference e)=0 throw (toolbox::fsm::exception::Exception)
 transition methods to be implemented by the application
virtual void enableAction (toolbox::Event::Reference e)=0 throw (toolbox::fsm::exception::Exception)
xoap::MessageReference fireEvent (xoap::MessageReference msg) throw (xoap::exception::Exception)
virtual void haltAction (toolbox::Event::Reference e)=0 throw (toolbox::fsm::exception::Exception)
virtual void nullAction (toolbox::Event::Reference e)=0 throw (toolbox::fsm::exception::Exception)
virtual void resumeAction (toolbox::Event::Reference e)=0 throw (toolbox::fsm::exception::Exception)
 StateMachine (xdaq::ApplicationStub *s)
virtual void stopAction (toolbox::Event::Reference e) throw (toolbox::fsm::exception::Exception)
virtual void suspendAction (toolbox::Event::Reference e)=0 throw (toolbox::fsm::exception::Exception)
virtual ~StateMachine ()

Protected Member Functions

void bind (std::string)
void Default (xgi::Input *in, xgi::Output *out) throw (xgi::exception::Exception)
void dispatch (xgi::Input *in, xgi::Output *out) throw (xgi::exception::Exception)
xdata::String * stateName ()

Private Member Functions

void failurePage (xgi::Output *out, xgi::exception::Exception &e) throw (xgi::exception::Exception)
void statePage (xgi::Output *out) throw (xgi::exception::Exception)
void webConfigure (xgi::Input *in) throw (xgi::exception::Exception)
 Web Events that trigger state changes.
void webEnable (xgi::Input *in) throw (xgi::exception::Exception)
void webHalt (xgi::Input *in) throw (xgi::exception::Exception)
void webResume (xgi::Input *in) throw (xgi::exception::Exception)
void webSuspend (xgi::Input *in) throw (xgi::exception::Exception)

Private Attributes

evf::EPStateMachine fsm_
std::string page_
xgi::WSM wsm_

Detailed Description

Definition at line 18 of file StateMachine.h.

Constructor & Destructor Documentation

StateMachine::StateMachine ( xdaq::ApplicationStub *  s  ) 

Definition at line 15 of file StateMachine.cc.

References dispatch(), failurePage(), fsm_, evf::EPStateMachine::init(), statePage(), webConfigure(), webEnable(), webHalt(), webResume(), webSuspend(), and wsm_.

00015                                                  :  
00016   xdaq::Application(s), 
00017   fsm_(getApplicationLogger()) 
00018 {      
00019   wsm_.addState('H', "Halted"   , this, &StateMachine::statePage);
00020   wsm_.addState('R', "Ready"    , this, &StateMachine::statePage);
00021   wsm_.addState('E', "Enabled"  , this, &StateMachine::statePage);
00022   wsm_.addState('S', "Suspended", this, &StateMachine::statePage);
00023   
00024   // Define FSM transitions
00025   wsm_.addStateTransition('H', 'R', "Configure", this,
00026                           &StateMachine::webConfigure, &StateMachine::failurePage);
00027   wsm_.addStateTransition('R', 'E', "Enable", this,
00028                           &StateMachine::webEnable, &StateMachine::failurePage);
00029   wsm_.addStateTransition('E', 'S', "Suspend", this,
00030                           &StateMachine::webSuspend, &StateMachine::failurePage);
00031   wsm_.addStateTransition('S', 'E', "Resume", this,
00032                           &StateMachine::webResume, &StateMachine::failurePage);
00033   wsm_.addStateTransition('H', 'H', "Halt", this,
00034                           &StateMachine::webHalt, &StateMachine::failurePage);
00035   wsm_.addStateTransition('R', 'H', "Halt", this,
00036                           &StateMachine::webHalt, &StateMachine::failurePage);
00037   wsm_.addStateTransition('E', 'H', "Halt", this,
00038                           &StateMachine::webHalt, &StateMachine::failurePage);
00039   wsm_.addStateTransition('S', 'H', "Halt", this,
00040                           &StateMachine::webHalt, &StateMachine::failurePage);
00041   
00042   wsm_.setInitialState('H');
00043   
00044   fsm_.init<dqm::StateMachine>(this);
00045   xgi::bind(this, &StateMachine::dispatch, "dispatch");
00046 }

virtual dqm::StateMachine::~StateMachine (  )  [inline, virtual]

Definition at line 24 of file StateMachine.h.

00024 {}

Member Function Documentation

void StateMachine::bind ( std::string  page  )  [protected]

Definition at line 48 of file StateMachine.cc.

References Default(), and page_.

Referenced by DQMBaseClient::DQMBaseClient().

00049 {
00050   page_ = page;
00051   xgi::bind(this, &StateMachine::Default, page);
00052 }

virtual void dqm::StateMachine::configureAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [pure virtual]

transition methods to be implemented by the application

Implemented in DQMBaseClient.

void dqm::StateMachine::Default ( xgi::Input *  in,
xgi::Output *  out 
) throw (xgi::exception::Exception) [inline, protected]

Reimplemented in DQMBaseClient.

Definition at line 43 of file StateMachine.h.

References out, and wsm_.

Referenced by bind().

00044     {
00045       wsm_.displayPage(out);
00046     }

void dqm::StateMachine::dispatch ( xgi::Input *  in,
xgi::Output *  out 
) throw (xgi::exception::Exception) [inline, protected]

Definition at line 48 of file StateMachine.h.

References fsm_, in, out, evf::EPStateMachine::processFSMCommand(), and wsm_.

Referenced by StateMachine().

00049     {
00050       cgicc::Cgicc cgi(in);
00051       cgi.getEnvironment();
00052       cgicc::const_form_iterator stateInputElement = cgi.getElement("StateInput");
00053       std::string stateInput = (*stateInputElement).getValue();
00054       wsm_.fireEvent(stateInput,in,out);
00055       fsm_.processFSMCommand(stateInput);
00056     }

virtual void dqm::StateMachine::enableAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [pure virtual]

Implemented in DQMBaseClient.

void StateMachine::failurePage ( xgi::Output *  out,
xgi::exception::Exception &  e 
) throw (xgi::exception::Exception) [private]

Definition at line 151 of file StateMachine.cc.

References e, lat::endl(), and out.

Referenced by StateMachine().

00153 {
00154   if(out)
00155     {
00156       *out << cgicc::HTMLDoctype(cgicc::HTMLDoctype::eStrict) << std::endl;
00157       *out << cgicc::html().set("lang", "en").set("dir","ltr") << std::endl;
00158       
00159       xgi::Utils::getPageHeader(*out, "WebStateMachine Home", "Failure");
00160       
00161       
00162       *out << cgicc::br() << e.what() << cgicc::br() << std::endl;
00163       std::string url = "/";
00164       url += getApplicationDescriptor()->getURN();
00165 
00166       *out << cgicc::br() << "<a href=\"" << url << "\">" << "retry" << "</a>" << cgicc::br() << std::endl;
00167       
00168       xgi::Utils::getPageFooter(*out);
00169       
00170     }
00171 }

xoap::MessageReference StateMachine::fireEvent ( xoap::MessageReference  msg  )  throw (xoap::exception::Exception)

Definition at line 54 of file StateMachine.cc.

References alivecheck_mergeAndRegister::body, dbtoconf::command, Exception, fsm_, i, alivecheck_mergeAndRegister::msg, prof2calltree::node, evf::EPStateMachine::processFSMCommand(), and wsm_.

00056 {
00057   xoap::SOAPPart     part      = msg->getSOAPPart();
00058   xoap::SOAPEnvelope env       = part.getEnvelope();
00059   xoap::SOAPBody     body      = env.getBody();
00060   DOMNode            *node     = body.getDOMNode();
00061   DOMNodeList        *bodyList = node->getChildNodes();
00062   DOMNode            *command  = 0;
00063   std::string        commandName;
00064   
00065   for (unsigned int i = 0; i < bodyList->getLength(); i++)
00066     {
00067       command = bodyList->item(i);
00068       
00069       if(command->getNodeType() == DOMNode::ELEMENT_NODE)
00070         {
00071           commandName = xoap::XMLCh2String(command->getLocalName());
00072           wsm_.fireEvent(commandName,0,0);
00073           return fsm_.processFSMCommand(commandName);
00074         }
00075     }
00076   
00077   XCEPT_RAISE(xoap::exception::Exception, "Command not found");
00078 }

virtual void dqm::StateMachine::haltAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [pure virtual]

Implemented in DQMBaseClient.

virtual void dqm::StateMachine::nullAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [pure virtual]

Implemented in DQMBaseClient.

virtual void dqm::StateMachine::resumeAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [pure virtual]

Implemented in DQMBaseClient.

xdata::String* dqm::StateMachine::stateName (  )  [inline, protected]

Definition at line 58 of file StateMachine.h.

References fsm_, and evf::EPStateMachine::stateName_.

00058 {return &fsm_.stateName_;}

void StateMachine::statePage ( xgi::Output *  out  )  throw (xgi::exception::Exception) [private]

Definition at line 83 of file StateMachine.cc.

References lat::endl(), h3, i, iggi_31X_cfg::input, out, page_, and wsm_.

Referenced by StateMachine().

00085 {
00086   if(out)
00087     {
00088       std::string url = "/";
00089       url += getApplicationDescriptor()->getURN();
00090       std::string purl = url + "/" + page_;
00091 
00092       *out << cgicc::HTMLDoctype(cgicc::HTMLDoctype::eStrict) << std::endl;
00093       *out << cgicc::html().set("lang", "en").set("dir","ltr") << std::endl;
00094       *out << "<head>" << std::endl;
00095       *out << "<META HTTP-EQUIV=refresh CONTENT=\"30; URL=";
00096       *out << purl << "\">" << std::endl;
00097       *out << "<META HTTP-EQUIV=Window-target CONTENT=\"_self\">" << std::endl;
00098       *out << "<title> " << "fsm" << "</title>"  << std::endl;
00099       *out << "</head>" << std::endl;
00100       *out << "<body>" << std::endl;
00101       //      xgi::Utils::getPageHeader(*out, "StateMachine", wsm_.getStateName(wsm_.getCurrentState()));
00102       
00103       url += "/dispatch";       
00104       
00105       // display FSM
00106       //      cout << "current state " << wsm_.getCurrentState() << endl;
00107       //      cout << "possible commands" << endl;
00108       std::set<std::string>::iterator i;
00109       std::set<std::string> possibleInputs = wsm_.getInputs(wsm_.getCurrentState());
00110       std::set<std::string> allInputs = wsm_.getInputs();
00111       
00112       //      for ( i = possibleInputs.begin(); i != possibleInputs.end(); i++)
00113       //        cout << (*i) << endl;
00114       
00115       *out << cgicc::h3("Finite State Machine").set("style", "font-family: arial") << std::endl;
00116       *out << "<table border cellpadding=10 cellspacing=0>" << std::endl;
00117       *out << "<tr>" << std::endl;
00118       *out << "<th>" << wsm_.getStateName(wsm_.getCurrentState()) << "</th>" << std::endl;
00119       *out << "</tr>" << std::endl;
00120       *out << "<tr>" << std::endl;
00121 
00122       for ( i = allInputs.begin(); i != allInputs.end(); i++)
00123         {
00124           *out << "<td>"; 
00125           *out << cgicc::form().set("method","post").set("target","_self").set("action", url).set("enctype","multipart/form-data") << std::endl;
00126           
00127           if ( possibleInputs.find(*i) != possibleInputs.end() )
00128             {
00129               *out << cgicc::input().set("type", "submit").set("name", "StateInput").set("value", (*i) );
00130             }
00131           else
00132             {
00133               *out << cgicc::input() .set("type", "submit").set("name", "StateInput").set("value", (*i) ).set("disabled", "true");
00134             }
00135           
00136           *out << cgicc::form();
00137           *out << "</td>" << std::endl;
00138         }
00139       
00140       *out << "</tr>" << std::endl;
00141       *out << "</table>" << std::endl;
00142       *out << cgicc::html();
00143       //        
00144       //      xgi::Utils::getPageFooter(*out);
00145     }
00146 }

virtual void dqm::StateMachine::stopAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [inline, virtual]

Definition at line 31 of file StateMachine.h.

00031 {}; //just a noop to keep the compiler happy for the moment

virtual void dqm::StateMachine::suspendAction ( toolbox::Event::Reference  e  )  throw (toolbox::fsm::exception::Exception) [pure virtual]

Implemented in DQMBaseClient.

void dqm::StateMachine::webConfigure ( xgi::Input *  in  )  throw (xgi::exception::Exception) [inline, private]

Web Events that trigger state changes.

Definition at line 71 of file StateMachine.h.

Referenced by StateMachine().

00072     {
00073       
00074     }

void dqm::StateMachine::webEnable ( xgi::Input *  in  )  throw (xgi::exception::Exception) [inline, private]

Definition at line 76 of file StateMachine.h.

Referenced by StateMachine().

00077     {
00078       
00079       
00080     }

void dqm::StateMachine::webHalt ( xgi::Input *  in  )  throw (xgi::exception::Exception) [inline, private]

Definition at line 91 of file StateMachine.h.

Referenced by StateMachine().

00092     {
00093       
00094       
00095     }

void dqm::StateMachine::webResume ( xgi::Input *  in  )  throw (xgi::exception::Exception) [inline, private]

Definition at line 86 of file StateMachine.h.

Referenced by StateMachine().

00087     {
00088       
00089       
00090     }

void dqm::StateMachine::webSuspend ( xgi::Input *  in  )  throw (xgi::exception::Exception) [inline, private]

Definition at line 81 of file StateMachine.h.

Referenced by StateMachine().

00082     {
00083       
00084       
00085     }

Member Data Documentation

evf::EPStateMachine dqm::StateMachine::fsm_ [private]

Definition at line 100 of file StateMachine.h.

Referenced by dispatch(), fireEvent(), StateMachine(), and stateName().

std::string dqm::StateMachine::page_ [private]

Definition at line 101 of file StateMachine.h.

Referenced by bind(), and statePage().

xgi::WSM dqm::StateMachine::wsm_ [private]

Definition at line 99 of file StateMachine.h.

Referenced by Default(), dispatch(), fireEvent(), StateMachine(), and statePage().

The documentation for this class was generated from the following files:
Generated on Tue Jun 9 18:37:16 2009 for CMSSW by  doxygen 1.5.4