Jpp  18.0.0-rc.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
JDAQCHSM Class Referenceabstract

DAQ state machine interface. More...

#include <JDAQCHSM.hh>

Inheritance diagram for JDAQCHSM:
JDAQStateMachine KM3NETDAQ::JDAQClient AcousticDataFilter JDAQDemoClient KM3NETDAQ::DataQueue KM3NETDAQ::JDAQDriver KM3NETDAQ::JDataFilter KM3NETDAQ::JDataWriter KM3NETDAQ::JDQSimulator KM3NETDAQ::JEventGenerator KM3NETDAQ::MonitorRouter

Classes

class  JDAQState
 DAQ state class. More...
 

Public Member Functions

 JDAQCHSM (CHSM_MACHINE_ARGS, const std::string &__name)
 Constructor. More...
 
const std::string & getName () const
 Get name of state machine. More...
 
int getDetectorID () const
 Get detector identifier. More...
 
int getRunNumber () const
 Get run number. More...
 
virtual void actionEnter ()
 Interface methods for actions corresponding to state transitions. More...
 
virtual void actionExit ()
 
virtual void actionInit (int, const char *)
 
virtual void actionConfigure (int, const char *)
 
virtual void actionStart (int, const char *)
 
virtual void actionPause (int, const char *)
 
virtual void actionContinue (int, const char *)
 
virtual void actionStop (int, const char *)
 
virtual void actionReset (int, const char *)
 
virtual void actionQuit (int, const char *)
 
virtual void actionCheck (int, const char *)
 
virtual void actionInput (int, const char *)
 
virtual void actionError ()
 
virtual void actionRecover (int, const char *)
 
 JDAQCHSM (CHSM_MACHINE_ARGS, const std::string &__name)
 Constructor. More...
 
const std::string & getName () const
 Get name of state machine. More...
 
int getDetectorID () const
 Get detector identifier. More...
 
int getRunNumber () const
 Get run number. More...
 
virtual void actionEnter ()
 Interface methods for actions corresponding to state transitions. More...
 
virtual void actionExit ()
 
virtual void actionInit (int, const char *)
 
virtual void actionConfigure (int, const char *)
 
virtual void actionStart (int, const char *)
 
virtual void actionPause (int, const char *)
 
virtual void actionContinue (int, const char *)
 
virtual void actionStop (int, const char *)
 
virtual void actionReset (int, const char *)
 
virtual void actionQuit (int, const char *)
 
virtual void actionCheck (int, const char *)
 
virtual void actionInput (int, const char *)
 
virtual void actionError ()
 
virtual void actionRecover (int, const char *)
 

Protected Types

typedef void(JDAQCHSM::* action )(int, const char *)
 Type definition of action method. More...
 
typedef void(JDAQCHSM::* action )(int, const char *)
 Type definition of action method. More...
 

Protected Member Functions

virtual void enterState (const CHSM::state &state, const CHSM::event &event)=0
 Action when entering state. More...
 
virtual void execute (action __action, const CHSM::event &__event)=0
 The method to execute the action. More...
 
virtual void enterState (const CHSM::state &state, const CHSM::event &event)=0
 Action when entering state. More...
 
virtual void execute (action __action, const CHSM::event &__event)=0
 The method to execute the action. More...
 

Protected Attributes

std::string name
 
int detector_id
 
int run_number
 

Detailed Description

DAQ state machine interface.

Definition at line 12 of file JDAQCHSM.chsm.

Member Typedef Documentation

typedef void(JDAQCHSM::* JDAQCHSM::action)(int, const char *)
protected

Type definition of action method.

Definition at line 141 of file JDAQCHSM.chsm.

typedef void(JDAQCHSM::* JDAQCHSM::action)(int, const char *)
protected

Type definition of action method.

Definition at line 152 of file JDAQCHSM.hh.

Constructor & Destructor Documentation

JDAQCHSM::JDAQCHSM ( CHSM_MACHINE_ARGS  ,
const std::string &  __name 
)
inline

Constructor.

Parameters
__namename of state machine

Definition at line 65 of file JDAQCHSM.chsm.

65  :
66  CHSM::machine(CHSM_MACHINE_INIT),
67  name (__name),
68  detector_id(-1),
69  run_number (-1)
70  {}
JDAQCHSM::run_number
int run_number
Definition: JDAQCHSM.chsm:156
JDAQCHSM::name
std::string name
Definition: JDAQCHSM.chsm:154
JDAQCHSM::detector_id
int detector_id
Definition: JDAQCHSM.chsm:155
JDAQCHSM::JDAQCHSM ( CHSM_MACHINE_ARGS  ,
const std::string &  __name 
)
inline

Constructor.

Parameters
__namename of state machine

Definition at line 76 of file JDAQCHSM.hh.

76  :
77  CHSM::machine(CHSM_MACHINE_INIT),
78  name (__name),
79  detector_id(-1),
80  run_number (-1)
81  {}
JDAQCHSM::run_number
int run_number
Definition: JDAQCHSM.chsm:156
JDAQCHSM::name
std::string name
Definition: JDAQCHSM.chsm:154
JDAQCHSM::detector_id
int detector_id
Definition: JDAQCHSM.chsm:155

Member Function Documentation

const std::string& JDAQCHSM::getName ( ) const
inline

Get name of state machine.

Returns
name

Definition at line 78 of file JDAQCHSM.chsm.

79  {
80  return name;
81  }
JDAQCHSM::name
std::string name
Definition: JDAQCHSM.chsm:154
int JDAQCHSM::getDetectorID ( ) const
inline

Get detector identifier.

Returns
detector identifier.

Definition at line 89 of file JDAQCHSM.chsm.

90  {
91  return detector_id;
92  }
JDAQCHSM::detector_id
int detector_id
Definition: JDAQCHSM.chsm:155
int JDAQCHSM::getRunNumber ( ) const
inline

Get run number.

Returns
run number

Definition at line 100 of file JDAQCHSM.chsm.

101  {
102  return run_number;
103  }
JDAQCHSM::run_number
int run_number
Definition: JDAQCHSM.chsm:156
virtual void JDAQCHSM::actionEnter ( )
inlinevirtual

Interface methods for actions corresponding to state transitions.

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::DataQueue, JDAQDemoClient, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 109 of file JDAQCHSM.chsm.

109 {}
virtual void JDAQCHSM::actionExit ( )
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDAQDriver, KM3NETDAQ::DataQueue, JDAQDemoClient, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 110 of file JDAQCHSM.chsm.

110 {}
virtual void JDAQCHSM::actionInit ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDataWriter, KM3NETDAQ::DataQueue, JDAQDemoClient, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 112 of file JDAQCHSM.chsm.

112 {}
virtual void JDAQCHSM::actionConfigure ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::DataQueue, AcousticDataFilter, KM3NETDAQ::MonitorRouter, and KM3NETDAQ::JEventGenerator.

Definition at line 113 of file JDAQCHSM.chsm.

113 {}
virtual void JDAQCHSM::actionStart ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDAQDriver, KM3NETDAQ::JDQSimulator, KM3NETDAQ::DataQueue, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 114 of file JDAQCHSM.chsm.

114 {}
virtual void JDAQCHSM::actionPause ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::DataQueue, JDAQDemoClient, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 115 of file JDAQCHSM.chsm.

115 {}
virtual void JDAQCHSM::actionContinue ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::DataQueue, JDAQDemoClient, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 116 of file JDAQCHSM.chsm.

116 {}
virtual void JDAQCHSM::actionStop ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDAQDriver, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JDataWriter, KM3NETDAQ::DataQueue, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 117 of file JDAQCHSM.chsm.

117 {}
virtual void JDAQCHSM::actionReset ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::DataQueue, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 118 of file JDAQCHSM.chsm.

118 {}
virtual void JDAQCHSM::actionQuit ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::DataQueue, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 119 of file JDAQCHSM.chsm.

119 {}
virtual void JDAQCHSM::actionCheck ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDAQClient.

Definition at line 121 of file JDAQCHSM.chsm.

121 {}
virtual void JDAQCHSM::actionInput ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDAQClient, KM3NETDAQ::DataQueue, and AcousticDataFilter.

Definition at line 122 of file JDAQCHSM.chsm.

122 {}
virtual void JDAQCHSM::actionError ( )
inlinevirtual

Definition at line 124 of file JDAQCHSM.chsm.

124 {}
virtual void JDAQCHSM::actionRecover ( int  ,
const char *   
)
inlinevirtual

Definition at line 125 of file JDAQCHSM.chsm.

125 {}
virtual void JDAQCHSM::enterState ( const CHSM::state &  state,
const CHSM::event &  event 
)
protectedpure virtual

Action when entering state.

Parameters
stateentered state
eventevent that triggered transition

Implemented in KM3NETDAQ::JDAQClient, and KM3NETDAQ::JDAQDriver.

virtual void JDAQCHSM::execute ( action  __action,
const CHSM::event &  __event 
)
protectedpure virtual

The method to execute the action.

This method shall be implemented in the derived class.

Parameters
__actionpointer to action method
__eventevent that triggered the action

Implemented in KM3NETDAQ::JDAQClient.

