Simple driver for run control clients. More...

#include <JDAQDriver.hh>

Inheritance diagram for KM3NETDAQ::JDAQDriver:

Public Member Functions
	JDAQDriver (const std::string &name, const std::string &server, JLogger *logger, const int level, const int timeout_s)
	Constructor.

virtual bool	enter () override
	Enter the state machine.

virtual void	actionExit () override
	Exit the state machine.

virtual void	enterState (const CHSM::state &state, const CHSM::event &event) override
	Action when entering state.

bool	update (const bool no_wait)
	Update client list with incoming ControlHost message.

virtual void	actionStart (int, const char *) override

virtual void	actionStop (int, const char *) override

void	run ()
	Run driver with user input.

void	run (std::istream &in)
	Run driver.

void	update ()
	Update client list with incoming ControlHost messages until the client list is synchronised with the current state or until the timeout.

void	synchronise ()
	Synchronise clients.

void	filter (const std::string &target="")
	Filter client list by putting failing clients to sleep.

virtual bool	filter (const JTag &tag, int length, const char *buffer)
	Filter message.

virtual bool	enter (const JArgs &args)
	Enter the state machine.

virtual bool	exit () override
	Exit the state machine.

bool	isRunning () const
	Check if this client is in runnig state.

void	replaceEvent (const JTag &oldTag, const JTag &newTag, JDAQEvent_t &event)
	Replace tag of given event in event table.

JDAQEvent_t *	findEvent (const JTag &tag, const std::string &event_name)
	Find event in event table.

void	addSubscription (const JSubscription &subscription)
	Add custom subscription.

template<class T >
void	addParameter (const char option, T &parameter)
	Add parameter to parser used in method enter().

template<class T >
void	addParameter (const char option, T &parameter, const T &value)
	Add parameter to parser used in method enter().

void	setSelect ()
	Set the file descriptor mask for the select call.

virtual void	setSelect (JFileDescriptorMask &mask) const
	Set the file descriptor mask for the select call.

virtual void	actionSelect (const JFileDescriptorMask &mask)
	Action method following last select call.

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

virtual void	actionInput (int length, const char *buffer) override
	This method is called at `ev_input`.

virtual void	actionTagged (const JTag &tag, int length, const char *buffer)
	This method is called when a custom tag is encountered.

void	run (const int port)
	Run for ever.

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.

int	getDetectorID () const
	Get detector identifier.

int	getRunNumber () const
	Get run number.

virtual void	actionEnter ()
	Interface methods for actions corresponding to state transitions.

virtual void	actionInit (int, const char *)

virtual void	actionConfigure (int, const char *)

virtual void	actionPause (int, const char *)

virtual void	actionContinue (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.

const std::string &	getFullName () const
	Get full name of this run control client.

const JTag &	getUniqueTag () const
	Get unique tag of this run control client.

long long int	getClockDelay () const
	Get total delay time.

long long int	getClockInterval () const
	Get interval time.

void	setClockInterval (const long long int interval_us)
	Set interval time.

void	resetClock ()
	Reset clock.

const std::string &	getEventInfo () const
	Get last event information.

void	setEventInfo (const std::string &info)
	Set last event information.

Public Attributes
int	timeout_us
	timeout of state transitions [us]

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	SLEEP_TIME_US = 500000

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

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

Static Protected Member Functions
static void	copy (std::istream &in, std::ostream &out, const char eol='\n')
	Copy data from input to output stream.

Protected Attributes
JClientList	clientList

bool	is_alive

std::string	rc_log

JSharedPointer< JControlHost >	server
	message server

JMessageLogger	logger
	message logger

std::string	name

int	detector_id

int	run_number

JEventTable	eventTable
	event table

std::string	hostname

std::string	fullname

JTag	unique_tag

JTimekeeper	clock
	central clock

std::string	event_info
	event information

Private Member Functions
void	configure ()
	Configure client.

std::string	getMessage (const CHSM::state &state, const CHSM::event &event) const
	Get event message.

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.

void	execute (action __action, const CHSM::event &__event) override
	The method to execute the action.

const CHSM::state *	getState () const
	Get current state.

Private Attributes
JSelectReader	select
	select call

JParser	parser
	parser method enter()

JSubscriptionList	subscription
	custom subscription

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

Simple driver for run control clients.

This class can be used to start a set of run control clients, trigger events and eventually stop the clients.

Definition at line 36 of file JDAQDriver.hh.

Member Typedef Documentation

◆ action

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

protectedinherited

Type definition of action method.

Definition at line 152 of file JDAQCHSM.hh.

Constructor & Destructor Documentation

◆ JDAQDriver()

KM3NETDAQ::JDAQDriver::JDAQDriver	(	const std::string &	name,
		const std::string &	server,
		JLogger *	logger,
		const int	level,
		const int	timeout_s )

inline

Constructor.

Parameters

name	name of driver
server	name of command message server
logger	logger
level	debug level
timeout_s	timeout_s [s]

Definition at line 54 of file JDAQDriver.hh.

                                             :
      JDAQClient(name, server, logger, level),
      timeout_us(timeout_s * 1000000),
      is_alive  (false)
    {}

Member Function Documentation

◆ enter() [1/2]

virtual bool KM3NETDAQ::JDAQDriver::enter ( )

inlineoverridevirtual

Enter the state machine.

The driver will subscribe to the ControlHost tags corresponding to born, died and reply messages of the clients instead of the standard tags for run control commands. The clients are started after the driver is ready to receive ControlHost messages. In case of an error, a message is printed on the terminal and the state machine is not entered.

Reimplemented from KM3NETDAQ::JDAQClient.

Definition at line 73 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JPP;
 
      if (server.is_valid() && logger.is_valid()) {
 
        try {
          
          server->Subscribe(JSubscriptionAll(RC_REPLY)     + 
                            JSubscriptionAll(RC_LOG)       + 
                            JSubscriptionAll(DISPTAG_Born) + 
                            JSubscriptionAll(DISPTAG_Died));
          server->SendMeAlways();
          server->MyId(getFullName());
 
          // check alive of this driver
 
          for (int i = 0; i != timeout_us && !is_alive; ) {
            if (!update(true)) {
              usleep(SLEEP_TIME_US);
              i  +=  SLEEP_TIME_US;
            }
          }
          
          if (is_alive) {
 
            {
              //clientList.start();
 
              for (JClientList::iterator i = clientList.begin(); i != clientList.end(); ++i) {
                if (i->isActive()) {
 
                  JNoticeStream(logger) << "Start process " << *i;
 
                  i->start();
                }
              }
              
              for (int i = 0; i != timeout_us; i += SLEEP_TIME_US) {
 
                while (update(true)) {
                }
 
                if (clientList.count() >= clientList.count(JClient::ACTIVE))
                  break;
                else
                  usleep(SLEEP_TIME_US);
              }
            }
 
            if (clientList.count() != clientList.count(JClient::ACTIVE)) {
              for (JClientList::const_iterator i = clientList.begin(); i != clientList.end(); ++i) {
                if (i->isActive() && i->getBorn() <= i->getDied()) {
                  JWarningStream(logger) << "client " << i->getFullName() << " did not start.";
                }
              }
            }
 
            return CHSM::machine::enter();
 
          } else {
            cerr << "Timeout at subscription." << endl;
          }
        }
        catch(const JControlHostException& error) {
          cerr << error << endl;
        }
 
      } else {
        cerr << "Message server or logger not properly initialised." << endl;
      }
 
      return false;
    }

◆ actionExit()

virtual void KM3NETDAQ::JDAQDriver::actionExit ( )

inlineoverridevirtual

Exit the state machine.

This method waits for the clients to terminate using the died message generated by ControlHost. In case of a timeout, the process is terminated by calling the method stop() of the corresponding client.

Reimplemented from JDAQCHSM.

Definition at line 156 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JLANG;
 
      for (int i = 0; i != timeout_us; i += SLEEP_TIME_US) {
 
        while (update(true)) {}
 
        if (clientList.count() == 0)
          break;
        else
          usleep(SLEEP_TIME_US);
      }
 
      if (clientList.count() != 0) {
        JWarningStream(logger) << "Timeout at transition " << "exit(); forced stop.";
      }
 
      clientList.stop();
    }

◆ enterState()

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

inlineoverridevirtual

Action when entering state.

This method waits for all clients to produce the enter state message. In case of a timeout, no specific action is taken but an error message is logged.

Parameters

state	entered state
event	event that triggered transition

Reimplemented from KM3NETDAQ::JDAQClient.

Definition at line 187 of file JDAQDriver.hh.

    {
      for (int i = 0; i != timeout_us && clientList.count(state) < clientList.count(JClient::ACTIVE) && clientList.count() != 0; ) {
        if (!update(true)) {
          usleep(SLEEP_TIME_US);
          i  +=  SLEEP_TIME_US;
        }
      }
 
      if (clientList.count(state) < clientList.count(JClient::ACTIVE)) {
        JWarningStream(logger) << "Timeout at transition " << event.name() << " to state " << state.name(); 
      }
    }

◆ update() [1/2]

bool KM3NETDAQ::JDAQDriver::update ( const bool no_wait )

inline

Update client list with incoming ControlHost message.

This method receives and processes a message. The client list is updated accordingly. If the no-wait option is set to true, it returns in the absence of a pending message immediately. The return value is then false. If the no-wait option is set to false, it waits until the next message is received.

Parameters

no_wait wait option

Returns: true if message received; else false

Definition at line 213 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JNET;
      using JLANG::JWhiteSpacesFacet;
 
      try {
 
        string        tag;
        long long int length = 0;
 
        if ( no_wait && server->CheckHead(tag, length) <= 0) { return false; }
        if (!no_wait && server->WaitHead (tag, length) <  0) { return false; }
        
        char* data= new char[length];
        
        server->GetFullData(data, length);
        
        const string buffer(data, length);
 
        delete [] data;
        
        JDebugStream(logger) << "Got message " << tag << ' ' << buffer;
        
        if (tag == RC_LOG) {
 
          rc_log = buffer;
 
        } else if (buffer.find(getFullName()) != string::npos) {
          
          if      (tag == DISPTAG_Born)
            is_alive  = true;
          else if (tag == DISPTAG_Died)
            is_alive  = false;
          
        } else {
 
          JClientList::iterator i = clientList.find(buffer);
          
          if (i != clientList.end()) {
 
            i->update(tag, buffer);
 
          } else {
 
            JErrorStream(logger) << "Message fom illegal client " << buffer;
 
            try {
 
              if (tag == DISPTAG_Born ||
                  tag == DISPTAG_Died ||
                  tag == RC_REPLY) {
 
                string key, hostname, name;
                
                istringstream is(buffer);
      
                const locale loc(is.getloc(), new JWhiteSpacesFacet(is.getloc(), TOKEN_DELIMETER));
      
                is.imbue(loc);
                
                if (is >> key >> hostname >> name && key == RUN_CONTROL_CLIENT) {
 
                  JClient client(name, hostname);
 
                  client.update(tag, buffer);
                  client.setMode(JClient::ILLEGAL);
            
                  clientList.insert(client);
                  
                  JWarningStream(logger) << "Added illegal client " << client.getFullName();
 
                } else {
                  THROW(JIOException, "JClient: Error reading " << buffer);
                }
              }
            }
            catch(const JException& error) {
              JErrorStream(logger) << error;
            }
          }
        }
 
        return true;
      }
      catch(const JControlHostException& error) {
        JErrorStream(logger) << error;
      }
 
      return false;
    }

◆ actionStart()

virtual void KM3NETDAQ::JDAQDriver::actionStart	(	int	,
		const char *	)

inlineoverridevirtual

Reimplemented from JDAQCHSM.

Definition at line 305 of file JDAQDriver.hh.

    {
      rc_log = "";
    }

◆ actionStop()

virtual void KM3NETDAQ::JDAQDriver::actionStop	(	int	,
		const char *	)

inlineoverridevirtual

Reimplemented from JDAQCHSM.

Definition at line 310 of file JDAQDriver.hh.

    {
      if (rc_log != "") 
        JNoticeStream(logger) << rc_log;
      else
        JErrorStream (logger) << "Missing message from JDataWriter with tag " << RC_LOG;
    }

◆ run() [1/3]

void KM3NETDAQ::JDAQDriver::run ( )

inline

Run driver with user input.

Definition at line 321 of file JDAQDriver.hh.

    {
      run(std::cin);
    }

◆ run() [2/3]

void KM3NETDAQ::JDAQDriver::run ( std::istream & in )

inline

Run driver.

Example input format:

# comment line.

process <process name> <host name> [<start command>];

# The following tokens in <start command> will be substituted: 
#   $HOST$    by  <host name>;
#   $NAME$    by  <process name>;
#   $SERVER$  by  JClient::SERVER;
#   $LOGGER$  by  JClient::LOGGER;
#   $ARGS$    by  part following '/' in <process name>;

# enter state machine.

enter

# trigger event
# data can be provided online and mixed with data from a separate file (optional).
# multiple tags should be separated by a new line.

event <event name> {
  [<tag 1> [data]]
  [<tag 2> [data][%<file name>%][data]]
}

# optionally quit before end of input
[quit]

# optionally kill processes that did not properly terminate.
[exit]

Parameters

in	input stream

Definition at line 365 of file JDAQDriver.hh.

    {
      using namespace std;
      
      for (string key; in >> key; ) {
 
        if (key[0] == '#') {
 
          in.ignore(numeric_limits<streamsize>::max(), '\n');
 
        } else if (key == "enter") {
          
          enter();
          
          if (!active()) {
            cerr << "State machine not entered; abort." << endl;
            return;
          }
 
        } else if (key == "exit") {
          
          timeout_us = 0;
          exit();
          
        } else if (key == "quit") {
          
          break;
          
        } else if (key == "sleep") {
 
          int sec;
 
          if (in >> sec) {
            sleep(sec);
          }
          
        } else if (key == "process") {
 
          string buffer;
 
          getline(in, buffer, ';');
          
          istringstream is(buffer);
          
          JClient client;
          
          if (is >> client) {
 
            client.setMode(JClient::ACTIVE);
 
            if (!clientList.insert(client).second) {
              JWarningStream(logger) << "Process already exists " << client;
            }
 
          } else {
            JErrorStream(logger) << "Error reading key word process.";
          }
 
        } else if (key == "event" || key == "event*") {
 
          JEvent_t   event;
          char       c;
          string     buffer;
          const char eol = '\n';
          
          if (in >> event >> c && c == '{' && getline(in, buffer, '}')) {
 
            if (clientList.count() != 0) {
 
              JDAQEvent_t* pev = findEvent(RC_CMD, event.getName());
            
              if (pev != NULL) {
 
                if (pev->active() || key == "event*") {
 
                  istringstream is(buffer);
                
                  for (string tag; is >> tag; ) {
                  
                    ostringstream os;
 
                    os << event << getTokenDelimeter();
 
                    copy(is, os, eol);
                    
                    JNoticeStream(logger) << key << ' ' << tag << ' ' << event;
 
                    server->PutFullString(tag, os.str());
                  }
 
                  if (key != "event*") {
                    (*pev)(0, NULL);   // trigger driver
                  }
 
                } else {
                  JErrorStream(logger) << "Inactive event " << event;
                }
 
              } else {
                JErrorStream(logger) << "Unknown event " << event;
              }
 
            } else {
              JErrorStream(logger) << "No active client to trigger event.";
            }
 
          } else {
            JErrorStream(logger) << "Error reading key word event.";
          }
 
        } else if (key == "message") {
 
          string tag;
          string buffer;
 
          if (in >> tag && getline(in, buffer, ';'))
            server->PutFullString(tag, buffer);
          else
            JErrorStream(logger) << "Invalid message: <" << tag << "> \"" << buffer << "\"";
          
        } else if (key == "print") {
 
          for (JClientList::const_iterator i = clientList.begin(); i != clientList.end(); ++i) {
            JNoticeStream(logger) << i->getFullName()     << ' '
                                  << i->getStartCommand() << ' '
                                  << i->getAlive()        << ' '
                                  << i->getStatename();
          }
 
        } else if (key == "filter") {
 
          string client;
          string buffer;
 
          getline(in, buffer, ';');
 
          for (istringstream is(buffer); is >> client; ) {
            filter(client);
          }
 
        } else if (key == "sync") {
 
          synchronise();
          
        } else {
 
          JErrorStream(logger) << "Unknown key: " << key;
 
          in.ignore(numeric_limits<streamsize>::max(), '\n');
        }
      }
    }

◆ update() [2/2]

void KM3NETDAQ::JDAQDriver::update ( )

inline

Update client list with incoming ControlHost messages until the client list is synchronised with the current state or until the timeout.

Definition at line 523 of file JDAQDriver.hh.

    {
      using namespace std;
 
      const CHSM::parent& parent = static_cast<const CHSM::parent&>(Main.RunControl);
 
      for (CHSM::parent::const_iterator state = parent.begin(); state != parent.end(); ++state) {
 
        if (state->active()) {
          for (int i = 0; i != timeout_us && clientList.count(*state) < clientList.count(JClient::ACTIVE); ) {
            if (!update(true)) {
              usleep(SLEEP_TIME_US);
              i  +=  SLEEP_TIME_US;
            }
          }
        }
      }
    }

◆ synchronise()

void KM3NETDAQ::JDAQDriver::synchronise ( )

inline

Synchronise clients.

Definition at line 546 of file JDAQDriver.hh.

    {
      using namespace std;
 
      const CHSM::parent& parent = static_cast<const CHSM::parent&>(Main.RunControl);
 
      for (CHSM::parent::const_iterator state = parent.begin(); state != parent.end(); ++state) {
 
        if (state->active()) {
 
          if (clientList.count(*state) < clientList.count(JClient::ACTIVE)) {
 
            JDebugStream(logger) << "Synchronising " << state->name();
            
            for (JClientList::iterator i = clientList.begin(); i != clientList.end(); ++i) {
 
              if (i->getMode() == JClient::ACTIVE) {
                
                if (!i->getAlive()) {
              
                  try {
                
                    string buffer;
                
                    if (JControlHost::WhereIs(JClient::SERVER, i->getFullName(), buffer) > 0) {
 
                      i->setAlive(true);
 
                      if (buffer.find(i->getHostname()) == string::npos) {
                        JErrorStream(logger) << i->getFullName() << " running on " << buffer << " but not alive.";
                      }
                    }
                  }
                  catch(const JControlHostException& error) {
                    JErrorStream(logger) << error;
                  }
                }
 
                if (i->getAlive() && i->getStatename() != state->name()) {
                  server->PutFullString(KM3NETDAQ::getUniqueTag(i->getHostname(), i->getName()), ev_check.name()); 
                }
              }
            }
            
            
            for (int i = 0; i != timeout_us && clientList.count(*state) < clientList.count(JClient::ACTIVE); ) {
              if (!update(true)) {
                usleep(SLEEP_TIME_US);
                i  +=  SLEEP_TIME_US;
              }
            }
            
            if (clientList.count(*state) < clientList.count(JClient::ACTIVE)) {
              JWarningStream(logger) << "Timeout at synchronisation.";
            }
          }
        }
      }
    }

◆ filter() [1/2]

void KM3NETDAQ::JDAQDriver::filter ( const std::string & target = "" )

inline

Filter client list by putting failing clients to sleep.

In this, only clients with names that contain the given character sequence are considered.

Parameters

target target name of client(s)

Definition at line 613 of file JDAQDriver.hh.

    {
      const CHSM::parent& parent = static_cast<const CHSM::parent&>(Main.RunControl);
 
      for (CHSM::parent::const_iterator state = parent.begin(); state != parent.end(); ++state) {
 
        if (state->active()) {
 
          for (JClientList::iterator i = clientList.begin(); i != clientList.end(); ++i) {
 
            if (target == "" || i->getName().find(target) != std::string::npos) {
 
              if (!i->getAlive() || i->getStatename() != state->name()) {
 
                JNoticeStream(logger) << "Put to sleep " << i->getFullName();
 
                i->setMode(JClient::SLEEP);
              }
            }
          }
        }
      }
    }

◆ copy()

static void KM3NETDAQ::JDAQDriver::copy	(	std::istream &	in,
		std::ostream &	out,
		const char	eol = '\n' )

inlinestaticprotected

Copy data from input to output stream.

Tagged file names are recursively expanded.

Parameters

in	input stream
out	output stream
eol	end of line

Definition at line 653 of file JDAQDriver.hh.

    {
      using namespace std;
      using namespace JPP;
 
      const JEquationParameters parameters("=", ";", "", "");
 
      string buffer; 
 
      if (getline(in, buffer, eol)) {
 
        for (string::size_type pos = 0; pos < buffer.length(); ) {
          
          string::size_type lpos = buffer.substr(pos).find(FILENAME_PREFIX);
          string::size_type rpos = buffer.substr(pos).find(FILENAME_POSTFIX);
          
          if (lpos != string::npos && 
              rpos != string::npos) {
            
            out << buffer.substr(pos, lpos);
            
            lpos += FILENAME_PREFIX.length();
            pos  += lpos;
            
            ifstream file(buffer.substr(pos, rpos - lpos).c_str());
            
            copy(file, out, '\0');
 
            rpos += FILENAME_POSTFIX.length();
            pos  += rpos - lpos;
            
          } else {
            
            out << buffer.substr(pos);
            
            pos  += buffer.substr(pos).length();
          }
        }
      }
    }

◆ filter() [2/2]

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

tag	tag
length	number of characters
buffer	message

Returns: skip message or not

Reimplemented from KM3NETDAQ::JDAQClient.

Definition at line 662 of file JDAQClient.hh.

    {
      return false;
    }

◆ enter() [2/2]

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

inlinevirtualinherited

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

args	array of command line arguments

Returns: true if okay; else false

Definition at line 392 of file JDAQClient.hh.

    {
      using namespace std;
 
      string  server;
      string  logger;
      int     level;
      bool    use_cout;
 
      try {
        
        parser['H'] = make_field(server)    = "localhost";
        parser['M'] = make_field(logger)    = "localhost";
        parser['d'] = make_field(level)     = 0;
        parser['c'] = make_field(use_cout);
        
        if (parser.read(args) != 0) {
          return false;
        }
      }
      catch(const std::exception &error) {
        cerr << error.what() << endl;
        return false;
      }
 
      try {
 
        JLogger* out = NULL;
 
        if (use_cout)
          out = new JStreamLogger(cout);
        else
          out = new JControlHostLogger(logger);
        
        this->logger = JMessageLogger(out, getName(), level);
 
        this->server.reset(new JControlHost(server));
 
        return enter();
      } 
      catch(const std::exception& error) {
        cerr << error.what() << endl;
        return false;
      }
    }

◆ exit()

virtual bool KM3NETDAQ::JDAQClient::exit ( )

inlineoverridevirtualinherited

Exit the state machine.

This method releases the various resources.

Returns: true if okay; else false

Definition at line 485 of file JDAQClient.hh.

    {
      try { 
        if (server.is_valid()) { server.reset(NULL); }
      }
      catch(const std::exception& error) {
      }
 
      try {
        if (logger.is_valid()) { logger.reset(NULL); }
      }
      catch(const std::exception& error) {
      }
 
      return CHSM::machine::exit();
    }

◆ isRunning()

bool KM3NETDAQ::JDAQClient::isRunning ( ) const

inlineinherited

Check if this client is in runnig state.

Returns: true if running; else false

Definition at line 508 of file JDAQClient.hh.

    {
      return Main.RunControl.Operational.Running.active();
    }

◆ replaceEvent()

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

inlineinherited

Replace tag of given event in event table.

Parameters

oldTag	old tag
newTag	new tag
event	event

Definition at line 521 of file JDAQClient.hh.

    {
      eventTable.replace(oldTag, newTag, event);
    }

◆ findEvent()

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

inlineinherited

Find event in event table.

Parameters

tag	tag
event_name	event name

Returns: pointer to event or NULL

Definition at line 536 of file JDAQClient.hh.

    {
      JEventTable::const_iterator i = eventTable.find(tag, event_name);
            
      if (i != eventTable.end())
        return i->second;
      else
        return NULL;
    }

◆ addSubscription()

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

inlineinherited

Add custom subscription.

Parameters

subscription subscription

Definition at line 552 of file JDAQClient.hh.

    {
      this->subscription.add(subscription);
    }

◆ addParameter() [1/2]

template<class T >

void KM3NETDAQ::JDAQClient::addParameter	(	const char	option,
		T &	parameter )

inlineinherited

Add parameter to parser used in method enter().

Parameters

option	option
parameter	parameter

Definition at line 565 of file JDAQClient.hh.

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

◆ addParameter() [2/2]

template<class T >

void KM3NETDAQ::JDAQClient::addParameter	(	const char	option,
		T &	parameter,
		const T &	value )

inlineinherited

Add parameter to parser used in method enter().

Parameters

option	option
parameter	parameter
value	default value

Definition at line 579 of file JDAQClient.hh.

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

◆ setSelect() [1/2]

void KM3NETDAQ::JDAQClient::setSelect ( )

inlineinherited

Set the file descriptor mask for the select call.

Definition at line 588 of file JDAQClient.hh.

    {
      select.reset();
      
      setSelect(select.getReaderMask());
 
      select.setReaderMask(*server);
    }

◆ setSelect() [2/2]

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

inlinevirtualinherited

Set the file descriptor mask for the select call.

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

Parameters

mask	file descriptor mask

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

Definition at line 604 of file JDAQClient.hh.

605 {}

◆ actionSelect()

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

inlinevirtualinherited

Action method following last select call.

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

Parameters

mask	file descriptor mask

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

Definition at line 614 of file JDAQClient.hh.

615 {}

◆ actionRunning()

virtual void KM3NETDAQ::JDAQClient::actionRunning ( )

inlinevirtualinherited

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 AcousticDataFilter, KM3NETDAQ::DataQueue, KM3NETDAQ::JDataFilter, KM3NETDAQ::JDataWriter, KM3NETDAQ::JDQSimulator, KM3NETDAQ::JEventGenerator, and KM3NETDAQ::MonitorRouter.

Definition at line 625 of file JDAQClient.hh.

626 {}

◆ actionInput()

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

inlineoverridevirtualinherited

This method is called at ev_input.

Parameters

length	length of data
buffer	pointer to data

Reimplemented from JDAQCHSM.

Reimplemented in KM3NETDAQ::DataQueue.

Definition at line 635 of file JDAQClient.hh.

    {
      using namespace std;
 
      JProperties properties(JEquationParameters("=", ";", "", ""), 1);
 
      int level = this->logger.getLevel();
 
      properties["debug"] = level;
 
      properties.read(string(buffer, length));
 
      this->logger.setLevel(level);
    }

◆ actionTagged()

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

inlinevirtualinherited

This method is called when a custom tag is encountered.

Parameters

tag	tag
length	length of data
buffer	pointer to data

Reimplemented in KM3NETDAQ::JDataFilter.

Definition at line 675 of file JDAQClient.hh.

676 {

677 }

◆ run() [3/3]

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

inlineinherited

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

port	port number

Definition at line 775 of file JDAQClient.hh.

    {
      JControlHostServer local_server(port);
 
      for ( ; ; ) {
 
        JControlHost* ps = local_server.AcceptClient();
        
        ps->Connected();
 
        JNET::JPrefix prefix;
 
        ps->WaitHead(prefix);
 
        const int length = prefix.getSize();
 
        char* buffer = new char[length];
        
        ps->GetFullData(buffer, length);        
        ps->PutFullData(prefix.toString(), buffer, length);
 
        delete ps;
 
        enter(JArgs(std::string(buffer, length)));
 
        delete [] buffer;
        
        run();
 
        exit();
      }
    }

◆ configure()

void KM3NETDAQ::JDAQClient::configure ( )

inlineprivateinherited

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

inlineprivateinherited

Get event message.

Parameters

state	state
event	event

Returns: message

Definition at line 964 of file JDAQClient.hh.

    {
      std::ostringstream os;
      
      os << getFullName()
         << getTokenDelimeter() 
         << (getEventInfo() != "" ? 
             JEvent_t(event.name(), getEventInfo()) : 
             JEvent_t(event.name()))
         << getTokenDelimeter() 
         << getStateName(state.name());
 
      return os.str();
    }

◆ actionCheck()

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

inlineoverrideprivatevirtualinherited

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

Parameters

length	number of characters
buffer	message

Reimplemented from JDAQCHSM.

Definition at line 1001 of file JDAQClient.hh.

    {
      if (Main.RunControl.Error.active()) {
 
        enterState(Main.RunControl.Error, ev_check);
 
      } else {
        
        for (CHSM::parent::iterator state = Main.RunControl.Operational.begin(); state != Main.RunControl.Operational.end(); ++state) {
 
          if (state->active()) {
 
            // mimic enter state
 
            enterState(*state, ev_check);
          }
        }
      }
    }

◆ execute()

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

inlineoverrideprivatevirtualinherited

The method to execute the action.

Parameters

__action	pointer to action method
__event	event that triggered the action

Implements JDAQCHSM.

Definition at line 1028 of file JDAQClient.hh.

    {
      try {
 
        const JDAQStateMachine::ev_daq_event& event = dynamic_cast<const JDAQStateMachine::ev_daq_event&>(__event);
 
        (this->*__action)(event->length, event->buffer);
      }
      catch(const std::exception& error) {
        JErrorStream(logger) << "Error at event " << __event.name() << " \"" << error.what() << "\"; trigger ev_error.";
        ev_error();
      }
    }

◆ getState()

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

inlineprivateinherited

Get current state.

Returns: state

Definition at line 1048 of file JDAQClient.hh.

    {
      for (CHSM::parent::const_iterator state = Main.RunControl.Operational.begin(); state != Main.RunControl.Operational.end(); ++state) {
        if (state->active()) {
          return &(*state);
        }
      }
 
      if (Main.RunControl.Error.active()) {
        return &Main.RunControl.Error;
      }
 
      return NULL;
    }

◆ A1()

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

inherited

Definition at line 344 of file JDAQCHSM.cc.

344{ actionError(); }

JDAQCHSM::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); }

JDAQCHSM::actionInit

virtual void actionInit(int, const char *)

Definition JDAQCHSM.hh:123

JDAQCHSM::execute

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.

350{ execute(&JDAQCHSM::actionConfigure, event); }

JDAQCHSM::actionConfigure

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); }

JDAQCHSM::actionReset

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.

                                                           { 
 
            std::istringstream is(std::string(ev_start->buffer, ev_start->length));
 
            is >> run_number >> detector_id; 
 
            execute(&JDAQCHSM::actionStart, event);
          
            }

◆ A7()

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

inherited

Definition at line 364 of file JDAQCHSM.cc.

364{ execute(&JDAQCHSM::actionQuit, event); }

JDAQCHSM::actionQuit

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); }

JDAQCHSM::actionContinue

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); }

JDAQCHSM::actionStop

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); }

JDAQCHSM::actionPause

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); }

JDAQCHSM::actionRecover

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); }

JDAQCHSM::actionCheck

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); }

JDAQCHSM::actionInput

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.

                                                                                                        {
#line 164 "JDAQCHSM.chsm"
        CHSM_ns_alias::cluster const &state = (CHSM_ns_alias::cluster const&)chsm_state_; actionEnter(); }

◆ 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.

                                                                                                        {
#line 165 "JDAQCHSM.chsm"
        CHSM_ns_alias::cluster const &state = (CHSM_ns_alias::cluster const&)chsm_state_; actionExit();  }

◆ getName()

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

inlineinherited

Get name of state machine.

Returns: name

Definition at line 89 of file JDAQCHSM.hh.

  {
    return name;
  }

◆ getDetectorID()

int JDAQCHSM::getDetectorID ( ) const

inlineinherited

Get detector identifier.

Returns: detector identifier.

Definition at line 100 of file JDAQCHSM.hh.

  { 
    return detector_id; 
  }

◆ getRunNumber()

int JDAQCHSM::getRunNumber ( ) const

inlineinherited

Get run number.

Returns: run number

Definition at line 111 of file JDAQCHSM.hh.

  { 
    return run_number; 
  }

◆ actionEnter()

virtual void JDAQCHSM::actionEnter ( )

inlinevirtualinherited

Interface methods for actions corresponding to state transitions.

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

Definition at line 120 of file JDAQCHSM.hh.

120{}

◆ actionInit()

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

inlinevirtualinherited

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

Definition at line 123 of file JDAQCHSM.hh.

123{}

◆ actionConfigure()

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

inlinevirtualinherited

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

Definition at line 124 of file JDAQCHSM.hh.

124{}

◆ actionPause()

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

inlinevirtualinherited

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

Definition at line 126 of file JDAQCHSM.hh.

126{}

◆ actionContinue()

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

inlinevirtualinherited

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

Definition at line 127 of file JDAQCHSM.hh.

127{}

◆ actionReset()

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

inlinevirtualinherited

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

Definition at line 129 of file JDAQCHSM.hh.

129{}

◆ actionQuit()

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

inlinevirtualinherited

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

Definition at line 130 of file JDAQCHSM.hh.

130{}

◆ 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.

    {
      return hostname;
    }

◆ 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.

    {
      return fullname;
    }

◆ 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.

    {
      return unique_tag;
    }

◆ 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.

    {
      return clock.getDelay();
    }

◆ 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.

    {
      return clock.getInterval();
    }

◆ setClockInterval()

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

inlineinherited

Set interval time.

Parameters

interval_us interval time [us]

Definition at line 165 of file JDAQClient.hh.

    {
      clock.setInterval(interval_us);
    }

◆ resetClock()

void KM3NETDAQ::JDAQClient_t::resetClock ( )

inlineinherited

Reset clock.

Definition at line 174 of file JDAQClient.hh.

    {
      clock.reset();
    }

◆ 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.

    {
      return event_info;
    }

◆ setEventInfo()

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

inlineinherited

Set last event information.

Parameters

info	event information

Definition at line 196 of file JDAQClient.hh.

    {
      this->event_info = info;
    }

Member Data Documentation

◆ SLEEP_TIME_US

const int KM3NETDAQ::JDAQDriver::SLEEP_TIME_US = 500000

static

Definition at line 43 of file JDAQDriver.hh.

◆ timeout_us

int KM3NETDAQ::JDAQDriver::timeout_us

timeout of state transitions [us]

Definition at line 637 of file JDAQDriver.hh.

◆ clientList

JClientList KM3NETDAQ::JDAQDriver::clientList

protected

Definition at line 641 of file JDAQDriver.hh.

◆ is_alive

bool KM3NETDAQ::JDAQDriver::is_alive

protected

Definition at line 642 of file JDAQDriver.hh.

◆ rc_log

std::string KM3NETDAQ::JDAQDriver::rc_log

protected

Definition at line 643 of file JDAQDriver.hh.

◆ server

JSharedPointer<JControlHost> KM3NETDAQ::JDAQClient::server

protectedinherited

message server

Definition at line 834 of file JDAQClient.hh.

◆ logger

JMessageLogger KM3NETDAQ::JDAQClient::logger

protectedinherited

message logger

Definition at line 835 of file JDAQClient.hh.

◆ select

JSelectReader KM3NETDAQ::JDAQClient::select

privateinherited

select call

Definition at line 1064 of file JDAQClient.hh.

◆ parser

JParser KM3NETDAQ::JDAQClient::parser

privateinherited

parser method enter()

Definition at line 1065 of file JDAQClient.hh.

◆ subscription

JSubscriptionList KM3NETDAQ::JDAQClient::subscription

privateinherited

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 52 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 69 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 86 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 103 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 120 of file JDAQCHSM.hh.

                             {}
  virtual void actionExit()  {}
 

◆ 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 137 of file JDAQCHSM.hh.

139 :

140

◆ 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 154 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 171 of file JDAQCHSM.hh.

173 : public JDAQCHSM {

JDAQCHSM

DAQ state machine interface.

Definition JDAQCHSM.hh:25

◆ 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 188 of file JDAQCHSM.hh.

                                       : public CHSM_ns_alias::cluster { // 1
                public:
                        class state_Operational : public CHSM_ns_alias::cluster { // 2

◆ 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 205 of file JDAQCHSM.hh.

                       :
                        static int const children_[];
                } RunControl;

◆ 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 222 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 239 of file JDAQCHSM.hh.

240 : static int const ev_init_transitions[]; public:

241 class ev_init_event : public JDAQStateMachine::ev_daq_event {

JDAQStateMachine::ev_init_transitions

static int const ev_init_transitions[]

Definition JDAQCHSM.hh:69

◆ 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 256 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 273 of file JDAQCHSM.hh.

                 :
                ev_configure_event( CHSM_EVENT_ARGS ) : 
                        JDAQStateMachine::ev_daq_event( CHSM_EVENT_INIT ) { }

◆ 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
}

Definition at line 280 of file JDAQCHSM.hh.

               : static int const ev_start_transitions[]; public:
        class ev_start_event : public JDAQStateMachine::ev_daq_event {
        public:
                typedef JDAQStateMachine::ev_daq_event::param_block base_param_block;
                struct param_block : JDAQStateMachine::ev_daq_event::param_block {
                        param_block( CHSM_ns_alias::event const &, int , const char * );
                protected:
                        virtual ~param_block();
                };
                param_block* operator->() const {
                        return (param_block*)param_block_;
                }
                void operator()( int , const char * );
        protected:
                ev_start_event( CHSM_EVENT_ARGS ) : 
                        JDAQStateMachine::ev_daq_event( CHSM_EVENT_INIT ) { }
                friend class JDAQStateMachine;

◆ 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:

JDAQDriver.hh

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ action

Constructor & Destructor Documentation

◆ JDAQDriver()

Member Function Documentation

◆ enter() [1/2]

◆ actionExit()

◆ enterState()

◆ update() [1/2]

◆ actionStart()

◆ actionStop()

◆ run() [1/3]

◆ run() [2/3]

◆ update() [2/2]

◆ synchronise()

◆ filter() [1/2]

◆ copy()

◆ filter() [2/2]

◆ enter() [2/2]

◆ exit()

◆ isRunning()

◆ replaceEvent()

◆ findEvent()

◆ addSubscription()

◆ addParameter() [1/2]

◆ addParameter() [2/2]

◆ setSelect() [1/2]

◆ setSelect() [2/2]

◆ actionSelect()

◆ actionRunning()

◆ actionInput()

◆ actionTagged()

◆ run() [3/3]

◆ configure()

◆ getMessage()

◆ actionCheck()

◆ execute()

◆ getState()

◆ A1()

◆ A2()

◆ A3()

◆ A4()

◆ A5()

◆ A6()

◆ A7()

◆ A8()

◆ A9()

◆ A10()

◆ A11()

◆ A12()

◆ A13()

◆ A14()

◆ EAM4root()

◆ XAM4root()

◆ getName()

◆ getDetectorID()

◆ getRunNumber()

◆ actionEnter()

◆ actionInit()

◆ actionConfigure()

◆ actionPause()

◆ actionContinue()

◆ actionReset()

◆ actionQuit()

◆ actionError()

◆ actionRecover()

◆ getHostname()

◆ getFullName()

◆ getUniqueTag()

◆ getClockDelay()