Jpp 19.3.0-rc.3
the software that should make you happy
Loading...
Searching...
No Matches
KM3NETDAQ::JDAQTriggerMask Class Reference

Auxiliary class for trigger mask. More...

#include <JDAQTriggerMask.hh>

Inheritance diagram for KM3NETDAQ::JDAQTriggerMask:
JTRIGGER::JEvent JTRIGGER::JTriggeredHit KM3NETDAQ::JDAQEventHeader KM3NETDAQ::JDAQTriggeredHit JRECONSTRUCTION::JARCAMuonReconstruction::input_type JRECONSTRUCTION::JMultiThreadedReconstruction< JFit_t >::output_type JRECONSTRUCTION::JMuonEnergy::input_type JRECONSTRUCTION::JMuonGandalf::input_type JRECONSTRUCTION::JMuonPrefit::input_type JRECONSTRUCTION::JMuonSimplex::input_type JRECONSTRUCTION::JMuonStart::input_type JRECONSTRUCTION::JORCAMuonReconstruction::input_type JRECONSTRUCTION::JORCAReconstruction::input_type JRECONSTRUCTION::JORCAShowerReconstruction::input_type JRECONSTRUCTION::JShowerDirectionPrefit::input_type JRECONSTRUCTION::JShowerFit::input_type JRECONSTRUCTION::JShowerPointSimplex::input_type JRECONSTRUCTION::JShowerPositionFit::input_type JRECONSTRUCTION::JShowerPrefit::input_type KM3NETDAQ::JDAQEvent

Public Member Functions

 JDAQTriggerMask ()
 Default constructor.
 
 JDAQTriggerMask (const JTriggerMask_t mask)
 Constructor.
 
 JDAQTriggerMask (const std::string &buffer)
 Constructor.
 
virtual ~JDAQTriggerMask ()
 Virtual destructor.
 
const JDAQTriggerMaskgetDAQTriggerMask () const
 Get DAQ trigger mask.
 
JTriggerMask_t getTriggerMask () const
 Get trigger mask.
 
void setDAQTriggerMask (const JDAQTriggerMask &mask)
 Set trigger mask.
 
void setTriggerMask (const JTriggerMask_t mask)
 Set trigger mask.
 
JDAQTriggerMaskaddTriggerMask (const JDAQTriggerMask &mask)
 Add trigger bit pattern.
 
bool hasTriggerMask (const JDAQTriggerMask &mask) const
 Has trigger bit pattern.
 
JDAQTriggerMaskaddTriggerBit (const unsigned int bit)
 Add trigger bit.
 
bool hasTriggerBit (const unsigned int bit) const
 Check trigger bit.
 
std::string toString () const
 Convert trigger mask.
 
 ClassDef (JDAQTriggerMask, 1)
 

Static Public Member Functions

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

Protected Attributes

JTriggerMask_t trigger_mask
 

Friends

size_t getSizeof ()
 Definition of method to get size of data type.
 
JReaderoperator>> (JReader &in, JDAQTriggerMask &mask)
 Read DAQ trigger mask from input.
 
JWriteroperator<< (JWriter &out, const JDAQTriggerMask &mask)
 Write DAQ trigger mask to output.
 
std::istream & operator>> (std::istream &in, JDAQTriggerMask &mask)
 Read JDAQTriggerMask from input stream.
 
std::ostream & operator<< (std::ostream &out, const JDAQTriggerMask &mask)
 Write JDAQTriggerMask to output stream.
 

Detailed Description

Auxiliary class for trigger mask.

Definition at line 48 of file JDAQTriggerMask.hh.

Constructor & Destructor Documentation

◆ JDAQTriggerMask() [1/3]

KM3NETDAQ::JDAQTriggerMask::JDAQTriggerMask ( )
inline

Default constructor.

Definition at line 58 of file JDAQTriggerMask.hh.

58 :
60 {}

◆ JDAQTriggerMask() [2/3]

KM3NETDAQ::JDAQTriggerMask::JDAQTriggerMask ( const JTriggerMask_t mask)
inline

Constructor.

Parameters
masktrigger mask

Definition at line 68 of file JDAQTriggerMask.hh.

68 :
69 trigger_mask(mask)
70 {}

◆ JDAQTriggerMask() [3/3]

KM3NETDAQ::JDAQTriggerMask::JDAQTriggerMask ( const std::string & buffer)
inline

Constructor.

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

Definition at line 78 of file JDAQTriggerMask.hh.

78 :
80 {}
static JDAQTriggerMask valueOf(const std::string &buffer)
Extract trigger mask.
JTriggerMask_t getTriggerMask() const
Get trigger mask.

◆ ~JDAQTriggerMask()

virtual KM3NETDAQ::JDAQTriggerMask::~JDAQTriggerMask ( )
inlinevirtual

Virtual destructor.

Definition at line 86 of file JDAQTriggerMask.hh.

87 {}

Member Function Documentation

◆ getDAQTriggerMask()

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

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.

◆ getTriggerMask()

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

Get trigger mask.

Returns
trigger mask

Definition at line 106 of file JDAQTriggerMask.hh.

107 {
108 return trigger_mask;
109 }

◆ setDAQTriggerMask()

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

Set trigger mask.

Parameters
masktrigger mask

Definition at line 117 of file JDAQTriggerMask.hh.

118 {
120 }

◆ setTriggerMask()

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

Set trigger mask.

Parameters
masktrigger mask

Definition at line 128 of file JDAQTriggerMask.hh.

129 {
130 trigger_mask = mask;
131 }

◆ addTriggerMask()

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

Add trigger bit pattern.

Parameters
masktrigger mask
Returns
trigger mask

Definition at line 140 of file JDAQTriggerMask.hh.

141 {
143
144 return *this;
145 }

◆ hasTriggerMask()

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

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 }

◆ addTriggerBit()

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

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.

◆ hasTriggerBit()

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

Check trigger bit.

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

Definition at line 180 of file JDAQTriggerMask.hh.

181 {
183 }

◆ valueOf()

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

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 }

◆ toString()

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

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.

◆ ClassDef()

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

Friends And Related Symbol Documentation

◆ getSizeof

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

◆ operator>> [1/2]

JReader & operator>> ( JReader & in,
JDAQTriggerMask & mask )
friend

Read DAQ trigger mask from input.

Parameters
inreader
maskDAQ trigger mask
Returns
reader

Definition at line 32 of file JDAQTriggerMaskIO.hh.

33 {
34 in >> mask.trigger_mask;
35
36 return in;
37 }

◆ operator<< [1/2]

JWriter & operator<< ( JWriter & out,
const JDAQTriggerMask & mask )
friend

Write DAQ trigger mask to output.

Parameters
outwriter
maskDAQ trigger mask
Returns
writer

Definition at line 47 of file JDAQTriggerMaskIO.hh.

48 {
49 out << mask.trigger_mask;
50
51 return out;
52 }

◆ operator>> [2/2]

std::istream & operator>> ( std::istream & in,
JDAQTriggerMask & mask )
friend

Read JDAQTriggerMask from input stream.

Parameters
ininput stream
maskJDAQTriggerMask
Returns
input stream

Definition at line 236 of file JDAQTriggerMask.hh.

237 {
238 std::string buffer;
239
240 if (in >> buffer) {
241 mask= JDAQTriggerMask::valueOf(buffer);
242 }
243
244 return in;
245 }

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream & out,
const JDAQTriggerMask & mask )
friend

Write JDAQTriggerMask to output stream.

Parameters
outoutput stream
maskJDAQTriggerMask
Returns
output stream

Definition at line 255 of file JDAQTriggerMask.hh.

256 {
257 out << mask.toString();
258
259 return out;
260 }
std::string toString() const
Convert trigger mask.

Member Data Documentation

◆ trigger_mask

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::trigger_mask
protected

Definition at line 267 of file JDAQTriggerMask.hh.


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