Runcontrol client to simulate data filter(s). More...

Inheritance diagram for KM3NETDAQ::JEventGenerator:

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

virtual void	actionConfigure (int length, const char *buffer)

virtual void	actionReset (int length, const char *buffer)

virtual void	actionQuit (int length, const char *buffer)

virtual void	actionStart (int length, const char *buffer)

virtual void	actionStop (int length, const char *buffer)

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 bool	enter (const JArgs &args)
	Enter the state machine. More...

virtual bool	enter ()
	Enter the state machine. More...

virtual bool	exit ()
	Exit the state machine. More...

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

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

int	getEventNumber () const
	Get last event number. More...

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

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

JDAQEvent_t *	findEvent (const JNET::JTag &tag, const std::string &event_name)
	Find event in event table. 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...

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

const std::string &	getHostname () const
	Get hostname. 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...

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	actionInput (int length, const char *buffer)
	This method is called at `ev_input`. More...

virtual bool	filter (const std::string &tag, int length, const char *buffer)
	Filter message. 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...

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

Protected Attributes
JSharedPointer< JControlHost >	server
	message server More...

JMessageLogger	logger
	message logger More...

Private Attributes
JSharedPointer< JControlHost >	datawriter

JTRIGGER::JTriggerParameters	parameters

JSUPPORT::JMultipleFileScanner < KM3NETDAQ::JDAQEvent >	inputFile

Long64_t	numberOfEvents

double	eventRate_Hz

JEEP::JTimer	timer

long long int	numberOfBytes

Detailed Description

Runcontrol client to simulate data filter(s).

In state running, this application will send events to the data writer.

Definition at line 34 of file JEventGenerator.cc.

Constructor & Destructor Documentation

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

inline

Constructor.

Parameters

name	name of client
server	name of command message server
logger	pointer to logger
level	debug level

Definition at line 46 of file JEventGenerator.cc.

                                               :
       JDAQClient(name, server, logger, level),
       datawriter()      
     {
       replaceEvent(RC_CMD, RC_EVTGENERATOR, ev_configure);
 
       JControlHost::Throw(true);
     }

Member Function Documentation

virtual void KM3NETDAQ::JEventGenerator::actionConfigure	(	int	length,
		const char *	buffer
	)

inlinevirtual

Definition at line 59 of file JEventGenerator.cc.

     {
       using namespace std;
       using namespace JPP;
 
       inputFile.clear();
 
       JString destination;
 
       JProperties properties(JEquationParameters("=", ";", "", ""));
 
       properties["datawriter"]     = destination  = "localhost";
       properties["inputFile"]      = inputFile;
       properties["eventRate_Hz"]   = eventRate_Hz = 1.0;
       
       properties.read(string(buffer, length));
       
       destination = destination.trim();
 
       try {
         datawriter.reset(new JControlHost(destination));
       }
       catch(const JControlHostException& exception) {
         JErrorStream(logger) << exception;
       }
 
       if (eventRate_Hz > 0.0)
         setClockInterval((long long int) (1.0e6 / eventRate_Hz));
       else
         setClockInterval(0ULL);
 
       parameters = getTriggerParameters(inputFile);
 
       JDebugStream(logger) << "Event interval time " << getClockInterval() << " us";
     }

virtual void KM3NETDAQ::JEventGenerator::actionReset	(	int	length,
		const char *	buffer
	)

inlinevirtual

Definition at line 96 of file JEventGenerator.cc.

     {
       JDebugStream(logger) << "actionReset()";
 
       inputFile.rewind();
 
       datawriter.reset();
     }

virtual void KM3NETDAQ::JEventGenerator::actionQuit	(	int	length,
		const char *	buffer
	)

inlinevirtual

Definition at line 106 of file JEventGenerator.cc.

107 {}

virtual void KM3NETDAQ::JEventGenerator::actionStart	(	int	length,
		const char *	buffer
	)

inlinevirtual

Definition at line 110 of file JEventGenerator.cc.

     {
       using namespace std;
       
       numberOfEvents = 0;
       numberOfBytes  = 0;
 
       ostringstream os;
 
       os << getRunNumber() << ' ' << parameters;
 
       datawriter->PutFullString(IO_TRIGGER_PARAMETERS, os.str());
 
       timer.reset();
     }

virtual void KM3NETDAQ::JEventGenerator::actionStop	(	int	length,
		const char *	buffer
	)

inlinevirtual

Definition at line 127 of file JEventGenerator.cc.

     {
       JDebugStream(logger) << "actionStop()";
 
       if (timer.usec_wall > 0) JNoticeStream(logger) << "I/O [MB/s] "       << numberOfBytes   / timer.usec_wall;
       if (numberOfEvents  > 0) JNoticeStream(logger) << "Delay/event [ms] " << getClockDelay() / numberOfEvents / 1000;
     }

virtual void KM3NETDAQ::JEventGenerator::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 from KM3NETDAQ::JDAQClient.

Definition at line 136 of file JEventGenerator.cc.

     {
       //JDebugStream(logger) << "actionRunning()";
 
       using namespace JPP;
 
       static JIO::JByteArrayWriter out;
 
       if (datawriter.is_valid()) {
 
         if (!inputFile.hasNext()) {
           inputFile.rewind();
         }
 
         if (inputFile.hasNext()) {
 
           timer.start();
           
           JDAQEvent* event = inputFile.next();
           
           event->setRunNumber(getRunNumber());
           
           out.clear();
           
           out << *event;
           
           try {
             
             datawriter->PutFullData(IO_EVENT, out.data(), out.size());
             
             numberOfEvents += 1;
             numberOfBytes  += out.size();
           }
           catch(const JControlHostException& exception) {
             JErrorStream(logger) << exception;
           }
           
           timer.stop();
         }
       }
 
       //JDebugStream(logger) << "actionRunning() return";
     }

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

Definition at line 143 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 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 JControlHostException& error) {
         cerr << error << endl;
         return false;
       }
     }

virtual bool KM3NETDAQ::JDAQClient::enter ( )

inlinevirtualinherited

Enter the state machine.

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

Reimplemented in KM3NETDAQ::JDAQDriver.

Definition at line 195 of file JDAQClient.hh.

     {
       using namespace std;
 
       if (server.is_valid() && logger.is_valid()) {
 
         try {
           
           server->Subscribe(getSubscription(eventTable));
           server->SendMeAlways();
           server->MyId(getFullName());
           
           return CHSM::machine::enter();
         }
         catch(const JControlHostException& error) {
           JErrorStream(logger) << error;
         }
 
       } else {
         cerr << "Message server or logger not properly initialised." << endl;
       }
 
       return false;
     }

virtual bool KM3NETDAQ::JDAQClient::exit ( )

inlinevirtualinherited

Exit the state machine.

This method releases the various resources.

Definition at line 225 of file JDAQClient.hh.

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

const std::string& KM3NETDAQ::JDAQClient::getFullName ( ) const

inlineinherited

Get full name of this run control client.

Returns: full name

Definition at line 248 of file JDAQClient.hh.

     {
       return full_name;
     }

const JNET::JTag& KM3NETDAQ::JDAQClient::getUniqueTag ( ) const

inlineinherited

Get unique tag of this run control client.

Returns: unique tag

Definition at line 259 of file JDAQClient.hh.

     {
       return unique_tag;
     }

int KM3NETDAQ::JDAQClient::getEventNumber ( ) const

inlineinherited

Get last event number.

Returns: event number

Definition at line 270 of file JDAQClient.hh.

     {
       return event_number;
     }

bool KM3NETDAQ::JDAQClient::isRunning ( ) const

inlineinherited

Check if this client is in runnig state.

Returns: true if running; else false

Definition at line 281 of file JDAQClient.hh.

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

void KM3NETDAQ::JDAQClient::replaceEvent	(	const JNET::JTag &	oldTag,
		const JNET::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 294 of file JDAQClient.hh.

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

JDAQEvent_t* KM3NETDAQ::JDAQClient::findEvent	(	const JNET::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 309 of file JDAQClient.hh.

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

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 327 of file JDAQClient.hh.

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

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 341 of file JDAQClient.hh.

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

long long int KM3NETDAQ::JDAQClient::getClockDelay ( ) const

inlineinherited

Get total delay time.

Returns: delay time [us]

Definition at line 352 of file JDAQClient.hh.

     {
       return clock.getDelay();
     }

const std::string& KM3NETDAQ::JDAQClient::getHostname ( ) const

inlineinherited

Get hostname.

Returns: host name

Definition at line 363 of file JDAQClient.hh.

     {
       return hostname;
     }

long long int KM3NETDAQ::JDAQClient::getClockInterval ( ) const

inlineinherited

Get interval time.

Returns: interval time [us]

Definition at line 374 of file JDAQClient.hh.

     {
       return clock.getInterval();
     }

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

inlineinherited

Set interval time.

Parameters

interval_us interval time [us]

Definition at line 385 of file JDAQClient.hh.

     {
       clock.setInterval(interval_us);
     }

void KM3NETDAQ::JDAQClient::resetClock ( )

inlineinherited

Reset clock.

Definition at line 394 of file JDAQClient.hh.

     {
       clock.reset();
     }

void KM3NETDAQ::JDAQClient::setSelect ( )

inlineinherited

Set the file descriptor mask for the select call.

Definition at line 403 of file JDAQClient.hh.

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

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::JDataWriter, and KM3NETDAQ::MonitorRouter.

Definition at line 419 of file JDAQClient.hh.

420 {}

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::JDataWriter, and KM3NETDAQ::MonitorRouter.

Definition at line 429 of file JDAQClient.hh.

430 {}

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

inlinevirtualinherited

This method is called at ev_input.

Parameters

length	length of data
buffer	pointer to data

Reimplemented in AcousticDataFilter.

Definition at line 450 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);
     }

virtual bool KM3NETDAQ::JDAQClient::filter	(	const std::string &	tag,
		int	length,
		const char *	buffer
	)

inlinevirtualinherited

Filter message.

The filter method can be overloaded 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

Definition at line 477 of file JDAQClient.hh.

     {
       return false;
     }

void KM3NETDAQ::JDAQClient::run ( )

inlineinherited

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 493 of file JDAQClient.hh.

     {
       using namespace std;
 
       while (active()) {
 
         try {
 
           setSelect();
 
           if (select(JTimeval(TIMEOUT_S,0)) > 0) {
             
             if (select.hasReaderMask(*server)) {
               update();
             }
             
             actionSelect(select.getReaderMask());
 
           } else {
 
             continue;
           }
 
 
           if (isRunning() && clock.getInterval() != 0LL) {
 
             long long int numberOfCalls = 0;
             
             clock.reset();
             
             do {
               
               ++numberOfCalls;
               
               setSelect();
 
               if (clock.wait(select.getReaderMask())) {
                 
                 if (select.hasReaderMask(*server)) {
                   update();
                 }
 
                 actionSelect(select.getReaderMask());
 
               } else {
 
                 try {
                   actionRunning();
                 }
                 catch(const exception& error) {
                   logger.error(error.what());
                 }             
               }
 
             } while (isRunning());
             
             if (numberOfCalls != 0) {
               JNoticeStream(logger) << "Delay per call " << clock.getDelay() / numberOfCalls / 1000 << " ms";
             }
           }
         }
         catch(const exception& error) {
           JErrorStream(logger) << "method run(): " << error.what();
         }
       }
     }

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 573 of file JDAQClient.hh.

     {
       JControlHostServer server(port);
 
       for ( ; ; ) {
 
         JControlHost* ps = 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();
       }
     }

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

inlineinherited

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

Example input format:

<tag> <event name>[#data];
<tag> <event name>[#data];

Parameters

in	input stream

Definition at line 618 of file JDAQClient.hh.

     {
       using std::string;
 
       string tag;
       string buffer;
 
       while (in >> tag && getline(in, buffer, ';')) {
         update(tag, buffer.length(), buffer.data());
       }
     }

Member Data Documentation

JSharedPointer<JControlHost> KM3NETDAQ::JEventGenerator::datawriter

private

Definition at line 182 of file JEventGenerator.cc.

JTRIGGER::JTriggerParameters KM3NETDAQ::JEventGenerator::parameters

private

Definition at line 184 of file JEventGenerator.cc.

JSUPPORT::JMultipleFileScanner<KM3NETDAQ::JDAQEvent> KM3NETDAQ::JEventGenerator::inputFile

private

Definition at line 185 of file JEventGenerator.cc.

Long64_t KM3NETDAQ::JEventGenerator::numberOfEvents

private

Definition at line 187 of file JEventGenerator.cc.

double KM3NETDAQ::JEventGenerator::eventRate_Hz

private

Definition at line 188 of file JEventGenerator.cc.

JEEP::JTimer KM3NETDAQ::JEventGenerator::timer

private

Definition at line 190 of file JEventGenerator.cc.

long long int KM3NETDAQ::JEventGenerator::numberOfBytes

private

Definition at line 191 of file JEventGenerator.cc.

const int KM3NETDAQ::JDAQClient::TIMEOUT_S = 1

staticinherited

time out of update [s]

Definition at line 631 of file JDAQClient.hh.

JSharedPointer<JControlHost> KM3NETDAQ::JDAQClient::server

protectedinherited

message server

Definition at line 635 of file JDAQClient.hh.

JMessageLogger KM3NETDAQ::JDAQClient::logger

protectedinherited

message logger

Definition at line 636 of file JDAQClient.hh.

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

JEventGenerator.cc

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation