Jpp
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 int sizeOf ()
 Get size of object. More...
 
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

JReaderoperator>> (JReader &in, JDAQEventHeader &header)
 Read DAQ event header from input. More...
 
JWriteroperator<< (JWriter &out, const JDAQEventHeader &header)
 Write DAQ event header to output. More...
 

Detailed Description

JDAQ event header.

Definition at line 24 of file JDAQEventHeader.hh.

Constructor & Destructor Documentation

◆ JDAQEventHeader() [1/2]

KM3NETDAQ::JDAQEventHeader::JDAQEventHeader ( )
inline

Default constructor.

Definition at line 33 of file JDAQEventHeader.hh.

33  :
34  JDAQHeader(),
37  overlays(0)
38  {}

◆ JDAQEventHeader() [2/2]

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

Member Function Documentation

◆ getDAQEventHeader()

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  }

◆ is_same()

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  }

◆ getOverlays()

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  }

◆ sizeOf()

static int KM3NETDAQ::JDAQEventHeader::sizeOf ( )
inlinestatic

Get size of object.

Returns
number of bytes

Definition at line 134 of file JDAQEventHeader.hh.

135  {
136  return (JDAQHeader ::sizeOf() +
139  sizeof(unsigned int));
140  }

◆ ClassDef() [1/5]

KM3NETDAQ::JDAQEventHeader::ClassDef ( JDAQEventHeader  ,
 
)

◆ getDAQHeader()

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

Get DAQ header.

Returns
DAQ header

Definition at line 51 of file JDAQHeader.hh.

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

◆ setDAQHeader()

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

Set DAQ header.

Parameters
headerDAQ header

Definition at line 62 of file JDAQHeader.hh.

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

◆ ClassDef() [2/5]

KM3NETDAQ::JDAQHeader::ClassDef ( JDAQHeader  ,
 
)
inherited

◆ ClassDef() [3/5]

KM3NETDAQ::JDAQChronometer::ClassDef ( JDAQChronometer  ,
 
)
inherited

◆ getDAQChronometer()

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  }

◆ setDAQChronometer()

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  }

◆ getDetectorID()

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  }

◆ getRunNumber()

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  }

◆ getFrameIndex()

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  }

◆ getTimesliceStart()

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  }

◆ setRunNumber()

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  }

◆ setFrameIndex()

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  }

◆ setTimesliceStart()

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  {
180  }

◆ getInstance()

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

Get reference to unique instance of this class object.

Returns
reference to this class object

Definition at line 65 of file JDAQTriggerCounter.hh.

66  {
67  static JDAQTriggerCounter counter(0);
68 
69  return counter;
70  }

◆ getDAQTriggerCounter()

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

Get DAQ trigger counter.

Returns
DAQ trigger counter

Definition at line 78 of file JDAQTriggerCounter.hh.

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

◆ reset()

static void KM3NETDAQ::JDAQTriggerCounter::reset ( )
inlinestaticinherited

Reset counter of unique instance of this class object.

Definition at line 87 of file JDAQTriggerCounter.hh.

88  {
90  }

◆ getCounter()

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::getCounter ( ) const
inlineinherited

Get trigger counter.

Returns
counter value

Definition at line 98 of file JDAQTriggerCounter.hh.

99  {
100  return trigger_counter;
101  }

◆ setCounter()

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

Set trigger counter.

Parameters
countercounter value

Definition at line 109 of file JDAQTriggerCounter.hh.

110  {
111  this->trigger_counter = counter;
112  }

◆ next()

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::next ( )
inlineinherited

Increment trigger counter.

Returns
counter value

Definition at line 120 of file JDAQTriggerCounter.hh.

121  {
122  return trigger_counter++;
123  }

◆ ClassDef() [4/5]

KM3NETDAQ::JDAQTriggerCounter::ClassDef ( JDAQTriggerCounter  ,
 
)
inherited

◆ getDAQTriggerMask()

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

Get DAQ trigger mask.

Returns
DAQ trigger mask

Definition at line 94 of file JDAQTriggerMask.hh.

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

◆ getTriggerMask()

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::getTriggerMask ( ) const
inlineinherited

Get trigger mask.

Returns
trigger mask

Definition at line 105 of file JDAQTriggerMask.hh.

106  {
107  return trigger_mask;
108  }

◆ setDAQTriggerMask()

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

Set trigger mask.

Parameters
masktrigger mask

Definition at line 116 of file JDAQTriggerMask.hh.

117  {
118  trigger_mask = mask.trigger_mask;
119  }

◆ setTriggerMask()

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

Set trigger mask.

Parameters
masktrigger mask

Definition at line 127 of file JDAQTriggerMask.hh.

128  {
129  trigger_mask = mask;
130  }

◆ addTriggerMask()

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

Add trigger bit pattern.

Parameters
masktrigger mask
Returns
trigger mask

Definition at line 139 of file JDAQTriggerMask.hh.

140  {
141  trigger_mask |= mask.trigger_mask;
142 
143  return *this;
144  }

◆ hasTriggerMask()

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 153 of file JDAQTriggerMask.hh.

154  {
155  return trigger_mask & mask.trigger_mask;
156  }

◆ addTriggerBit()

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

Add trigger bit.

Parameters
bittrigger bit
Returns
trigger mask

Definition at line 165 of file JDAQTriggerMask.hh.

166  {
168 
169  return *this;
170  }

◆ hasTriggerBit()

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 179 of file JDAQTriggerMask.hh.

180  {
182  }

◆ valueOf()

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 191 of file JDAQTriggerMask.hh.

192  {
194 
195  unsigned int bit = 0;
196 
197  for (std::string::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
198  if (*i == '1') {
199  trigger_mask.addTriggerBit(bit);
200  }
201  }
202 
203  return trigger_mask;
204  }

◆ toString()

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

Convert trigger mask.

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

Definition at line 212 of file JDAQTriggerMask.hh.

213  {
214  std::string buffer(NUMBER_OF_TRIGGER_BITS, '0');
215 
216  unsigned int bit = 0;
217 
218  for (std::string::reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
219  if (hasTriggerBit(bit)) {
220  *i = '1';
221  }
222  }
223 
224  return buffer;
225  }

◆ ClassDef() [5/5]

KM3NETDAQ::JDAQTriggerMask::ClassDef ( JDAQTriggerMask  ,
 
)
inherited

Friends And Related Function Documentation

◆ operator>>

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

Read DAQ event header from input.

Parameters
inJReader
headerJDAQEventHeader
Returns
JReader

Definition at line 100 of file JDAQEventHeader.hh.

101  {
102  in >> static_cast<JDAQHeader&> (header);
103  in >> static_cast<JDAQTriggerCounter&>(header);
104  in >> static_cast<JDAQTriggerMask&> (header);
105  in >> header.overlays;
106 
107  return in;
108  }

◆ operator<<

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

Write DAQ event header to output.

Parameters
outJWriter
headerJDAQEventHeader
Returns
JWriter

Definition at line 118 of file JDAQEventHeader.hh.

119  {
120  out << static_cast<const JDAQHeader&> (header);
121  out << static_cast<const JDAQTriggerCounter&>(header);
122  out << static_cast<const JDAQTriggerMask&> (header);
123  out << header.overlays;
124 
125  return out;
126  }

Member Data Documentation

◆ overlays

unsigned int KM3NETDAQ::JDAQEventHeader::overlays
protected

Definition at line 147 of file JDAQEventHeader.hh.

◆ detector_id

int KM3NETDAQ::JDAQChronometer::detector_id
protectedinherited

Definition at line 237 of file JDAQChronometer.hh.

◆ run

int KM3NETDAQ::JDAQChronometer::run
protectedinherited

Definition at line 238 of file JDAQChronometer.hh.

◆ frame_index

int KM3NETDAQ::JDAQChronometer::frame_index
protectedinherited

Definition at line 239 of file JDAQChronometer.hh.

◆ timeslice_start

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::timeslice_start
protectedinherited

Definition at line 240 of file JDAQChronometer.hh.

◆ trigger_counter

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::trigger_counter
protectedinherited

Definition at line 171 of file JDAQTriggerCounter.hh.

◆ trigger_mask

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::trigger_mask
protectedinherited

Definition at line 307 of file JDAQTriggerMask.hh.


The documentation for this class was generated from the following file:
KM3NETDAQ::JDAQTriggerCounter::sizeOf
static int sizeOf()
Get size of object.
Definition: JDAQTriggerCounter.hh:161
KM3NETDAQ::JDAQChronometer::timeslice_start
JDAQUTCExtended timeslice_start
Definition: JDAQChronometer.hh:240
KM3NETDAQ::JDAQTriggerCounter::getCounter
JTriggerCounter_t getCounter() const
Get trigger counter.
Definition: JDAQTriggerCounter.hh:98
KM3NETDAQ::JDAQTriggerCounter::trigger_counter
JTriggerCounter_t trigger_counter
Definition: JDAQTriggerCounter.hh:171
KM3NETDAQ::JDAQTriggerMask::trigger_mask
JTriggerMask_t trigger_mask
Definition: JDAQTriggerMask.hh:307
KM3NETDAQ::JDAQChronometer::getFrameIndex
int getFrameIndex() const
Get frame index.
Definition: JDAQChronometer.hh:132
KM3NETDAQ::JDAQHeader::JDAQHeader
JDAQHeader()
Default constructor.
Definition: JDAQHeader.hh:31
KM3NETDAQ::JDAQTriggerCounter::JDAQTriggerCounter
JDAQTriggerCounter()
Default constructor.
Definition: JDAQTriggerCounter.hh:47
KM3NETDAQ::NUMBER_OF_TRIGGER_BITS
static const unsigned int NUMBER_OF_TRIGGER_BITS
Number of trigger bits.
Definition: JDAQTriggerMask.hh:31
KM3NETDAQ::JDAQChronometer::getDetectorID
int getDetectorID() const
Get detector identifier.
Definition: JDAQChronometer.hh:110
KM3NETDAQ::getTriggerMask
JTriggerMask_t getTriggerMask(const unsigned int bit)
Convert trigger bit to trigger mask.
Definition: JDAQTriggerMask.hh:40
KM3NETDAQ::JDAQTriggerMask::sizeOf
static int sizeOf()
Get size of object.
Definition: JDAQTriggerMask.hh:297
KM3NETDAQ::JDAQTriggerMask::JDAQTriggerMask
JDAQTriggerMask()
Default constructor.
Definition: JDAQTriggerMask.hh:57
KM3NETDAQ::JDAQChronometer::frame_index
int frame_index
Definition: JDAQChronometer.hh:239
KM3NETDAQ::JDAQHeader::sizeOf
static int sizeOf()
Get size of object.
Definition: JDAQHeader.hh:103
KM3NETDAQ::JDAQChronometer::getRunNumber
int getRunNumber() const
Get run number.
Definition: JDAQChronometer.hh:121
KM3NETDAQ::JDAQEventHeader::overlays
unsigned int overlays
Definition: JDAQEventHeader.hh:147
KM3NETDAQ::JDAQTriggerMask::hasTriggerBit
bool hasTriggerBit(const unsigned int bit) const
Check trigger bit.
Definition: JDAQTriggerMask.hh:179
KM3NETDAQ::JDAQChronometer::run
int run
Definition: JDAQChronometer.hh:238
KM3NETDAQ::JDAQTriggerCounter::getInstance
static JDAQTriggerCounter & getInstance()
Get reference to unique instance of this class object.
Definition: JDAQTriggerCounter.hh:65
KM3NETDAQ::JDAQChronometer::detector_id
int detector_id
Definition: JDAQChronometer.hh:237