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

DAQ triggered hit. More...

#include <JDAQTriggeredHit.hh>

Inheritance diagram for KM3NETDAQ::JDAQTriggeredHit:
KM3NETDAQ::JDAQKeyHit KM3NETDAQ::JDAQTriggerMask KM3NETDAQ::JDAQModuleIdentifier KM3NETDAQ::JDAQHit

Public Types

typedef unsigned char JPMT_t
 PMT channel in FPGA. More...
 
typedef unsigned int JTDC_t
 leading edge [ns] More...
 
typedef unsigned char JTOT_t
 time over threshold [ns] More...
 

Public Member Functions

 JDAQTriggeredHit ()
 Default constructor. More...
 
 JDAQTriggeredHit (const JDAQModuleIdentifier &ID, const JDAQHit &hit, const JDAQTriggerMask &mask)
 Constructor. More...
 
virtual ~JDAQTriggeredHit ()
 Virtual destructor. More...
 
 ClassDef (JDAQTriggeredHit, 2)
 
 operator JDAQPMTIdentifier () const
 Type conversion operator. More...
 
 ClassDef (JDAQKeyHit, 1)
 
const JDAQModuleIdentifiergetModuleIdentifier () const
 Get Module identifier. More...
 
void setModuleIdentifier (const JDAQModuleIdentifier &module)
 Set Module identifier. More...
 
int getModuleID () const
 Get module identifier. More...
 
 ClassDefNV (JDAQModuleIdentifier, 1)
 
 ClassDefNV (JDAQHit, 1)
 
JPMT_t getPMT () const
 Get PMT. More...
 
JTDC_t getT () const
 Get time. More...
 
JTOT_t getToT () const
 Get time-over-threshold. More...
 
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 JTOT_t getMaximalToT ()
 Get maximal time-over-threshold. More...
 
static JDAQTriggerMask valueOf (const std::string &buffer)
 Extract trigger mask. More...
 

Protected Attributes

int id
 
JPMT_t pmt
 PMT readout channel in FPGA. More...
 
JTDC_t tdc
 leading edge [ns] More...
 
JTOT_t tot
 time over threshold [ns] More...
 
JTriggerMask_t trigger_mask
 

Friends

size_t getSizeof ()
 Definition of method to get size of data type. More...
 
JReaderoperator>> (JReader &, JDAQTriggeredHit &)
 Read DAQ triggered hit from input. More...
 
JWriteroperator<< (JWriter &, const JDAQTriggeredHit &)
 Write DAQ triggered hit to output. More...
 

Detailed Description

DAQ triggered hit.

Definition at line 20 of file JDAQTriggeredHit.hh.

Member Typedef Documentation

typedef unsigned char KM3NETDAQ::JDAQHit::JPMT_t
inherited

PMT channel in FPGA.

Definition at line 38 of file JDAQHit.hh.

typedef unsigned int KM3NETDAQ::JDAQHit::JTDC_t
inherited

leading edge [ns]

Definition at line 39 of file JDAQHit.hh.

typedef unsigned char KM3NETDAQ::JDAQHit::JTOT_t
inherited

time over threshold [ns]

Definition at line 40 of file JDAQHit.hh.

Constructor & Destructor Documentation

KM3NETDAQ::JDAQTriggeredHit::JDAQTriggeredHit ( )
inline

Default constructor.

Definition at line 33 of file JDAQTriggeredHit.hh.

33  :
34  JDAQKeyHit (),
36  {}
JDAQKeyHit()
Default constructor.
Definition: JDAQKeyHit.hh:32
JDAQTriggerMask()
Default constructor.
KM3NETDAQ::JDAQTriggeredHit::JDAQTriggeredHit ( const JDAQModuleIdentifier ID,
const JDAQHit hit,
const JDAQTriggerMask mask 
)
inline

Constructor.

Parameters
IDmodule identifier
hitPMT hit
masktrigger mask

Definition at line 46 of file JDAQTriggeredHit.hh.

48  :
49  JDAQKeyHit(ID,hit),
50  JDAQTriggerMask(mask)
51  {}
JDAQKeyHit()
Default constructor.
Definition: JDAQKeyHit.hh:32
JDAQTriggerMask()
Default constructor.
virtual KM3NETDAQ::JDAQTriggeredHit::~JDAQTriggeredHit ( )
inlinevirtual

Virtual destructor.

Definition at line 57 of file JDAQTriggeredHit.hh.

58  {}

Member Function Documentation

KM3NETDAQ::JDAQTriggeredHit::ClassDef ( JDAQTriggeredHit  ,
 
)
KM3NETDAQ::JDAQKeyHit::operator JDAQPMTIdentifier ( ) const
inlineinherited

Type conversion operator.

Returns
axis

Definition at line 63 of file JDAQKeyHit.hh.