const std::string& JDAQCHSM::getName ( ) const
inline

Get name of state machine.

Returns
name

Definition at line 89 of file JDAQCHSM.hh.

90  {
91  return name;
92  }
JDAQCHSM::name
std::string name
Definition: JDAQCHSM.chsm:154
int JDAQCHSM::getDetectorID ( ) const
inline

Get detector identifier.

Returns
detector identifier.

Definition at line 100 of file JDAQCHSM.hh.

101  {
102  return detector_id;
103  }
JDAQCHSM::detector_id
int detector_id
Definition: JDAQCHSM.chsm:155
int JDAQCHSM::getRunNumber ( ) const
inline

Get run number.

Returns
run number

Definition at line 111 of file JDAQCHSM.hh.

112  {
113  return run_number;
114  }
JDAQCHSM::run_number
int run_number
Definition: JDAQCHSM.chsm:156
virtual void JDAQCHSM::actionEnter ( )
inlinevirtual

Interface methods for actions corresponding to state transitions.

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::DataQueue, JDAQDemoClient, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 120 of file JDAQCHSM.hh.

120 {}
virtual void JDAQCHSM::actionExit ( )
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDAQDriver, KM3NETDAQ::DataQueue, JDAQDemoClient, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 121 of file JDAQCHSM.hh.

121 {}
virtual void JDAQCHSM::actionInit ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDataWriter, KM3NETDAQ::DataQueue, JDAQDemoClient, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 123 of file JDAQCHSM.hh.

123 {}
virtual void JDAQCHSM::actionConfigure ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::DataQueue, AcousticDataFilter, KM3NETDAQ::MonitorRouter, and KM3NETDAQ::JEventGenerator.

Definition at line 124 of file JDAQCHSM.hh.

124 {}
virtual void JDAQCHSM::actionStart ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDAQDriver, KM3NETDAQ::JDQSimulator, KM3NETDAQ::DataQueue, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 125 of file JDAQCHSM.hh.

125 {}
virtual void JDAQCHSM::actionPause ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::DataQueue, JDAQDemoClient, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 126 of file JDAQCHSM.hh.

126 {}
virtual void JDAQCHSM::actionContinue ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::DataQueue, JDAQDemoClient, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 127 of file JDAQCHSM.hh.

127 {}
virtual void JDAQCHSM::actionStop ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDAQDriver, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JDataWriter, KM3NETDAQ::DataQueue, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 128 of file JDAQCHSM.hh.

128 {}
virtual void JDAQCHSM::actionReset ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::DataQueue, AcousticDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 129 of file JDAQCHSM.hh.

129 {}
virtual void JDAQCHSM::actionQuit ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDataFilter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::DataQueue, KM3NETDAQ::JDataWriter, JDAQDemoClient, KM3NETDAQ::JEventGenerator, KM3NETDAQ::MonitorRouter, and AcousticDataFilter.

Definition at line 130 of file JDAQCHSM.hh.

130 {}
virtual void JDAQCHSM::actionCheck ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDAQClient.

Definition at line 132 of file JDAQCHSM.hh.

132 {}
virtual void JDAQCHSM::actionInput ( int  ,
const char *   
)
inlinevirtual

Reimplemented in KM3NETDAQ::JDAQClient, KM3NETDAQ::DataQueue, and AcousticDataFilter.

Definition at line 133 of file JDAQCHSM.hh.

133 {}
virtual void JDAQCHSM::actionError ( )
inlinevirtual

Definition at line 135 of file JDAQCHSM.hh.

135 {}
virtual void JDAQCHSM::actionRecover ( int  ,
const char *   
)
inlinevirtual

Definition at line 136 of file JDAQCHSM.hh.

136 {}
virtual void JDAQCHSM::enterState ( const CHSM::state &  state,
const CHSM::event &  event 
)
protectedpure virtual

Action when entering state.

Parameters
stateentered state
eventevent that triggered transition

Implemented in KM3NETDAQ::JDAQClient, and KM3NETDAQ::JDAQDriver.

virtual void JDAQCHSM::execute ( action  __action,
const CHSM::event &  __event 
)
protectedpure virtual

The method to execute the action.

This method shall be implemented in the derived class.

Parameters
__actionpointer to action method
__eventevent that triggered the action

Implemented in KM3NETDAQ::JDAQClient.

Member Data Documentation

std::string JDAQCHSM::name
protected

Definition at line 154 of file JDAQCHSM.chsm.

int JDAQCHSM::detector_id
protected

Definition at line 155 of file JDAQCHSM.chsm.

int JDAQCHSM::run_number
protected

Definition at line 156 of file JDAQCHSM.chsm.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5