Jpp  19.1.0
the software that should make you happy
Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
KM3NETDAQ::JDAQClient Class Reference

Control unit client base class. More...

#include <JDAQClient.hh>

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

Public Member Functions

 JDAQClient (const std::string &name, const std::string &server, JLogger *logger, const int level)
 Constructor. More...
 
 JDAQClient (const std::string &name, JLogger *logger, const int level)
 Constructor. More...
 
 JDAQClient (const std::string &name)
 Constructor. More...
 
virtual bool enter (const JArgs &args)
 Enter the state machine. More...
 
virtual bool enter () override
 Enter the state machine. More...
 
virtual bool exit () override
 Exit the state machine. More...
 
bool isRunning () const
 Check if this client is in runnig state. More...
 
void replaceEvent (const JTag &oldTag, const JTag &newTag, JDAQEvent_t &event)
 Replace tag of given event in event table. More...
 
JDAQEvent_tfindEvent (const JTag &tag, const std::string &event_name)
 Find event in event table. More...
 
void addSubscription (const JSubscription &subscription)
 Add custom subscription. More...
 
template<class T >
void addParameter (const char option, T &parameter)
 Add parameter to parser used in method enter(). More...
 
template<class T >
void addParameter (const char option, T &parameter, const T &value)
 Add parameter to parser used in method enter(). More...
 
void setSelect ()
 Set the file descriptor mask for the select call. More...
 
virtual void setSelect (JFileDescriptorMask &mask) const
 Set the file descriptor mask for the select call. More...
 
virtual void actionSelect (const JFileDescriptorMask &mask)
 Action method following last select call. More...
 
virtual void actionRunning ()
 This method is repeatedly called when this client machine is in state Running and the clock interval time is non-zero. More...
 
virtual void actionInput (int length, const char *buffer) override
 This method is called at ev_input. More...
 
virtual bool filter (const JTag &tag, int length, const char *buffer)
 Filter message. More...
 
virtual void actionTagged (const JTag &tag, int length, const char *buffer)
 This method is called when a custom tag is encountered. More...
 
void run ()
 Run as run control client following command messages via JNET::JControlHost. More...
 
void run (const int port)
 Run for ever. More...
 
void run (std::istream &in)
 Run client with commands from input stream (e.g. for debugging). More...
 
void A1 (CHSM_ns_alias::event const &)
 
void A2 (CHSM_ns_alias::event const &)
 
void A3 (CHSM_ns_alias::event const &)
 
void A4 (CHSM_ns_alias::event const &)
 
void A5 (CHSM_ns_alias::event const &)
 
void A6 (CHSM_ns_alias::event const &)
 
void A7 (CHSM_ns_alias::event const &)
 
void A8 (CHSM_ns_alias::event const &)
 
void A9 (CHSM_ns_alias::event const &)
 
void A10 (CHSM_ns_alias::event const &)
 
void A11 (CHSM_ns_alias::event const &)
 
void A12 (CHSM_ns_alias::event const &)
 
void A13 (CHSM_ns_alias::event const &)
 
void A14 (CHSM_ns_alias::event const &)
 
void EAM4root (CHSM_ns_alias::state const &, CHSM_ns_alias::event const &)
 
void XAM4root (CHSM_ns_alias::state const &, CHSM_ns_alias::event const &)
 
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 actionError ()
 
virtual void actionRecover (int, const char *)
 
const std::string & getHostname () const
 Get hostname. More...
 
const std::string & getFullName () const
 Get full name of this run control client. More...
 
const JTaggetUniqueTag () const
 Get unique tag of this run control client. More...
 
long long int getClockDelay () const
 Get total delay time. More...
 
long long int getClockInterval () const
 Get interval time. More...
 
void setClockInterval (const long long int interval_us)
 Set interval time. More...
 
void resetClock ()
 Reset clock. More...
 
const std::string & getEventInfo () const
 Get last event information. More...
 
void setEventInfo (const std::string &info)
 Set last event information. More...
 

Public Attributes

JDAQStateMachine::state_root root
 
JDAQStateMachine::state_Main Main
 
JDAQStateMachine::ev_daq_event ev_daq
 
char ev_daq_param_block [sizeof(ev_daq_event::param_block)]
 
JDAQStateMachine::ev_init_event ev_init
 
char ev_init_param_block [sizeof(ev_init_event::param_block)]
 
JDAQStateMachine::ev_configure_event ev_configure
 
char ev_configure_param_block [sizeof(ev_configure_event::param_block)]
 
JDAQStateMachine::ev_start_event ev_start
 
char ev_start_param_block [sizeof(ev_start_event::param_block)]
 
JDAQStateMachine::ev_pause_event ev_pause
 
char ev_pause_param_block [sizeof(ev_pause_event::param_block)]
 
JDAQStateMachine::ev_continue_event ev_continue
 
char ev_continue_param_block [sizeof(ev_continue_event::param_block)]
 
JDAQStateMachine::ev_stop_event ev_stop
 
char ev_stop_param_block [sizeof(ev_stop_event::param_block)]
 
JDAQStateMachine::ev_reset_event ev_reset
 
char ev_reset_param_block [sizeof(ev_reset_event::param_block)]
 
JDAQStateMachine::ev_quit_event ev_quit
 
char ev_quit_param_block [sizeof(ev_quit_event::param_block)]
 
JDAQStateMachine::ev_off_event ev_off
 
char ev_off_param_block [sizeof(ev_off_event::param_block)]
 
JDAQStateMachine::ev_check_event ev_check
 
char ev_check_param_block [sizeof(ev_check_event::param_block)]
 
JDAQStateMachine::ev_input_event ev_input
 
char ev_input_param_block [sizeof(ev_input_event::param_block)]
 
JDAQStateMachine::ev_recover_event ev_recover
 
char ev_recover_param_block [sizeof(ev_recover_event::param_block)]
 
JDAQStateMachine::ev_error_event ev_error
 
char ev_error_param_block [sizeof(ev_error_event::param_block)]
 

Static Public Attributes

static const int TIMEOUT_S = 1
 time out of update [s] More...
 

Protected Types

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

Protected Attributes

JSharedPointer< JControlHostserver
 message server More...
 
JMessageLogger logger
 message logger More...
 
std::string name
 
int detector_id
 
int run_number
 
JEventTable eventTable
 event table More...
 
std::string hostname
 
std::string fullname
 
JTag unique_tag
 
JTimekeeper clock
 central clock More...
 
std::string event_info
 event information More...
 

Private Member Functions

void update ()
 Update state machine. More...
 
void update (const JTag &tag, int length, const char *buffer)
 Update state machine. More...
 
void configure ()
 Configure client. More...
 
std::string getMessage (const CHSM::state &state, const CHSM::event &event) const
 Get event message. More...
 
virtual void enterState (const CHSM::state &state, const CHSM::event &event) override
 Action when entering state. More...
 
virtual void actionCheck (int length, const char *buffer) override
 This method is called at ev_check and reports a system check by mimicing an enter state action. More...
 
void execute (action __action, const CHSM::event &__event) override
 The method to execute the action. More...
 
const CHSM::state * getState () const
 Get current state. More...
 

Private Attributes

JSelectReader select
 select call More...
 
JParser parser
 parser method enter() More...
 
JSubscriptionList subscription
 custom subscription More...
 
CHSM_ns_alias::state * state_ [11]
 
CHSM_ns_alias::event const * taken_ [14]
 
CHSM_ns_alias::state * target_ [14]
 

Static Private Attributes

static int const ev_daq_transitions []
 
static int const ev_init_transitions []
 
static int const ev_configure_transitions []
 
static int const ev_start_transitions []
 
static int const ev_pause_transitions []
 
static int const ev_continue_transitions []
 
static int const ev_stop_transitions []
 
static int const ev_reset_transitions []
 
static int const ev_quit_transitions []
 
static int const ev_off_transitions []
 
static int const ev_check_transitions []
 
static int const ev_input_transitions []
 
static int const ev_recover_transitions []
 
static int const ev_error_transitions []
 
static CHSM_ns_alias::transition const transition_ []
 

Detailed Description

Control unit client base class.

This base class implements the protocol for the communication with the control unit.
This protocol is based on ControlHost tags and CHSM event names.
Normally, the primary input is provided to the constructor of this base class, e.g. via command line options of the application based on a derived class hereof.
By calling the default method enter(),

The method run() can then be used to process command messages which will acoordingly update the state machine.
For each state transition, a corresponding action method is called which could be re-implemented in the derived class (see JDAQCHSM).
Optionally, a designated action method is repeatedly called in state Running.

A state transition is triggered by a valid command message.
The command message consists of a tag and some contents.
The tag can be used to address all processes, a group of processes or an individual process.
The contents of a command message must start with the name on the event and can contain additional data (separated by KM3NETDAQ::TOKEN_DELIMETER).
A successful transition is certified by a reply message which is sent upon entering the targeted state.
The reply message has tag "RC_REPLY" and the contents include the names of the original event as well as that of the final state.
Optionally, information can be added to an event (separated by KM3NETDAQ::EVENTNAME_DELIMETER).
This information is included in the following reply messages, until there is a command message with (other) information.

Following a request for a state transition via a command message, four scenarios should be anticipated, namely:

  1. the process successfully completed the transition, a corresponding reply message is then send back;
  2. the process couldn't make the transition and goes to error state, a corresponding reply message is then send back,
  3. the process crashed, the process disappears from the process list and the server broadcasts a corresponding died message;
  4. the process takes longer than foreseen, leading to a timeout.

The followup action after a timeout should be customised.
In case of an invalid command message (e.g. request for a state transition that does not exist), no reply message will be sent.
Instead, a message with tag "RC_FAIL" is sent.

The default list of tags includes "RC_CMD" and a client specific tag.
The latter is composed of the hexadecimal formatted IP sub-address of the client's host CPU (see JSYSTEM::getSubaddress(const int)) and
the client's name extension (part following KM3NETDAQ::CLIENTNAME_DELIMETER), if any.
The list of tags and the various delimiters are maintained in include file JDAQTags.hh.

For client specific events requiring a different tag, the corresponding entry in the event table should be replaced.
This should be done in the constructor of the derived class using method replaceEvent().

The virtual method filter() can be re-implemented so that a specific action is made before the corresponding message is processed.
The message is ignored if this method returns true, else it is normally processed.

The method setSelect() can be used to set the file descriptor mask of the general select call.
In conjunction, the method actionSelect() can be used to take client specific actions following the select call.

If the clock interval is non-zero, the method actionRunning() is repeatedly called according the specified interval time when the client is in state Running.
The clock interval can be set using method setClockInterval().

Some input can be redefined during operation.
For example the debug level can be set via the following command message.

  JPutMessage -H <host name> -t <tag> -m "debug=\<level\>;"

where

In this, the tag "RC_CMD" applies to all applications and the client specific tag to an individual application.

Additional custom tags can be added to the general list using method addSubscription().
The method actionTagged() is then called when a command message is received with the specified tag.

For tests and possible other setups, the base class can be configured to run stand-alone or forever.
In stand-alone mode, the client can be steered from an regular input stream.
When the client runs forever, it waits for a connection before going to the normal mode of operation.
The primary input should then be sent via this connection.
The method addParameter() can be used to add parameters of the derived class to the list that is parsed in method enter().

Definition at line 298 of file JDAQClient.hh.

Member Typedef Documentation

◆ action

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

Type definition of action method.

Definition at line 152 of file JDAQCHSM.hh.

Constructor & Destructor Documentation

◆ JDAQClient() [1/3]

KM3NETDAQ::JDAQClient::JDAQClient ( const std::string &  name,
const std::string &  server,
JLogger logger,
const int  level 
)
inline

Constructor.

This constructor should be used in normal mode.
The following methods methods should subsequently be called.

Parameters
namename of client
servername of command message server
loggerpointer to logger
leveldebug level

Definition at line 319 of file JDAQClient.hh.

322  :
324  JDAQClient_t (this)
325  {
326  this->logger = JMessageLogger(logger, name, level);
327 
328  try {
329  this->server.reset(new JControlHost(server));
330  }
331  catch(const std::exception& error) {
332  JErrorStream(this->logger) << error.what();
333  }
334 
335  std::string buffer;
336 
338 
339  if (buffer != "") {
340  JErrorStream(this->logger) << "Process with nick name \"" << getFullName() << "\" already running on host(s) " << buffer;
341  }
342  }
std::string name
Definition: JDAQCHSM.hh:165
JDAQStateMachine(const std ::string)
Definition: JDAQCHSM.cc:300
ControlHost class.
static int WhereIs(const std::string &host_name, const std::string &nick_name, std::string &answer)
Locate ControlHost client(s).
JSharedPointer< JControlHost > server
message server
Definition: JDAQClient.hh:834
JMessageLogger logger
message logger
Definition: JDAQClient.hh:835
const std::string & getFullName() const
Get full name of this run control client.
Definition: JDAQClient.hh:120
JDAQClient_t(JDAQStateMachine *chsm)
Constructor.
Definition: JDAQClient.hh:71

◆ JDAQClient() [2/3]

KM3NETDAQ::JDAQClient::JDAQClient ( const std::string &  name,
JLogger logger,
const int  level 
)
inline

Constructor.

This constructor should be used when running stand-alone.
The following methods methods should subsequently be called.

Parameters
namename of client
loggerpointer to logger
leveldebug level

Definition at line 357 of file JDAQClient.hh.

359  :
361  JDAQClient_t (this)
362  {
363  this->logger = JMessageLogger(logger, name, level);
364  }

◆ JDAQClient() [3/3]

KM3NETDAQ::JDAQClient::JDAQClient ( const std::string &  name)
inline

Constructor.

This constructor should be used when running forever.
The following method should subsequently be called.

Parameters
namename of client

Definition at line 376 of file JDAQClient.hh.

376  :
378  JDAQClient_t (this)
379  {}

Member Function Documentation

◆ enter() [1/2]

virtual bool KM3NETDAQ::JDAQClient::enter ( const JArgs args)
inlinevirtual

Enter the state machine.

This overloaded method enter reproduces the constructor. All necessary input is parsed from the list of arguments. In case of an error, the state machine is not entered.

Parameters
argsarray of command line arguments
Returns
true if okay; else false

Definition at line 392 of file JDAQClient.hh.

393  {
394  using namespace std;
395 
396  string server;
397  string logger;
398  int level;
399  bool use_cout;
400 
401  try {
402 
403  parser['H'] = make_field(server) = "localhost";
404  parser['M'] = make_field(logger) = "localhost";
405  parser['d'] = make_field(level) = 0;
406  parser['c'] = make_field(use_cout);
407 
408  if (parser.read(args) != 0) {
409  return false;
410  }
411  }
412  catch(const std::exception &error) {
413  cerr << error.what() << endl;
414  return false;
415  }
416 
417  try {
418 
419  JLogger* out = NULL;
420 
421  if (use_cout)
422  out = new JStreamLogger(cout);
423  else
424  out = new JControlHostLogger(logger);
425 
426  this->logger = JMessageLogger(out, getName(), level);
427 
428  this->server.reset(new JControlHost(server));
429 
430  return enter();
431  }
432  catch(const std::exception& error) {
433  cerr << error.what() << endl;
434  return false;
435  }
436  }
#define make_field(A,...)
macro to convert parameter to JParserTemplateElement object
Definition: JParser.hh:2142
const std::string & getName() const
Get name of state machine.
Definition: JDAQCHSM.hh:89
Message logging based on ControlHost.
Interface for logging messages.
Definition: JLogger.hh:22
Message logging based on std::ostream.
int read(const int argc, const char *const argv[])
Parse the program's command line options.
Definition: JParser.hh:1992
JParser parser
parser method enter()
Definition: JDAQClient.hh:1065
virtual bool enter() override
Enter the state machine.
Definition: JDAQClient.hh:447
Definition: JSTDTypes.hh:14

◆ enter() [2/2]

virtual bool KM3NETDAQ::JDAQClient::enter ( )
inlineoverridevirtual

Enter the state machine.

This method activates the subscription to JNET::JControlHost messages. In case of an error, the state machine is not entered.

Returns
true if okay; else false

Reimplemented in KM3NETDAQ::JDAQDriver.

Definition at line 447 of file JDAQClient.hh.

448  {
449  using namespace std;
450  using namespace JPP;
451 
452  if (server.is_valid() && logger.is_valid()) {
453 
455 
456  try {
457 
458  server->Subscribe(buffer);
459  server->SendMeAlways();
460  server->MyId(getFullName());
461 
462  JStatusStream(logger) << "Process with nick name \"" << getFullName() << "\" version \"" << getGITVersion() << "\" subscription: " << buffer.toString();
463 
464  return CHSM::machine::enter();
465  }
466  catch(const std::exception& error) {
467  JErrorStream(logger) << error.what();
468  }
469 
470  } else {
471  cerr << "Message server or logger not properly initialised." << endl;
472  }
473 
474  return false;
475  }
bool is_valid() const
Check validity of logger object.
Subscription list.
std::string toString() const
Convert subscription list to string.
JSubscriptionList subscription
custom subscription
Definition: JDAQClient.hh:1066
std::string getGITVersion(const std::string &tag)
Get GIT version for given GIT tag.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
JSubscriptionList getSubscription(const JEventTable &event_table)
Convert event table to ControlHost subscription.
Definition: JEventTable.hh:129
JEventTable eventTable
event table
Definition: JDAQClient.hh:203

◆ exit()

virtual bool KM3NETDAQ::JDAQClient::exit ( )
inlineoverridevirtual

Exit the state machine.

This method releases the various resources.

Returns
true if okay; else false

Definition at line 485 of file JDAQClient.hh.

486  {
487  try {
488  if (server.is_valid()) { server.reset(NULL); }
489  }
490  catch(const std::exception& error) {
491  }
492 
493  try {
494  if (logger.is_valid()) { logger.reset(NULL); }
495  }
496  catch(const std::exception& error) {
497  }
498 
499  return CHSM::machine::exit();
500  }
void reset(JLogger *__logger=NULL)
Reset logger.

◆ isRunning()

bool KM3NETDAQ::JDAQClient::isRunning ( ) const
inline

Check if this client is in runnig state.

Returns
true if running; else false

Definition at line 508 of file JDAQClient.hh.

509  {
510  return Main.RunControl.Operational.Running.active();
511  }
JDAQStateMachine::state_Main::state_RunControl::state_Operational Operational
JDAQStateMachine::state_Main::state_RunControl RunControl
JDAQStateMachine::state_Main Main

◆ replaceEvent()

void KM3NETDAQ::JDAQClient::replaceEvent ( const JTag oldTag,
const JTag newTag,
JDAQEvent_t event 
)
inline

Replace tag of given event in event table.

Parameters
oldTagold tag
newTagnew tag
eventevent

Definition at line 521 of file JDAQClient.hh.

524  {
525  eventTable.replace(oldTag, newTag, event);
526  }
void replace(const JTag &oldTag, const JTag &newTag, JDAQEvent_t &event)
Replace entry in table.
Definition: JEventTable.hh:96

◆ findEvent()

JDAQEvent_t* KM3NETDAQ::JDAQClient::findEvent ( const JTag tag,
const std::string &  event_name 
)
inline

Find event in event table.

Parameters
tagtag
event_nameevent name
Returns
pointer to event or NULL

Definition at line 536 of file JDAQClient.hh.

537  {
538  JEventTable::const_iterator i = eventTable.find(tag, event_name);
539 
540  if (i != eventTable.end())
541  return i->second;
542  else
543  return NULL;
544  }
const_iterator find(const JTag &tag, const std::string &event_name) const
Find entry.
Definition: JEventTable.hh:116

◆ addSubscription()

void KM3NETDAQ::JDAQClient::addSubscription ( const JSubscription subscription)
inline

Add custom subscription.

Parameters
subscriptionsubscription

Definition at line 552 of file JDAQClient.hh.

553  {
554  this->subscription.add(subscription);
555  }

◆ addParameter() [1/2]

template<class T >
void KM3NETDAQ::JDAQClient::addParameter ( const char  option,
T &  parameter 
)
inline

Add parameter to parser used in method enter().

Parameters
optionoption
parameterparameter

Definition at line 565 of file JDAQClient.hh.

566  {
567  parser[option] = make_field(parameter);
568  }

◆ addParameter() [2/2]

template<class T >
void KM3NETDAQ::JDAQClient::addParameter ( const char  option,
T &  parameter,
const T &  value 
)
inline

Add parameter to parser used in method enter().

Parameters
optionoption
parameterparameter
valuedefault value

Definition at line 579 of file JDAQClient.hh.

580  {
581  parser[option] = make_field(parameter) = value;
582  }

◆ setSelect() [1/2]

void KM3NETDAQ::JDAQClient::setSelect ( )
inline

Set the file descriptor mask for the select call.

Definition at line 588 of file JDAQClient.hh.

589  {
590  select.reset();
591 
593 
595  }
void setReaderMask(const JAbstractFile &file)
Set reader mask.
void reset()
Reset.
JFileDescriptorMask & getReaderMask()
Get reader mask.
JSelectReader select
select call
Definition: JDAQClient.hh:1064
void setSelect()
Set the file descriptor mask for the select call.
Definition: JDAQClient.hh:588

◆ setSelect() [2/2]

virtual void KM3NETDAQ::JDAQClient::setSelect ( JFileDescriptorMask mask) const
inlinevirtual

Set the file descriptor mask for the select call.

This implementation does nothing but may be redefined by the derived class.

Parameters
maskfile descriptor mask

Reimplemented in KM3NETDAQ::JDataWriter, KM3NETDAQ::JDataFilter, and KM3NETDAQ::MonitorRouter.

Definition at line 604 of file JDAQClient.hh.

605  {}

◆ actionSelect()

virtual void KM3NETDAQ::JDAQClient::actionSelect ( const JFileDescriptorMask mask)
inlinevirtual

Action method following last select call.

This implementation does nothing but may be redefined by the derived class.

Parameters
maskfile descriptor mask

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

Definition at line 614 of file JDAQClient.hh.

615  {}

◆ actionRunning()

virtual void KM3NETDAQ::JDAQClient::actionRunning ( )
inlinevirtual

This method is repeatedly called when this client machine is in state Running and the clock interval time is non-zero.

This implementation does nothing but may be redefined by the derived class. Care has to be taken so that the time needed to execute this method should be less than the specified clock interval time (see method setClockInterval()).

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

Definition at line 625 of file JDAQClient.hh.

626  {}

◆ actionInput()

virtual void KM3NETDAQ::JDAQClient::actionInput ( int  length,
const char *  buffer 
)
inlineoverridevirtual

This method is called at ev_input.

Parameters
lengthlength of data
bufferpointer to data

Reimplemented from JDAQCHSM.

Reimplemented in KM3NETDAQ::DataQueue.

Definition at line 635 of file JDAQClient.hh.

636  {
637  using namespace std;
638 
639  JProperties properties(JEquationParameters("=", ";", "", ""), 1);
640 
641  int level = this->logger.getLevel();
642 
643  properties["debug"] = level;
644 
645  properties.read(string(buffer, length));
646 
647  this->logger.setLevel(level);
648  }
Utility class to parse parameter values.
Definition: JProperties.hh:501
Simple data structure to support I/O of equations (see class JLANG::JEquation).
JLevel_t getLevel()
Get debug level.
void setLevel(const int __level)
Set debug level.

◆ filter()

virtual bool KM3NETDAQ::JDAQClient::filter ( const JTag tag,
int  length,
const char *  buffer 
)
inlinevirtual

Filter message.

The filter method can be overwritten so that a specific action is made before the corresponding message is processed by the state machine. The message is ignored if true is returned, else it is normally processed.

Parameters
tagtag
lengthnumber of characters
buffermessage
Returns
skip message or not

Definition at line 662 of file JDAQClient.hh.

663  {
664  return false;
665  }

◆ actionTagged()

virtual void KM3NETDAQ::JDAQClient::actionTagged ( const JTag tag,
int  length,
const char *  buffer 
)
inlinevirtual

This method is called when a custom tag is encountered.

Parameters
tagtag
lengthlength of data
bufferpointer to data

Reimplemented in KM3NETDAQ::JDataFilter.

Definition at line 675 of file JDAQClient.hh.

676  {
677  }

◆ run() [1/3]

void KM3NETDAQ::JDAQClient::run ( )
inline

Run as run control client following command messages via JNET::JControlHost.

This method can be called once the state machine is entered. It returns when the state machine is exited. If the clock interval is non-zero, the method actionRunning() is repeatedly called when this client machine is in state Running. The file descriptor mask can be set to interrupt the timeout of the select call and clock method wait() in this calling sequence (see methods setSelect() and actionSelect()).

Definition at line 690 of file JDAQClient.hh.

691  {
692  using namespace std;
693  using namespace JPP;
694 
695  while (active()) {
696 
697  try {
698 
699  setSelect();
700 
701  if (select(JTimeval(TIMEOUT_S,0)) > 0) {
702 
703  if (select.hasReaderMask(*server)) {
704  update();
705  }
706 
708 
709  } else {
710 
711  continue;
712  }
713 
714 
715  if (isRunning() && clock.getInterval() != 0LL) {
716 
717  long long int numberOfCalls = 0;
718 
719  clock.reset();
720 
721  do {
722 
723  ++numberOfCalls;
724 
725  setSelect();
726 
727  if (clock.wait(select.getReaderMask())) {
728 
729  if (select.hasReaderMask(*server)) {
730  update();
731  }
732 
734 
735  } else {
736 
737  try {
738  actionRunning();
739  }
740  catch(const std::exception& error) {
741  logger.error(error.what());
742  }
743  }
744 
745  } while (isRunning());
746 
747  if (numberOfCalls != 0) {
748  JNoticeStream(logger) << "Delay per call " << clock.getDelay() / numberOfCalls / 1000 << " ms";
749  }
750  }
751  }
752  catch(const JPP::JSocketException& error) {
753  JErrorStream(logger) << "method run(): \"" << error.what() << "\" -> trigger ev_error.";
754  ev_error();
755  }
756  catch(const std::exception& error) {
757  JErrorStream(logger) << "method run(): \"" << error.what() << "\"";
758  }
759  }
760  }
JDAQStateMachine::ev_error_event ev_error
long long int getDelay() const
Get total delay time.
Definition: JTimekeeper.hh:78
void wait() const
Wait until the number of time intervals has elapsed since the last call to the reset method.
Definition: JTimekeeper.hh:145
void reset(const long long int t0)
Reset time.
Definition: JTimekeeper.hh:100
long long int getInterval() const
Get interval time.
Definition: JTimekeeper.hh:67
virtual const char * what() const override
Get error message.
Definition: JException.hh:64
Exception for socket.
Definition: JException.hh:468
Auxiliary class for time values.
Definition: JTimeval.hh:29
void error(const JMessage_t &message)
bool hasReaderMask(const JAbstractFile &file) const
Has reader file.
bool isRunning() const
Check if this client is in runnig state.
Definition: JDAQClient.hh:508
void update()
Update state machine.
Definition: JDAQClient.hh:842
virtual void actionSelect(const JFileDescriptorMask &mask)
Action method following last select call.
Definition: JDAQClient.hh:614
virtual void actionRunning()
This method is repeatedly called when this client machine is in state Running and the clock interval ...
Definition: JDAQClient.hh:625
JTimekeeper clock
central clock
Definition: JDAQClient.hh:207
static const int TIMEOUT_S
time out of update [s]
Definition: JDAQClient.hh:63

◆ run() [2/3]

void KM3NETDAQ::JDAQClient::run ( const int  port)
inline

Run for ever.

This method can be used when the run control client is started before the run control (e.g. at boot time of the host processor). This method should be called before the state machine is entered. It launches a server which accepts a JNET::JControlHost connection from a designated application e.g. the JDAQClientStarter.cc program. The state machine is entered using the available data in the JNET::JControlHost message. After the state machine is exited, it accepts a new a JNET::JControlHost connection.

Parameters
portport number

Definition at line 775 of file JDAQClient.hh.

776  {
777  JControlHostServer local_server(port);
778 
779  for ( ; ; ) {
780 
781  JControlHost* ps = local_server.AcceptClient();
782 
783  ps->Connected();
784 
785  JNET::JPrefix prefix;
786 
787  ps->WaitHead(prefix);
788 
789  const int length = prefix.getSize();
790 
791  char* buffer = new char[length];
792 
793  ps->GetFullData(buffer, length);
794  ps->PutFullData(prefix.toString(), buffer, length);
795 
796  delete ps;
797 
798  enter(JArgs(std::string(buffer, length)));
799 
800  delete [] buffer;
801 
802  run();
803 
804  exit();
805  }
806  }
Data structure to store command line arguments.
Definition: JArgs.hh:26
Light-weight wrapper class around server socket.
int WaitHead(JPrefix &prefix)
Wait for header.
int GetFullData(void *buffer, long long int length)
Receive data.
int PutFullData(const JTag &tag, const void *buffer, const long long int length)
Send data.
int Connected()
Send version.
ControlHost prefix.
Definition: JPrefix.hh:33
int getSize() const
Get size.
Definition: JPrefix.hh:62
std::string toString() const
Convert tag to string.
Definition: JTag.hh:171
virtual bool exit() override
Exit the state machine.
Definition: JDAQClient.hh:485
void run()
Run as run control client following command messages via JNET::JControlHost.
Definition: JDAQClient.hh:690

◆ run() [3/3]

void KM3NETDAQ::JDAQClient::run ( std::istream &  in)
inline

Run client with commands from input stream (e.g. for debugging).

Example input format:

<tag> <event name>[#data];
<tag> <event name>[#data];
Parameters
ininput stream

Definition at line 820 of file JDAQClient.hh.

821  {
822  using namespace std;
823 
824  string tag;
825  string buffer;
826 
827  while (in >> tag && in >> skipws && getline(in, buffer, ';')) {
828  update(tag, buffer.length(), buffer.data());
829  }
830  }
std::istream & getline(std::istream &in, JString &object)
Read string from input stream until end of line.
Definition: JString.hh:478

◆ update() [1/2]

void KM3NETDAQ::JDAQClient::update ( )
inlineprivate

Update state machine.

This method waits for a message from JNET::JControlHost server.

Definition at line 842 of file JDAQClient.hh.

843  {
844  JNET::JPrefix prefix;
845 
846  server->WaitHead(prefix);
847 
848  const int length = prefix.getSize();
849 
850  char* buffer = new char[length];
851 
852  server->GetFullData(buffer, length);
853 
854  update(prefix.getTag(), length, buffer);
855 
856  delete [] buffer;
857  }
const JTag & getTag() const
Get tag.
Definition: JTag.hh:86

◆ update() [2/2]

void KM3NETDAQ::JDAQClient::update ( const JTag tag,
int  length,
const char *  buffer 
)
inlineprivate

Update state machine.

Parameters
tagtag
lengthnumber of characters
buffermessage

Definition at line 867 of file JDAQClient.hh.

868  {
869  using namespace std;
870  using namespace JPP;
871 
872  if (filter(tag, length, buffer)) {
873  return;
874  }
875 
876  if (getSubscription(eventTable)->count(JSubscriptionAny(tag)) == 0 &&
877  getSubscription(eventTable)->count(JSubscriptionAll(tag)) == 0) {
878 
879  actionTagged(tag, length, buffer);
880 
881  return;
882  }
883 
884 
885  string::size_type pos = 0;
886 
887  while (pos != (string::size_type) length && TOKEN_DELIMETER.find(*(buffer + pos)) == string::npos) {
888  ++pos;
889  }
890 
891  const JEvent_t event = JEvent_t::toValue(string(buffer, pos));
892 
893  if (event.hasInfo()) {
894  setEventInfo(event.getInfo());
895  }
896 
897  while (pos != (string::size_type) length && TOKEN_DELIMETER.find(*(buffer + pos)) != string::npos) {
898  ++pos;
899  }
900 
901 
902  JEventTable::const_iterator i = eventTable.find(tag, event.getName());
903 
904  if (i != eventTable.end()) {
905 
906  const CHSM::state* const s0 = getState();
907 
908  if (!i->second->active()) {
909 
910  JWarningStream(logger) << "Event " << i->second->name() << " not active (" << (s0 != NULL ? s0->name() : "") << ")";
911 
912  if (server.is_valid() && s0 != NULL) {
913  server->PutFullString(RC_FAIL, getMessage(*s0, *i->second));
914  }
915  }
916 
917  // redirect all I/O
918 
919  {
921  JErrorStream error(logger);
922 
923  JRedirectStream rs_cin (cin, JLANG::null);
924  JRedirectStream rs_cout(cout, debug);
925  JRedirectStream rs_cerr(cerr, error);
926 
927  if (rs_cin &&
928  rs_cout &&
929  rs_cerr) {
930 
931  (*(i->second))(length - pos, buffer + pos);
932  }
933  }
934 
935  const CHSM::state* const s1 = getState();
936 
937  JStatusStream(logger) << "Transition "
938  << (s0 != NULL ? s0->name() : "")
939  << "->(" << i->second->name() << ")->"
940  << (s1 != NULL ? s1->name() : "");
941  } else {
942 
943  JErrorStream(logger) << "Unknown key <" << tag << "," << event.getName() << ">";
944  }
945  }
int debug
debug level
Definition: JSirene.cc:69
This class can be used to temporarily redirect one output (input) stream to another output (input) st...
virtual bool filter(const JTag &tag, int length, const char *buffer)
Filter message.
Definition: JDAQClient.hh:662
virtual void actionTagged(const JTag &tag, int length, const char *buffer)
This method is called when a custom tag is encountered.
Definition: JDAQClient.hh:675
std::string getMessage(const CHSM::state &state, const CHSM::event &event) const
Get event message.
Definition: JDAQClient.hh:964
const CHSM::state * getState() const
Get current state.
Definition: JDAQClient.hh:1048
static JNullStream null
Null I/O stream.
Definition: JNullStream.hh:51
static const std::string TOKEN_DELIMETER
Definition: JDAQTags.hh:58
static const JNET::JTag RC_FAIL
Definition: JDAQTags.hh:68
Level specific message streamers.
Auxiliary class for all subscription.
Definition: JControlHost.hh:99
Auxiliary class for any subscription.
void setEventInfo(const std::string &info)
Set last event information.
Definition: JDAQClient.hh:196
static JEvent_t toValue(const std::string &buffer)
Convert string to event.
Definition: JEvent_t.hh:99

◆ configure()

void KM3NETDAQ::JDAQClient::configure ( )
inlineprivate

Configure client.

This method is used to setup the event table.

Definition at line 952 of file JDAQClient.hh.

953  {
954  }

◆ getMessage()

std::string KM3NETDAQ::JDAQClient::getMessage ( const CHSM::state &  state,
const CHSM::event &  event 
) const
inlineprivate

Get event message.

Parameters
statestate
eventevent
Returns
message

Definition at line 964 of file JDAQClient.hh.

965  {
966  std::ostringstream os;
967 
968  os << getFullName()
969  << getTokenDelimeter()
970  << (getEventInfo() != "" ?
971  JEvent_t(event.name(), getEventInfo()) :
972  JEvent_t(event.name()))
973  << getTokenDelimeter()
974  << getStateName(state.name());
975 
976  return os.str();
977  }
std::string getStateName(const std::string &name)
Get name of state.
char getTokenDelimeter()
Get the token delimeter for command messages.
const std::string & getEventInfo() const
Get last event information.
Definition: JDAQClient.hh:185

◆ enterState()

virtual void KM3NETDAQ::JDAQClient::enterState ( const CHSM::state &  state,
const CHSM::event &  event 
)
inlineoverrideprivatevirtual

Action when entering state.

This method provides for the hand shaking with the run control program.

Parameters
stateentered state
eventevent that triggered transition

Implements JDAQCHSM.

Reimplemented in KM3NETDAQ::JDAQDriver.

Definition at line 987 of file JDAQClient.hh.

988  {
989  if (server.is_valid()) {
990  server->PutFullString(RC_REPLY, getMessage(state, event));
991  }
992  }
static const JNET::JTag RC_REPLY
Definition: JDAQTags.hh:67

◆ actionCheck()

virtual void KM3NETDAQ::JDAQClient::actionCheck ( int  length,
const char *  buffer 
)
inlineoverrideprivatevirtual

This method is called at ev_check and reports a system check by mimicing an enter state action.

Parameters
lengthnumber of characters
buffermessage

Reimplemented from JDAQCHSM.

Definition at line 1001 of file JDAQClient.hh.

1002  {
1003  if (Main.RunControl.Error.active()) {
1004 
1006 
1007  } else {
1008 
1009  for (CHSM::parent::iterator state = Main.RunControl.Operational.begin(); state != Main.RunControl.Operational.end(); ++state) {
1010 
1011  if (state->active()) {
1012 
1013  // mimic enter state
1014 
1015  enterState(*state, ev_check);
1016  }
1017  }
1018  }
1019  }
JDAQStateMachine::ev_check_event ev_check
virtual void enterState(const CHSM::state &state, const CHSM::event &event) override
Action when entering state.
Definition: JDAQClient.hh:987

◆ execute()

void KM3NETDAQ::JDAQClient::execute ( action  __action,
const CHSM::event &  __event 
)
inlineoverrideprivatevirtual

The method to execute the action.

Parameters
__actionpointer to action method
__eventevent that triggered the action

Implements JDAQCHSM.

Definition at line 1028 of file JDAQClient.hh.

1029  {
1030  try {
1031 
1032  const JDAQStateMachine::ev_daq_event& event = dynamic_cast<const JDAQStateMachine::ev_daq_event&>(__event);
1033 
1034  (this->*__action)(event->length, event->buffer);
1035  }
1036  catch(const std::exception& error) {
1037  JErrorStream(logger) << "Error at event " << __event.name() << " \"" << error.what() << "\"; trigger ev_error.";
1038  ev_error();
1039  }
1040  }

◆ getState()

const CHSM::state* KM3NETDAQ::JDAQClient::getState ( ) const
inlineprivate

Get current state.

Returns
state

Definition at line 1048 of file JDAQClient.hh.

1049  {
1050  for (CHSM::parent::const_iterator state = Main.RunControl.Operational.begin(); state != Main.RunControl.Operational.end(); ++state) {
1051  if (state->active()) {
1052  return &(*state);
1053  }
1054  }
1055 
1056  if (Main.RunControl.Error.active()) {
1057  return &Main.RunControl.Error;
1058  }
1059 
1060  return NULL;
1061  }

◆ A1()

void JDAQStateMachine::A1 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 344 of file JDAQCHSM.cc.

344 { actionError(); }
virtual void actionError()
Definition: JDAQCHSM.hh:135

◆ A2()

void JDAQStateMachine::A2 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 346 of file JDAQCHSM.cc.

346 { execute(&JDAQCHSM::actionInit, event); }
virtual void actionInit(int, const char *)
Definition: JDAQCHSM.hh:123
virtual void execute(action __action, const CHSM::event &__event)=0
The method to execute the action.

◆ A3()

void JDAQStateMachine::A3 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 348 of file JDAQCHSM.cc.

348 { JDAQCHSM::exit(); }

◆ A4()

void JDAQStateMachine::A4 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 350 of file JDAQCHSM.cc.

virtual void actionConfigure(int, const char *)
Definition: JDAQCHSM.hh:124

◆ A5()

void JDAQStateMachine::A5 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 352 of file JDAQCHSM.cc.

352 { execute(&JDAQCHSM::actionReset, event); }
virtual void actionReset(int, const char *)
Definition: JDAQCHSM.hh:129

◆ A6()

void JDAQStateMachine::A6 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 354 of file JDAQCHSM.cc.

354  {
355 
356  std::istringstream is(std::string(ev_start->buffer, ev_start->length));
357 
358  is >> run_number >> detector_id;
359 
361 
362  }
int run_number
Definition: JDAQCHSM.hh:167
virtual void actionStart(int, const char *)
Definition: JDAQCHSM.hh:125
int detector_id
Definition: JDAQCHSM.hh:166
JDAQStateMachine::ev_start_event ev_start

◆ A7()

void JDAQStateMachine::A7 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 364 of file JDAQCHSM.cc.

364 { execute(&JDAQCHSM::actionQuit, event); }
virtual void actionQuit(int, const char *)
Definition: JDAQCHSM.hh:130

◆ A8()

void JDAQStateMachine::A8 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 366 of file JDAQCHSM.cc.

366 { execute(&JDAQCHSM::actionContinue, event); }
virtual void actionContinue(int, const char *)
Definition: JDAQCHSM.hh:127

◆ A9()

void JDAQStateMachine::A9 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 368 of file JDAQCHSM.cc.

368 { execute(&JDAQCHSM::actionStop, event); }
virtual void actionStop(int, const char *)
Definition: JDAQCHSM.hh:128

◆ A10()

void JDAQStateMachine::A10 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 370 of file JDAQCHSM.cc.

370 { execute(&JDAQCHSM::actionPause, event); }
virtual void actionPause(int, const char *)
Definition: JDAQCHSM.hh:126

◆ A11()

void JDAQStateMachine::A11 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 372 of file JDAQCHSM.cc.

372 { execute(&JDAQCHSM::actionRecover, event); }
virtual void actionRecover(int, const char *)
Definition: JDAQCHSM.hh:136

◆ A12()

void JDAQStateMachine::A12 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 374 of file JDAQCHSM.cc.

374 { JDAQCHSM::exit(); }

◆ A13()

void JDAQStateMachine::A13 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 376 of file JDAQCHSM.cc.

376 { execute(&JDAQCHSM::actionCheck, event); }
virtual void actionCheck(int, const char *)
Definition: JDAQCHSM.hh:132

◆ A14()

void JDAQStateMachine::A14 ( CHSM_ns_alias::event const &  event)
inherited

Definition at line 378 of file JDAQCHSM.cc.

378 { execute(&JDAQCHSM::actionInput, event); }
virtual void actionInput(int, const char *)
Definition: JDAQCHSM.hh:133

◆ EAM4root()

void JDAQStateMachine::EAM4root ( CHSM_ns_alias::state const &  chsm_state_,
CHSM_ns_alias::event const &  event 
)
inherited

Definition at line 337 of file JDAQCHSM.cc.

337  {
338 #line 164 "JDAQCHSM.chsm"
339  CHSM_ns_alias::cluster const &state = (CHSM_ns_alias::cluster const&)chsm_state_; actionEnter(); }
virtual void actionEnter()
Interface methods for actions corresponding to state transitions.
Definition: JDAQCHSM.hh:120

◆ XAM4root()

void JDAQStateMachine::XAM4root ( CHSM_ns_alias::state const &  chsm_state_,
CHSM_ns_alias::event const &  event 
)
inherited

Definition at line 340 of file JDAQCHSM.cc.

340  {
341 #line 165 "JDAQCHSM.chsm"
342  CHSM_ns_alias::cluster const &state = (CHSM_ns_alias::cluster const&)chsm_state_; actionExit(); }
virtual void actionExit()
Definition: JDAQCHSM.hh:121

◆ getName()

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

Get name of state machine.

Returns
name

Definition at line 89 of file JDAQCHSM.hh.

90  {
91  return name;
92  }

◆ getDetectorID()

int JDAQCHSM::getDetectorID ( ) const
inlineinherited

Get detector identifier.

Returns
detector identifier.

Definition at line 100 of file JDAQCHSM.hh.

101  {
102  return detector_id;
103  }

◆ getRunNumber()

int JDAQCHSM::getRunNumber ( ) const
inlineinherited

Get run number.

Returns
run number

Definition at line 111 of file JDAQCHSM.hh.

112  {
113  return run_number;
114  }

◆ actionEnter()

virtual void JDAQCHSM::actionEnter ( )
inlinevirtualinherited

Interface methods for actions corresponding to state transitions.

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

Definition at line 120 of file JDAQCHSM.hh.

120 {}

◆ actionExit()

virtual void JDAQCHSM::actionExit ( )
inlinevirtualinherited

◆ actionInit()

virtual void JDAQCHSM::actionInit ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionConfigure()

virtual void JDAQCHSM::actionConfigure ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionStart()

virtual void JDAQCHSM::actionStart ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionPause()

virtual void JDAQCHSM::actionPause ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionContinue()

virtual void JDAQCHSM::actionContinue ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionStop()

virtual void JDAQCHSM::actionStop ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionReset()

virtual void JDAQCHSM::actionReset ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionQuit()

virtual void JDAQCHSM::actionQuit ( int  ,
const char *   
)
inlinevirtualinherited

◆ actionError()

virtual void JDAQCHSM::actionError ( )
inlinevirtualinherited

Definition at line 135 of file JDAQCHSM.hh.

135 {}

◆ actionRecover()

virtual void JDAQCHSM::actionRecover ( int  ,
const char *   
)
inlinevirtualinherited

Definition at line 136 of file JDAQCHSM.hh.

136 {}

◆ getHostname()

const std::string& KM3NETDAQ::JDAQClient_t::getHostname ( ) const
inlineinherited

Get hostname.

Returns
host name

Definition at line 109 of file JDAQClient.hh.

110  {
111  return hostname;
112  }

◆ getFullName()

const std::string& KM3NETDAQ::JDAQClient_t::getFullName ( ) const
inlineinherited

Get full name of this run control client.

Returns
full name

Definition at line 120 of file JDAQClient.hh.

121  {
122  return fullname;
123  }

◆ getUniqueTag()

const JTag& KM3NETDAQ::JDAQClient_t::getUniqueTag ( ) const
inlineinherited

Get unique tag of this run control client.

Returns
unique tag

Definition at line 131 of file JDAQClient.hh.

132  {
133  return unique_tag;
134  }

◆ getClockDelay()

long long int KM3NETDAQ::JDAQClient_t::getClockDelay ( ) const
inlineinherited

Get total delay time.

Returns
delay time [us]

Definition at line 142 of file JDAQClient.hh.

143  {
144  return clock.getDelay();
145  }

◆ getClockInterval()

long long int KM3NETDAQ::JDAQClient_t::getClockInterval ( ) const
inlineinherited

Get interval time.

Returns
interval time [us]

Definition at line 154 of file JDAQClient.hh.

155  {
156  return clock.getInterval();
157  }

◆ setClockInterval()

void KM3NETDAQ::JDAQClient_t::setClockInterval ( const long long int  interval_us)
inlineinherited

Set interval time.

Parameters
interval_usinterval time [us]

Definition at line 165 of file JDAQClient.hh.

166  {
167  clock.setInterval(interval_us);
168  }
void setInterval(const long long int interval_us)
Set interval time.
Definition: JTimekeeper.hh:89

◆ resetClock()

void KM3NETDAQ::JDAQClient_t::resetClock ( )
inlineinherited

Reset clock.

Definition at line 174 of file JDAQClient.hh.

175  {
176  clock.reset();
177  }

◆ getEventInfo()

const std::string& KM3NETDAQ::JDAQClient_t::getEventInfo ( ) const
inlineinherited

Get last event information.

Returns
event information

Definition at line 185 of file JDAQClient.hh.

186  {
187  return event_info;
188  }
std::string event_info
event information
Definition: JDAQClient.hh:208

◆ setEventInfo()

void KM3NETDAQ::JDAQClient_t::setEventInfo ( const std::string &  info)
inlineinherited

Set last event information.

Parameters
infoevent information

Definition at line 196 of file JDAQClient.hh.

197  {
198  this->event_info = info;
199  }

Member Data Documentation

◆ server

JSharedPointer<JControlHost> KM3NETDAQ::JDAQClient::server
protected

message server

Definition at line 834 of file JDAQClient.hh.

◆ logger

JMessageLogger KM3NETDAQ::JDAQClient::logger
protected

message logger

Definition at line 835 of file JDAQClient.hh.

◆ select

JSelectReader KM3NETDAQ::JDAQClient::select
private

select call

Definition at line 1064 of file JDAQClient.hh.

◆ parser

JParser KM3NETDAQ::JDAQClient::parser
private

parser method enter()

Definition at line 1065 of file JDAQClient.hh.

◆ subscription

JSubscriptionList KM3NETDAQ::JDAQClient::subscription
private

custom subscription

Definition at line 1066 of file JDAQClient.hh.

◆ root

JDAQStateMachine::state_root JDAQStateMachine::root
inherited

◆ Main

JDAQStateMachine::state_Main JDAQStateMachine::Main
inherited

◆ ev_daq_transitions

int const JDAQStateMachine::ev_daq_transitions
staticprivateinherited
Initial value:
= {
-1
}

Definition at line 216 of file JDAQCHSM.hh.

◆ ev_daq

JDAQStateMachine::ev_daq_event JDAQStateMachine::ev_daq
inherited

◆ ev_daq_param_block

char JDAQStateMachine::ev_daq_param_block[sizeof(ev_daq_event::param_block)]
inherited

Definition at line 238 of file JDAQCHSM.hh.

◆ ev_init_transitions

int const JDAQStateMachine::ev_init_transitions
staticprivateinherited
Initial value:
= {
1, -1
}

Definition at line 240 of file JDAQCHSM.hh.

◆ ev_init

JDAQStateMachine::ev_init_event JDAQStateMachine::ev_init
inherited

◆ ev_init_param_block

char JDAQStateMachine::ev_init_param_block[sizeof(ev_init_event::param_block)]
inherited

Definition at line 258 of file JDAQCHSM.hh.

◆ ev_configure_transitions

int const JDAQStateMachine::ev_configure_transitions
staticprivateinherited
Initial value:
= {
3, -1
}

Definition at line 260 of file JDAQCHSM.hh.

◆ ev_configure

JDAQStateMachine::ev_configure_event JDAQStateMachine::ev_configure
inherited

◆ ev_configure_param_block

char JDAQStateMachine::ev_configure_param_block[sizeof(ev_configure_event::param_block)]
inherited

Definition at line 278 of file JDAQCHSM.hh.

◆ ev_start_transitions

int const JDAQStateMachine::ev_start_transitions
staticprivateinherited
Initial value:
= {
5, -1
}

Definition at line 280 of file JDAQCHSM.hh.

◆ ev_start

JDAQStateMachine::ev_start_event JDAQStateMachine::ev_start
inherited

◆ ev_start_param_block

char JDAQStateMachine::ev_start_param_block[sizeof(ev_start_event::param_block)]
inherited

Definition at line 298 of file JDAQCHSM.hh.

◆ ev_pause_transitions

int const JDAQStateMachine::ev_pause_transitions
staticprivateinherited
Initial value:
= {
9, -1
}

Definition at line 300 of file JDAQCHSM.hh.

◆ ev_pause

JDAQStateMachine::ev_pause_event JDAQStateMachine::ev_pause
inherited

◆ ev_pause_param_block

char JDAQStateMachine::ev_pause_param_block[sizeof(ev_pause_event::param_block)]
inherited

Definition at line 318 of file JDAQCHSM.hh.

◆ ev_continue_transitions

int const JDAQStateMachine::ev_continue_transitions
staticprivateinherited
Initial value:
= {
7, -1
}

Definition at line 320 of file JDAQCHSM.hh.

◆ ev_continue

JDAQStateMachine::ev_continue_event JDAQStateMachine::ev_continue
inherited

◆ ev_continue_param_block

char JDAQStateMachine::ev_continue_param_block[sizeof(ev_continue_event::param_block)]
inherited

Definition at line 338 of file JDAQCHSM.hh.

◆ ev_stop_transitions

int const JDAQStateMachine::ev_stop_transitions
staticprivateinherited
Initial value:
= {
8, -1
}

Definition at line 340 of file JDAQCHSM.hh.

◆ ev_stop

JDAQStateMachine::ev_stop_event JDAQStateMachine::ev_stop
inherited

◆ ev_stop_param_block

char JDAQStateMachine::ev_stop_param_block[sizeof(ev_stop_event::param_block)]
inherited

Definition at line 358 of file JDAQCHSM.hh.

◆ ev_reset_transitions

int const JDAQStateMachine::ev_reset_transitions
staticprivateinherited
Initial value:
= {
4, -1
}

Definition at line 360 of file JDAQCHSM.hh.

◆ ev_reset

JDAQStateMachine::ev_reset_event JDAQStateMachine::ev_reset
inherited

◆ ev_reset_param_block

char JDAQStateMachine::ev_reset_param_block[sizeof(ev_reset_event::param_block)]
inherited

Definition at line 378 of file JDAQCHSM.hh.

◆ ev_quit_transitions

int const JDAQStateMachine::ev_quit_transitions
staticprivateinherited
Initial value:
= {
6, -1
}

Definition at line 380 of file JDAQCHSM.hh.

◆ ev_quit

JDAQStateMachine::ev_quit_event JDAQStateMachine::ev_quit
inherited

◆ ev_quit_param_block

char JDAQStateMachine::ev_quit_param_block[sizeof(ev_quit_event::param_block)]
inherited

Definition at line 398 of file JDAQCHSM.hh.

◆ ev_off_transitions

int const JDAQStateMachine::ev_off_transitions
staticprivateinherited
Initial value:
= {
2, 11, -1
}

Definition at line 400 of file JDAQCHSM.hh.

◆ ev_off

JDAQStateMachine::ev_off_event JDAQStateMachine::ev_off
inherited

◆ ev_off_param_block

char JDAQStateMachine::ev_off_param_block[sizeof(ev_off_event::param_block)]
inherited

Definition at line 418 of file JDAQCHSM.hh.

◆ ev_check_transitions

int const JDAQStateMachine::ev_check_transitions
staticprivateinherited
Initial value:
= {
12, -1
}

Definition at line 420 of file JDAQCHSM.hh.

◆ ev_check

JDAQStateMachine::ev_check_event JDAQStateMachine::ev_check
inherited

◆ ev_check_param_block

char JDAQStateMachine::ev_check_param_block[sizeof(ev_check_event::param_block)]
inherited

Definition at line 438 of file JDAQCHSM.hh.

◆ ev_input_transitions

int const JDAQStateMachine::ev_input_transitions
staticprivateinherited
Initial value:
= {
13, -1
}

Definition at line 440 of file JDAQCHSM.hh.

◆ ev_input

JDAQStateMachine::ev_input_event JDAQStateMachine::ev_input
inherited

◆ ev_input_param_block

char JDAQStateMachine::ev_input_param_block[sizeof(ev_input_event::param_block)]
inherited

Definition at line 458 of file JDAQCHSM.hh.

◆ ev_recover_transitions

int const JDAQStateMachine::ev_recover_transitions
staticprivateinherited
Initial value:
= {
10, -1
}

Definition at line 460 of file JDAQCHSM.hh.

◆ ev_recover

JDAQStateMachine::ev_recover_event JDAQStateMachine::ev_recover
inherited

◆ ev_recover_param_block

char JDAQStateMachine::ev_recover_param_block[sizeof(ev_recover_event::param_block)]
inherited

Definition at line 478 of file JDAQCHSM.hh.

◆ ev_error_transitions

int const JDAQStateMachine::ev_error_transitions
staticprivateinherited
Initial value:
= {
0, -1
}

Definition at line 480 of file JDAQCHSM.hh.

◆ ev_error

JDAQStateMachine::ev_error_event JDAQStateMachine::ev_error
inherited

◆ ev_error_param_block

char JDAQStateMachine::ev_error_param_block[sizeof(ev_error_event::param_block)]
inherited

Definition at line 495 of file JDAQCHSM.hh.

◆ state_

CHSM_ns_alias::state* JDAQStateMachine::state_[11]
privateinherited

Definition at line 522 of file JDAQCHSM.hh.

◆ transition_

CHSM_ns_alias::transition const JDAQStateMachine::transition_
staticprivateinherited
Initial value:
= {
{ 0, 2, 8, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A1 },
{ 0, 3, 4, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A2 },
{ 0, 3, -1, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A3 },
{ 0, 4, 5, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A4 },
{ 0, 4, 3, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A5 },
{ 0, 5, 7, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A6 },
{ 0, 5, 4, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A7 },
{ 0, 6, 7, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A8 },
{ 0, 6, 4, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A9 },
{ 0, 7, 6, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A10 },
{ 0, 8, 2, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A11 },
{ 0, 8, -1, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A12 },
{ 0, 9, -1, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A13 },
{ 0, 9, -1, 0, (CHSM_ns_alias::transition::action)&JDAQStateMachine::A14 },
0
}
void A1(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:344
void A4(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:350
void A13(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:376
void A11(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:372
void A2(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:346
void A14(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:378
void A7(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:364
void A9(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:368
void A12(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:374
void A3(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:348
void A8(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:366
void A5(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:352
void A10(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:370
void A6(CHSM_ns_alias::event const &)
Definition: JDAQCHSM.cc:354

Definition at line 523 of file JDAQCHSM.hh.

◆ taken_

CHSM_ns_alias::event const* JDAQStateMachine::taken_[14]
privateinherited

Definition at line 524 of file JDAQCHSM.hh.

◆ target_

CHSM_ns_alias::state* JDAQStateMachine::target_[14]
privateinherited

Definition at line 525 of file JDAQCHSM.hh.

◆ name

std::string JDAQCHSM::name
protectedinherited

Definition at line 165 of file JDAQCHSM.hh.

◆ detector_id

int JDAQCHSM::detector_id
protectedinherited

Definition at line 166 of file JDAQCHSM.hh.

◆ run_number

int JDAQCHSM::run_number
protectedinherited

Definition at line 167 of file JDAQCHSM.hh.

◆ TIMEOUT_S

const int KM3NETDAQ::JDAQClient_t::TIMEOUT_S = 1
staticinherited

time out of update [s]

Definition at line 63 of file JDAQClient.hh.

◆ eventTable

JEventTable KM3NETDAQ::JDAQClient_t::eventTable
protectedinherited

event table

Definition at line 203 of file JDAQClient.hh.

◆ hostname

std::string KM3NETDAQ::JDAQClient_t::hostname
protectedinherited

Definition at line 204 of file JDAQClient.hh.

◆ fullname

std::string KM3NETDAQ::JDAQClient_t::fullname
protectedinherited

Definition at line 205 of file JDAQClient.hh.

◆ unique_tag

JTag KM3NETDAQ::JDAQClient_t::unique_tag
protectedinherited

Definition at line 206 of file JDAQClient.hh.

◆ clock

JTimekeeper KM3NETDAQ::JDAQClient_t::clock
protectedinherited

central clock

Definition at line 207 of file JDAQClient.hh.

◆ event_info

std::string KM3NETDAQ::JDAQClient_t::event_info
protectedinherited

event information

Definition at line 208 of file JDAQClient.hh.


The documentation for this class was generated from the following file: