JDAQ event header. More...

#include <JDAQEventHeader.hh>

Inheritance diagram for KM3NETDAQ::JDAQEventHeader:

Public Member Functions
	JDAQEventHeader ()
	Default constructor. More...

	JDAQEventHeader (const JDAQChronometer &chronometer, const JDAQTriggerMask &mask=JDAQTriggerMask())
	Constructor. More...

const JDAQEventHeader &	getDAQEventHeader () const
	Get DAQ event header. More...

bool	is_same (const JDAQEventHeader &header) const
	Check if header is same. More...

unsigned int	getOverlays () const
	Get number of overlays. More...

	ClassDef (JDAQEventHeader, 3)

const JDAQHeader &	getDAQHeader () const
	Get DAQ header. More...

void	setDAQHeader (const JDAQHeader &header)
	Set DAQ header. More...

	ClassDef (JDAQHeader, 2)

	ClassDef (JDAQChronometer, 3)

const JDAQChronometer &	getDAQChronometer () const
	Get DAQ chronometer. More...

void	setDAQChronometer (const JDAQChronometer &chronometer)
	Set DAQ chronometer. More...

int	getDetectorID () const
	Get detector identifier. More...

int	getRunNumber () const
	Get run number. More...

int	getFrameIndex () const
	Get frame index. More...

JDAQUTCExtended	getTimesliceStart () const
	Get start of timeslice. More...

void	setRunNumber (const int run)
	Set run number. More...

void	setFrameIndex (const int frame_index)
	Set frame index. More...

void	setTimesliceStart (const JDAQUTCExtended &timeslice_start)
	Set timeslice start time. More...

const JDAQTriggerCounter &	getDAQTriggerCounter () const
	Get DAQ trigger counter. More...

JTriggerCounter_t	getCounter () const
	Get trigger counter. More...

void	setCounter (const JTriggerCounter_t counter)
	Set trigger counter. More...

JTriggerCounter_t	next ()
	Increment trigger counter. More...

	ClassDef (JDAQTriggerCounter, 1)

const JDAQTriggerMask &	getDAQTriggerMask () const
	Get DAQ trigger mask. More...

JTriggerMask_t	getTriggerMask () const
	Get trigger mask. More...

void	setDAQTriggerMask (const JDAQTriggerMask &mask)
	Set trigger mask. More...

void	setTriggerMask (const JTriggerMask_t mask)
	Set trigger mask. More...

JDAQTriggerMask &	addTriggerMask (const JDAQTriggerMask &mask)
	Add trigger bit pattern. More...

bool	hasTriggerMask (const JDAQTriggerMask &mask) const
	Has trigger bit pattern. More...

JDAQTriggerMask &	addTriggerBit (const unsigned int bit)
	Add trigger bit. More...

bool	hasTriggerBit (const unsigned int bit) const
	Check trigger bit. More...

std::string	toString () const
	Convert trigger mask. More...

	ClassDef (JDAQTriggerMask, 1)

Static Public Member Functions
static JDAQTriggerCounter &	getInstance ()
	Get reference to unique instance of this class object. More...

static void	reset ()
	Reset counter of unique instance of this class object. More...

static JDAQTriggerMask	valueOf (const std::string &buffer)
	Extract trigger mask. More...

Protected Attributes
unsigned int	overlays

int	detector_id

int	run

int	frame_index

JDAQUTCExtended	timeslice_start

JTriggerCounter_t	trigger_counter

JTriggerMask_t	trigger_mask

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...

JReader &	operator>> (JReader &, JDAQEventHeader &)
	Read DAQ event header from input. More...

JWriter &	operator<< (JWriter &, const JDAQEventHeader &)
	Write DAQ event header to output. More...

Detailed Description

JDAQ event header.

Definition at line 19 of file JDAQEventHeader.hh.

Constructor & Destructor Documentation

KM3NETDAQ::JDAQEventHeader::JDAQEventHeader ( )

inline

Default constructor.

Definition at line 33 of file JDAQEventHeader.hh.

                       :
       JDAQHeader(),
       JDAQTriggerCounter(),
       JDAQTriggerMask(),
       overlays(0)
     {}

KM3NETDAQ::JDAQEventHeader::JDAQEventHeader	(	const JDAQChronometer &	chronometer,
		const JDAQTriggerMask &	mask = `JDAQTriggerMask()`
	)

inline

Constructor.

Parameters

chronometer	DAQ chronometer
mask	trigger mask

Definition at line 47 of file JDAQEventHeader.hh.

                                                                      :
       JDAQHeader(chronometer),
       JDAQTriggerCounter(),
       JDAQTriggerMask(mask),
       overlays(0)
     {}

Member Function Documentation

const JDAQEventHeader& KM3NETDAQ::JDAQEventHeader::getDAQEventHeader ( ) const

inline

Get DAQ event header.

Returns: DAQ event header

Definition at line 61 of file JDAQEventHeader.hh.

     {
       return static_cast<const JDAQEventHeader&>(*this);
     }

bool KM3NETDAQ::JDAQEventHeader::is_same ( const JDAQEventHeader & header ) const

inline

Check if header is same.

Parameters

header DAQ event header

Returns: true if event headers are same; else false

Definition at line 73 of file JDAQEventHeader.hh.

     {
       return (this->getDetectorID() == header.getDetectorID() &&
               this->getRunNumber()  == header.getRunNumber()  &&
               this->getFrameIndex() == header.getFrameIndex() &&
               this->getCounter()    == header.getCounter());
     }

unsigned int KM3NETDAQ::JDAQEventHeader::getOverlays ( ) const

inline

Get number of overlays.

Returns: number of overlays

Definition at line 87 of file JDAQEventHeader.hh.

     {
       return overlays;
     }

KM3NETDAQ::JDAQEventHeader::ClassDef	(	JDAQEventHeader	,
		3
	)

const JDAQHeader& KM3NETDAQ::JDAQHeader::getDAQHeader ( ) const

inlineinherited

Get DAQ header.

Returns: DAQ header

Definition at line 49 of file JDAQHeader.hh.

     { 
       return static_cast<const JDAQHeader&>(*this); 
     }

void KM3NETDAQ::JDAQHeader::setDAQHeader ( const JDAQHeader & header )

inlineinherited

Set DAQ header.

Parameters

header DAQ header

Definition at line 60 of file JDAQHeader.hh.

     { 
       static_cast<JDAQHeader&>(*this) = header;
     }

KM3NETDAQ::JDAQHeader::ClassDef	(	JDAQHeader	,
		2
	)

inherited

KM3NETDAQ::JDAQChronometer::ClassDef	(	JDAQChronometer	,
		3
	)

inherited

const JDAQChronometer& KM3NETDAQ::JDAQChronometer::getDAQChronometer ( ) const

inlineinherited

Get DAQ chronometer.

Returns: DAQ chronometer

Definition at line 88 of file JDAQChronometer.hh.

     { 
       return static_cast<const JDAQChronometer&>(*this); 
     }

void KM3NETDAQ::JDAQChronometer::setDAQChronometer ( const JDAQChronometer & chronometer )

inlineinherited

Set DAQ chronometer.

Parameters

chronometer DAQ chronometer

Definition at line 99 of file JDAQChronometer.hh.

     { 
       static_cast<JDAQChronometer&>(*this) = chronometer;
     }

int KM3NETDAQ::JDAQChronometer::getDetectorID ( ) const

inlineinherited

Get detector identifier.

Returns: detector identifier

Definition at line 110 of file JDAQChronometer.hh.

     { 
       return detector_id; 
     }

int KM3NETDAQ::JDAQChronometer::getRunNumber ( ) const

inlineinherited

Get run number.

Returns: run number

Definition at line 121 of file JDAQChronometer.hh.

     { 
       return run; 
     }

int KM3NETDAQ::JDAQChronometer::getFrameIndex ( ) const

inlineinherited

Get frame index.

Returns: frame index

Definition at line 132 of file JDAQChronometer.hh.

     { 
       return frame_index; 
     }

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::getTimesliceStart ( ) const

inlineinherited

Get start of timeslice.

Returns: timeslice start

Definition at line 144 of file JDAQChronometer.hh.

     {
       return timeslice_start;
     }

void KM3NETDAQ::JDAQChronometer::setRunNumber ( const int run )

inlineinherited

Set run number.

Parameters

run	run number

Definition at line 155 of file JDAQChronometer.hh.

     { 
       this->run = run;
     }

void KM3NETDAQ::JDAQChronometer::setFrameIndex ( const int frame_index )

inlineinherited

Set frame index.

Parameters

frame_index frame index

Definition at line 166 of file JDAQChronometer.hh.

     { 
       this->frame_index = frame_index;
     }

void KM3NETDAQ::JDAQChronometer::setTimesliceStart ( const JDAQUTCExtended & timeslice_start )

inlineinherited

Set timeslice start time.

Parameters

timeslice_start timeslice start time

Definition at line 177 of file JDAQChronometer.hh.

     {
       this->timeslice_start = timeslice_start;
     }

static JDAQTriggerCounter& KM3NETDAQ::JDAQTriggerCounter::getInstance ( )

inlinestaticinherited

Get reference to unique instance of this class object.

Returns: reference to this class object

Definition at line 66 of file JDAQTriggerCounter.hh.

     {
       static JDAQTriggerCounter counter(0);
 
       return counter;
     }

const JDAQTriggerCounter& KM3NETDAQ::JDAQTriggerCounter::getDAQTriggerCounter ( ) const

inlineinherited

Get DAQ trigger counter.

Returns: DAQ trigger counter

Definition at line 79 of file JDAQTriggerCounter.hh.

     {
       return static_cast<const JDAQTriggerCounter&>(*this);
     }

static void KM3NETDAQ::JDAQTriggerCounter::reset ( )

inlinestaticinherited

Reset counter of unique instance of this class object.

Definition at line 88 of file JDAQTriggerCounter.hh.

     {
       getInstance().trigger_counter = 0;
     }

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::getCounter ( ) const

inlineinherited

Get trigger counter.

Returns: counter value

Definition at line 99 of file JDAQTriggerCounter.hh.

     {
       return trigger_counter;
     }

void KM3NETDAQ::JDAQTriggerCounter::setCounter ( const JTriggerCounter_t counter )

inlineinherited

Set trigger counter.

Parameters

counter counter value

Definition at line 110 of file JDAQTriggerCounter.hh.

     {
       this->trigger_counter = counter;
     }

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::next ( )

inlineinherited

Increment trigger counter.

Returns: counter value

Definition at line 121 of file JDAQTriggerCounter.hh.

     {
       return trigger_counter++;
     }

KM3NETDAQ::JDAQTriggerCounter::ClassDef	(	JDAQTriggerCounter	,
		1
	)

inherited

const JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::getDAQTriggerMask ( ) const

inlineinherited

Get DAQ trigger mask.

Returns: DAQ trigger mask

Definition at line 95 of file JDAQTriggerMask.hh.

     {
       return static_cast<const JDAQTriggerMask&>(*this);
     }

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::getTriggerMask ( ) const

inlineinherited

Get trigger mask.

Returns: trigger mask

Definition at line 106 of file JDAQTriggerMask.hh.

     {
       return trigger_mask;
     }

void KM3NETDAQ::JDAQTriggerMask::setDAQTriggerMask ( const JDAQTriggerMask & mask )

inlineinherited

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 117 of file JDAQTriggerMask.hh.

     {
       trigger_mask = mask.trigger_mask;
     }

void KM3NETDAQ::JDAQTriggerMask::setTriggerMask ( const JTriggerMask_t mask )

inlineinherited

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 128 of file JDAQTriggerMask.hh.

     {
       trigger_mask = mask;
     }

JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerMask ( const JDAQTriggerMask & mask )

inlineinherited

Add trigger bit pattern.

Parameters

mask	trigger mask

Returns: trigger mask

Definition at line 140 of file JDAQTriggerMask.hh.

     {
       trigger_mask |= mask.trigger_mask;
 
       return *this;
     }

bool KM3NETDAQ::JDAQTriggerMask::hasTriggerMask ( const JDAQTriggerMask & mask ) const

inlineinherited

Has trigger bit pattern.

Parameters

mask	trigger mask

Returns: true if one of the bits is set; else false

Definition at line 154 of file JDAQTriggerMask.hh.

     {
       return trigger_mask & mask.trigger_mask;
     }

JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerBit ( const unsigned int bit )

inlineinherited

Add trigger bit.

Parameters

bit	trigger bit

Returns: trigger mask

Definition at line 166 of file JDAQTriggerMask.hh.

     {
       trigger_mask |= KM3NETDAQ::getTriggerMask(bit);
 
       return *this;
     }

bool KM3NETDAQ::JDAQTriggerMask::hasTriggerBit ( const unsigned int bit ) const

inlineinherited

Check trigger bit.

Parameters

bit	trigger bit

Returns: true if bit is set; else false

Definition at line 180 of file JDAQTriggerMask.hh.

     {
       return trigger_mask & KM3NETDAQ::getTriggerMask(bit);
     }

static JDAQTriggerMask KM3NETDAQ::JDAQTriggerMask::valueOf ( const std::string & buffer )

inlinestaticinherited

Extract trigger mask.

Parameters

buffer trigger bit pattern (i.e. sequence of '0' and '1').

Returns: trigger mask

Definition at line 192 of file JDAQTriggerMask.hh.

     {
       JDAQTriggerMask trigger_mask;
 
       unsigned int bit = 0;
 
       for (std::string::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
         if (*i == '1') {
           trigger_mask.addTriggerBit(bit);
         }
       }
 
       return trigger_mask;
     }

std::string KM3NETDAQ::JDAQTriggerMask::toString ( ) const

inlineinherited

Convert trigger mask.

Returns: trigger bit pattern (i.e. sequence of '0' and '1').

Definition at line 213 of file JDAQTriggerMask.hh.

     {
       std::string buffer(NUMBER_OF_TRIGGER_BITS, '0');
 
       unsigned int bit = 0;
 
       for (std::string::reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
         if (hasTriggerBit(bit)) {
           *i = '1';
         }
       }
 
       return buffer;
     }

KM3NETDAQ::JDAQTriggerMask::ClassDef	(	JDAQTriggerMask	,
		1
	)

inherited

Friends And Related Function Documentation

size_t getSizeof ( )

friend

Definition of method to get size of data type.

This method should be specialised for each desired data type with fixed length.

Returns: number of bytes

JReader& operator>>	(	JReader &	in,
		JDAQEventHeader &	header
	)

friend

Read DAQ event header from input.

Parameters

in	reader
header	DAQ event header

Returns: reader

Definition at line 40 of file JDAQEventHeaderIO.hh.

   {
     in >> static_cast<JDAQHeader&>        (header);
     in >> static_cast<JDAQTriggerCounter&>(header);
     in >> static_cast<JDAQTriggerMask&>   (header);
     in >> header.overlays;
 
     return in;
   }

JWriter& operator<<	(	JWriter &	out,
		const JDAQEventHeader &	header
	)

friend

Write DAQ event header to output.

Parameters

out	writer
header	DAQ event header

Returns: writer

Definition at line 58 of file JDAQEventHeaderIO.hh.

   {
     out << static_cast<const JDAQHeader&>        (header);
     out << static_cast<const JDAQTriggerCounter&>(header);
     out << static_cast<const JDAQTriggerMask&>   (header);
     out << header.overlays;
 
     return out;
   }

Member Data Documentation

unsigned int KM3NETDAQ::JDAQEventHeader::overlays

protected

Definition at line 97 of file JDAQEventHeader.hh.

int KM3NETDAQ::JDAQChronometer::detector_id

protectedinherited

Definition at line 187 of file JDAQChronometer.hh.

int KM3NETDAQ::JDAQChronometer::run

protectedinherited

Definition at line 188 of file JDAQChronometer.hh.

int KM3NETDAQ::JDAQChronometer::frame_index

protectedinherited

Definition at line 189 of file JDAQChronometer.hh.

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::timeslice_start

protectedinherited

Definition at line 190 of file JDAQChronometer.hh.

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::trigger_counter

protectedinherited

Definition at line 131 of file JDAQTriggerCounter.hh.

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::trigger_mask

protectedinherited

Definition at line 267 of file JDAQTriggerMask.hh.

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

JDAQEventHeader.hh

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation