Jpp
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
KM3NETDAQ::JDAQTriggerCounter Class Reference

Auxiliary class to count triggers. More...

#include <JDAQTriggerCounter.hh>

Inheritance diagram for KM3NETDAQ::JDAQTriggerCounter:
KM3NETDAQ::JDAQEventHeader KM3NETDAQ::JDAQEvent JTRIGGER::JTriggeredEvent

Public Member Functions

 JDAQTriggerCounter ()
 Default constructor. More...
 
virtual ~JDAQTriggerCounter ()
 Virtual destructor. 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)
 

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

Protected Attributes

JTriggerCounter_t trigger_counter
 

Private Member Functions

 JDAQTriggerCounter (const JTriggerCounter_t counter)
 Constructor. More...
 

Friends

JReaderoperator>> (JReader &in, JDAQTriggerCounter &counter)
 Read JDAQTriggerCounter from input. More...
 
JWriteroperator<< (JWriter &out, const JDAQTriggerCounter &counter)
 Write JDAQTriggerCounter to output. More...
 

Detailed Description

Auxiliary class to count triggers.

Definition at line 27 of file JDAQTriggerCounter.hh.

Constructor & Destructor Documentation

◆ JDAQTriggerCounter() [1/2]

KM3NETDAQ::JDAQTriggerCounter::JDAQTriggerCounter ( const JTriggerCounter_t  counter)
inlineprivate

Constructor.

Parameters
countercounter value

Definition at line 34 of file JDAQTriggerCounter.hh.

35  {
36  this->trigger_counter = counter;
37  }

◆ JDAQTriggerCounter() [2/2]

KM3NETDAQ::JDAQTriggerCounter::JDAQTriggerCounter ( )
inline

Default constructor.

This constructor increments the counter of the unique instance of this class and stores the result in this object.

Definition at line 47 of file JDAQTriggerCounter.hh.

48  {
50  }

◆ ~JDAQTriggerCounter()

virtual KM3NETDAQ::JDAQTriggerCounter::~JDAQTriggerCounter ( )
inlinevirtual

Virtual destructor.

Definition at line 56 of file JDAQTriggerCounter.hh.

57  {}

Member Function Documentation

◆ getInstance()

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

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
inline

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 ( )
inlinestatic

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
inline

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)
inline

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 ( )
inline

Increment trigger counter.

Returns
counter value

Definition at line 120 of file JDAQTriggerCounter.hh.

121  {
122  return trigger_counter++;
123  }

◆ sizeOf()

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

Get size of object.

Returns
number of bytes

Definition at line 161 of file JDAQTriggerCounter.hh.

162  {
163  return sizeof(JTriggerCounter_t);
164  }

◆ ClassDef()

KM3NETDAQ::JDAQTriggerCounter::ClassDef ( JDAQTriggerCounter  ,
 
)

Friends And Related Function Documentation

◆ operator>>

JReader& operator>> ( JReader in,
JDAQTriggerCounter counter 
)
friend

Read JDAQTriggerCounter from input.

Parameters
inJReader
counterJDAQTriggerCounter
Returns
JReader

Definition at line 133 of file JDAQTriggerCounter.hh.

134  {
135  in >> counter.trigger_counter;
136 
137  return in;
138  }

◆ operator<<

JWriter& operator<< ( JWriter out,
const JDAQTriggerCounter counter 
)
friend

Write JDAQTriggerCounter to output.

Parameters
outJWriter
counterJDAQTriggerCounter
Returns
JWriter

Definition at line 148 of file JDAQTriggerCounter.hh.

149  {
150  out << counter.trigger_counter;
151 
152  return out;
153  }

Member Data Documentation

◆ trigger_counter

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::trigger_counter
protected

Definition at line 171 of file JDAQTriggerCounter.hh.


The documentation for this class was generated from the following file:
KM3NETDAQ::JDAQTriggerCounter::trigger_counter
JTriggerCounter_t trigger_counter
Definition: JDAQTriggerCounter.hh:171
KM3NETDAQ::JDAQTriggerCounter::JDAQTriggerCounter
JDAQTriggerCounter()
Default constructor.
Definition: JDAQTriggerCounter.hh:47
KM3NETDAQ::JDAQTriggerCounter::next
JTriggerCounter_t next()
Increment trigger counter.
Definition: JDAQTriggerCounter.hh:120
KM3NETDAQ::JTriggerCounter_t
unsigned long long int JTriggerCounter_t
Type definition of trigger counter.
Definition: JDAQTriggerCounter.hh:21
KM3NETDAQ::JDAQTriggerCounter::getInstance
static JDAQTriggerCounter & getInstance()
Get reference to unique instance of this class object.
Definition: JDAQTriggerCounter.hh:65