64  {
65  return JDAQPMTIdentifier(this->getModuleID(), this->getPMT());
66  }
int getModuleID() const
Get module identifier.
JPMT_t getPMT() const
Get PMT.
Definition: JDAQHit.hh:75
KM3NETDAQ::JDAQKeyHit::ClassDef ( JDAQKeyHit  ,
 
)
inherited
const JDAQModuleIdentifier& KM3NETDAQ::JDAQModuleIdentifier::getModuleIdentifier ( ) const
inlineinherited

Get Module identifier.

Returns
Module identifier

Definition at line 50 of file JDAQModuleIdentifier.hh.

51  {
52  return *this;
53  }
void KM3NETDAQ::JDAQModuleIdentifier::setModuleIdentifier ( const JDAQModuleIdentifier module)
inlineinherited

Set Module identifier.

Parameters
moduleModule identifier

Definition at line 61 of file JDAQModuleIdentifier.hh.

62  {
63  *this = module;
64  }
int KM3NETDAQ::JDAQModuleIdentifier::getModuleID ( ) const
inlineinherited

Get module identifier.

Returns
module identifier

Definition at line 72 of file JDAQModuleIdentifier.hh.

73  {
74  return id;
75  }
KM3NETDAQ::JDAQModuleIdentifier::ClassDefNV ( JDAQModuleIdentifier  ,
 
)
inherited
KM3NETDAQ::JDAQHit::ClassDefNV ( JDAQHit  ,
 
)
inherited
JPMT_t KM3NETDAQ::JDAQHit::getPMT ( ) const
inlineinherited

Get PMT.

Returns
PMT

Definition at line 75 of file JDAQHit.hh.

76  {
77  return pmt;
78  }
JPMT_t pmt
PMT readout channel in FPGA.
Definition: JDAQHit.hh:158
JTDC_t KM3NETDAQ::JDAQHit::getT ( ) const
inlineinherited

Get time.

Returns
time [ns]

Definition at line 86 of file JDAQHit.hh.

87  {
88  return ntohl(tdc);
89  }
JTDC_t tdc
leading edge [ns]
Definition: JDAQHit.hh:159
JTOT_t KM3NETDAQ::JDAQHit::getToT ( ) const
inlineinherited

Get time-over-threshold.

Returns
time-over-threshold [ns]

Definition at line 97 of file JDAQHit.hh.

98  {
99  return tot;
100  }
JTOT_t tot
time over threshold [ns]
Definition: JDAQHit.hh:160
static JTOT_t KM3NETDAQ::JDAQHit::getMaximalToT ( )
inlinestaticinherited

Get maximal time-over-threshold.

Returns
time-over-threshold [ns]

Definition at line 108 of file JDAQHit.hh.

109  {
110  return 0xFF;
111  }
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.
then awk string
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,
JDAQTriggeredHit hit 
)
friend

Read DAQ triggered hit from input.

Parameters
inreader
hitDAQ triggered hit
Returns
reader

Definition at line 36 of file JDAQTriggeredHitIO.hh.

37  {
38  in >> static_cast<JDAQKeyHit&> (hit);
39  in >> static_cast<JDAQTriggerMask&>(hit);
40 
41  return in;
42  }
DAQ key hit.
Definition: JDAQKeyHit.hh:19
Auxiliary class for trigger mask.
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 JAcoustics sh $DETECTOR_ID source JAcousticsToolkit sh CHECK_EXIT_CODE typeset A EMITTERS get_tripods $WORKDIR tripod txt EMITTERS get_transmitters $WORKDIR transmitter txt EMITTERS for EMITTER in
Definition: JCanberra.sh:46
JWriter& operator<< ( JWriter out,
const JDAQTriggeredHit hit 
)
friend

Write DAQ triggered hit to output.

Parameters
outwriter
hitDAQ triggered hit
Returns
writer

Definition at line 52 of file JDAQTriggeredHitIO.hh.

53  {
54  out << static_cast<const JDAQKeyHit&> (hit);
55  out << static_cast<const JDAQTriggerMask&>(hit);
56 
57  return out;
58  }

Member Data Documentation

int KM3NETDAQ::JDAQModuleIdentifier::id
protectedinherited

Definition at line 112 of file JDAQModuleIdentifier.hh.

JPMT_t KM3NETDAQ::JDAQHit::pmt
protectedinherited

PMT readout channel in FPGA.

Definition at line 158 of file JDAQHit.hh.

JTDC_t KM3NETDAQ::JDAQHit::tdc
protectedinherited

leading edge [ns]

Definition at line 159 of file JDAQHit.hh.

JTOT_t KM3NETDAQ::JDAQHit::tot
protectedinherited

time over threshold [ns]

Definition at line 160 of file JDAQHit.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: