Jpp  16.0.0-rc.1
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
KM3NETDAQ::JDAQEventHeader Class Reference

JDAQ event header. More...

#include <JDAQEventHeader.hh>

Inheritance diagram for KM3NETDAQ::JDAQEventHeader:
KM3NETDAQ::JDAQHeader KM3NETDAQ::JDAQTriggerCounter KM3NETDAQ::JDAQTriggerMask KM3NETDAQ::JDAQChronometer KM3NETDAQ::JDAQEvent JTRIGGER::JTriggeredEvent

Public Member Functions

 JDAQEventHeader ()
 Default constructor. More...
 
 JDAQEventHeader (const JDAQChronometer &chronometer, const JDAQTriggerMask &mask=JDAQTriggerMask())
 Constructor. More...
 
const JDAQEventHeadergetDAQEventHeader () 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 JDAQHeadergetDAQHeader () const
 Get DAQ header. More...
 
void setDAQHeader (const JDAQHeader &header)
 Set DAQ header. More...
 
 ClassDef (JDAQHeader, 2)
 
 ClassDef (JDAQChronometer, 3)
 
const JDAQChronometergetDAQChronometer () 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 JDAQTriggerCountergetDAQTriggerCounter () 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 JDAQTriggerMaskgetDAQTriggerMask () 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...
 
JDAQTriggerMaskaddTriggerMask (const JDAQTriggerMask &mask)
 Add trigger bit pattern. More...
 
bool hasTriggerMask (const JDAQTriggerMask &mask) const
 Has trigger bit pattern. More...
 
JDAQTriggerMaskaddTriggerBit (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 JDAQTriggerCountergetInstance ()
 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...
 
JReaderoperator>> (JReader &, JDAQEventHeader &)
 Read DAQ event header from input. More...
 
JWriteroperator<< (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.

33  :
34  JDAQHeader(),
37  overlays(0)
38  {}
JDAQTriggerMask()
Default constructor.
JDAQHeader()
Default constructor.
Definition: JDAQHeader.hh:29
JDAQTriggerCounter()
Default constructor.
KM3NETDAQ::JDAQEventHeader::JDAQEventHeader ( const JDAQChronometer chronometer,
const JDAQTriggerMask mask = JDAQTriggerMask() 
)
inline

Constructor.

Parameters
chronometerDAQ chronometer
masktrigger mask

Definition at line 47 of file JDAQEventHeader.hh.

48  :
49  JDAQHeader(chronometer),
51  JDAQTriggerMask(mask),
52  overlays(0)
53  {}
JDAQTriggerMask()
Default constructor.
JDAQHeader()
Default constructor.
Definition: JDAQHeader.hh:29
JDAQTriggerCounter()
Default constructor.

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.

62  {
63  return static_cast<const JDAQEventHeader&>(*this);
64  }
bool KM3NETDAQ::JDAQEventHeader::is_same ( const JDAQEventHeader header) const
inline

Check if header is same.

Parameters
headerDAQ event header
Returns
true if event headers are same; else false

Definition at line 73 of file JDAQEventHeader.hh.

74  {
75  return (this->getDetectorID() == header.getDetectorID() &&
76  this->getRunNumber() == header.getRunNumber() &&
77  this->getFrameIndex() == header.getFrameIndex() &&
78  this->getCounter() == header.getCounter());
79  }
int getDetectorID() const
Get detector identifier.
int getRunNumber() const
Get run number.
int getFrameIndex() const
Get frame index.
JTriggerCounter_t getCounter() const
Get trigger counter.
unsigned int KM3NETDAQ::JDAQEventHeader::getOverlays ( ) const
inline

Get number of overlays.

Returns
number of overlays

Definition at line 87 of file JDAQEventHeader.hh.

88  {
89  return overlays;
90  }
KM3NETDAQ::JDAQEventHeader::ClassDef ( JDAQEventHeader  ,
 
)
const JDAQHeader& KM3NETDAQ::JDAQHeader::getDAQHeader ( ) const
inlineinherited

Get DAQ header.

Returns
DAQ header

Definition at line 49 of file JDAQHeader.hh.

50  {
51  return static_cast<const JDAQHeader&>(*this);
52  }
void KM3NETDAQ::JDAQHeader::setDAQHeader ( const JDAQHeader header)
inlineinherited

Set DAQ header.

Parameters
headerDAQ header

Definition at line 60 of file JDAQHeader.hh.

61  {
62  static_cast<JDAQHeader&>(*this) = header;
63  }
KM3NETDAQ::JDAQHeader::ClassDef ( JDAQHeader  ,
 
)
inherited
KM3NETDAQ::JDAQChronometer::ClassDef ( JDAQChronometer  ,
 
)
inherited
const JDAQChronometer& KM3NETDAQ::JDAQChronometer::getDAQChronometer ( ) const
inlineinherited

Get DAQ chronometer.

Returns
DAQ chronometer

Definition at line 88 of file JDAQChronometer.hh.

89  {
90  return static_cast<const JDAQChronometer&>(*this);
91  }
void KM3NETDAQ::JDAQChronometer::setDAQChronometer ( const JDAQChronometer chronometer)
inlineinherited

Set DAQ chronometer.

Parameters
chronometerDAQ chronometer

Definition at line 99 of file JDAQChronometer.hh.

100  {
101  static_cast<JDAQChronometer&>(*this) = chronometer;
102  }
int KM3NETDAQ::JDAQChronometer::getDetectorID ( ) const
inlineinherited

Get detector identifier.

Returns
detector identifier

Definition at line 110 of file JDAQChronometer.hh.

111  {
112  return detector_id;
113  }
int KM3NETDAQ::JDAQChronometer::getRunNumber ( ) const
inlineinherited

Get run number.

Returns
run number

Definition at line 121 of file JDAQChronometer.hh.

122  {
123  return run;
124  }
int KM3NETDAQ::JDAQChronometer::getFrameIndex ( ) const
inlineinherited

Get frame index.

Returns
frame index

Definition at line 132 of file JDAQChronometer.hh.

133  {
134  return frame_index;
135  }
JDAQUTCExtended KM3NETDAQ::JDAQChronometer::getTimesliceStart ( ) const
inlineinherited

Get start of timeslice.

Returns
timeslice start

Definition at line 144 of file JDAQChronometer.hh.

145  {
146  return timeslice_start;
147  }
void KM3NETDAQ::JDAQChronometer::setRunNumber ( const int  run)
inlineinherited

Set run number.

Parameters
runrun number

Definition at line 155 of file JDAQChronometer.hh.

156  {
157  this->run = run;
158  }
void KM3NETDAQ::JDAQChronometer::setFrameIndex ( const int  frame_index)
inlineinherited

Set frame index.

Parameters
frame_indexframe index

Definition at line 166 of file JDAQChronometer.hh.

167  {
168  this->frame_index = frame_index;
169  }
void KM3NETDAQ::JDAQChronometer::setTimesliceStart ( const JDAQUTCExtended timeslice_start)
inlineinherited

Set timeslice start time.

Parameters
timeslice_starttimeslice start time

Definition at line 177 of file JDAQChronometer.hh.

178  {
179  this->timeslice_start = timeslice_start;
180  }
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.

67  {
68  static JDAQTriggerCounter counter(0);
69 
70  return counter;
71  }
Auxiliary class to count triggers.
const JDAQTriggerCounter& KM3NETDAQ::JDAQTriggerCounter::getDAQTriggerCounter ( ) const
inlineinherited

Get DAQ trigger counter.

Returns
DAQ trigger counter

Definition at line 79 of file JDAQTriggerCounter.hh.

80  {
81  return static_cast<const JDAQTriggerCounter&>(*this);
82  }
Auxiliary class to count triggers.
static void KM3NETDAQ::JDAQTriggerCounter::reset ( )
inlinestaticinherited

Reset counter of unique instance of this class object.

Definition at line 88 of file JDAQTriggerCounter.hh.

89  {
91  }
static JDAQTriggerCounter & getInstance()
Get reference to unique instance of this class object.
JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::getCounter ( ) const
inlineinherited

Get trigger counter.

Returns
counter value

Definition at line 99 of file JDAQTriggerCounter.hh.

100  {
101  return trigger_counter;
102  }
void KM3NETDAQ::JDAQTriggerCounter::setCounter ( const JTriggerCounter_t  counter)
inlineinherited

Set trigger counter.

Parameters
countercounter value

Definition at line 110 of file JDAQTriggerCounter.hh.

111  {
112  this->trigger_counter = counter;
113  }
JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::next ( )
inlineinherited

Increment trigger counter.

Returns
counter value

Definition at line 121 of file JDAQTriggerCounter.hh.

122  {
123  return trigger_counter++;
124  }
KM3NETDAQ::JDAQTriggerCounter::ClassDef ( JDAQTriggerCounter  ,
 
)
inherited
const JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::getDAQTriggerMask ( ) const
inlineinherited

Get DAQ trigger mask.

Returns
DAQ trigger mask

Definition at line 95 of file JDAQTriggerMask.hh.

96  {
97  return static_cast<const JDAQTriggerMask&>(*this);
98  }
Auxiliary class for trigger mask.
JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::getTriggerMask ( ) const
inlineinherited

Get trigger mask.

Returns
trigger mask

Definition at line 106 of file JDAQTriggerMask.hh.

107  {
108  return trigger_mask;
109  }
void KM3NETDAQ::JDAQTriggerMask::setDAQTriggerMask ( const JDAQTriggerMask mask)
inlineinherited

Set trigger mask.

Parameters
masktrigger mask

Definition at line 117 of file JDAQTriggerMask.hh.

118  {
119  trigger_mask = mask.trigger_mask;
120  }
void KM3NETDAQ::JDAQTriggerMask::setTriggerMask ( const JTriggerMask_t  mask)
inlineinherited

Set trigger mask.

Parameters
masktrigger mask

Definition at line 128 of file JDAQTriggerMask.hh.

129  {
130  trigger_mask = mask;
131  }
JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerMask ( const JDAQTriggerMask mask)
inlineinherited

Add trigger bit pattern.

Parameters
masktrigger mask
Returns
trigger mask

Definition at line 140 of file JDAQTriggerMask.hh.

141  {
142  trigger_mask |= mask.trigger_mask;
143 
144  return *this;
145  }
bool KM3NETDAQ::JDAQTriggerMask::hasTriggerMask ( const JDAQTriggerMask mask) const
inlineinherited

Has trigger bit pattern.

Parameters
masktrigger mask
Returns
true if one of the bits is set; else false

Definition at line 154 of file JDAQTriggerMask.hh.

155  {
156  return trigger_mask & mask.trigger_mask;
157  }
JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerBit ( const unsigned int  bit)
inlineinherited

Add trigger bit.

Parameters
bittrigger bit
Returns
trigger mask

Definition at line 166 of file JDAQTriggerMask.hh.

167  {
169 
170  return *this;
171  }
JTriggerMask_t getTriggerMask(const unsigned int bit)
Convert trigger bit to trigger mask.
bool KM3NETDAQ::JDAQTriggerMask::hasTriggerBit ( const unsigned int  bit) const
inlineinherited

Check trigger bit.

Parameters
bittrigger bit
Returns
true if bit is set; else false

Definition at line 180 of file JDAQTriggerMask.hh.

181  {
183  }
JTriggerMask_t getTriggerMask(const unsigned int bit)
Convert trigger bit to trigger mask.
static JDAQTriggerMask KM3NETDAQ::JDAQTriggerMask::valueOf ( const std::string &  buffer)
inlinestaticinherited

Extract trigger mask.

Parameters
buffertrigger bit pattern (i.e. sequence of '0' and '1').
Returns
trigger mask

Definition at line 192 of file JDAQTriggerMask.hh.

193  {
195 
196  unsigned int bit = 0;
197 
198  for (std::string::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
199  if (*i == '1') {
200  trigger_mask.addTriggerBit(bit);
201  }
202  }
203 
204  return trigger_mask;
205  }
static const unsigned int NUMBER_OF_TRIGGER_BITS
Number of trigger bits.
Auxiliary class for trigger mask.
JDAQTriggerMask & addTriggerBit(const unsigned int bit)
Add trigger bit.
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.

214  {
215  std::string buffer(NUMBER_OF_TRIGGER_BITS, '0');
216 
217  unsigned int bit = 0;
218 
219  for (std::string::reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
220  if (hasTriggerBit(bit)) {
221  *i = '1';
222  }
223  }
224 
225  return buffer;
226  }
bool hasTriggerBit(const unsigned int bit) const
Check trigger bit.
static const unsigned int NUMBER_OF_TRIGGER_BITS
Number of trigger bits.
KM3NETDAQ::JDAQTriggerMask::ClassDef ( JDAQTriggerMask  ,
 
)
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
inreader
headerDAQ event header
Returns
reader

Definition at line 40 of file JDAQEventHeaderIO.hh.

41  {
42  in >> static_cast<JDAQHeader&> (header);
43  in >> static_cast<JDAQTriggerCounter&>(header);
44  in >> static_cast<JDAQTriggerMask&> (header);
45  in >> header.overlays;
46 
47  return in;
48  }
Auxiliary class for trigger mask.
Auxiliary class to count triggers.
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:42
JWriter& operator<< ( JWriter out,
const JDAQEventHeader header 
)
friend

Write DAQ event header to output.

Parameters
outwriter
headerDAQ event header
Returns
writer

Definition at line 58 of file JDAQEventHeaderIO.hh.

59  {
60  out << static_cast<const JDAQHeader&> (header);
61  out << static_cast<const JDAQTriggerCounter&>(header);
62  out << static_cast<const JDAQTriggerMask&> (header);
63  out << header.overlays;
64 
65  return out;
66  }

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: