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...
 

Protected Attributes

JTriggerCounter_t trigger_counter
 

Private Member Functions

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

Friends

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

Detailed Description

Auxiliary class to count triggers.

Definition at line 23 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 30 of file JDAQTriggerCounter.hh.

31  {
32  this->trigger_counter = counter;
33  }

◆ 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 48 of file JDAQTriggerCounter.hh.

49  {
51  }

◆ ~JDAQTriggerCounter()

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

Virtual destructor.

Definition at line 57 of file JDAQTriggerCounter.hh.

58  {}

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 66 of file JDAQTriggerCounter.hh.

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

◆ getDAQTriggerCounter()

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

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  }

◆ reset()

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

Reset counter of unique instance of this class object.

Definition at line 88 of file JDAQTriggerCounter.hh.

89  {
91  }

◆ getCounter()

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

Get trigger counter.

Returns
counter value

Definition at line 99 of file JDAQTriggerCounter.hh.

100  {
101  return trigger_counter;
102  }

◆ setCounter()

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

Set trigger counter.

Parameters
countercounter value

Definition at line 110 of file JDAQTriggerCounter.hh.

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

◆ next()

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::next ( )
inline

Increment trigger counter.

Returns
counter value

Definition at line 121 of file JDAQTriggerCounter.hh.

122  {
123  return trigger_counter++;
124  }

◆ ClassDef()

KM3NETDAQ::JDAQTriggerCounter::ClassDef ( JDAQTriggerCounter  ,
 
)

Friends And Related Function 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>>

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

Read DAQ trigger counter from input.

Parameters
inreader
counterDAQ trigger counter
Returns
reader

Definition at line 32 of file JDAQTriggerCounterIO.hh.

33  {
34  in >> counter.trigger_counter;
35 
36  return in;
37  }

◆ operator<<

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

Write JDAQTriggerCounter to output.

Parameters
outwriter
counterDAQ trigger counter
Returns
writer

Definition at line 47 of file JDAQTriggerCounterIO.hh.

48  {
49  out << counter.trigger_counter;
50 
51  return out;
52  }

Member Data Documentation

◆ trigger_counter

JTriggerCounter_t KM3NETDAQ::JDAQTriggerCounter::trigger_counter
protected

Definition at line 131 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:131
KM3NETDAQ::JDAQTriggerCounter
Auxiliary class to count triggers.
Definition: JDAQTriggerCounter.hh:23
KM3NETDAQ::JDAQTriggerCounter::next
JTriggerCounter_t next()
Increment trigger counter.
Definition: JDAQTriggerCounter.hh:121
KM3NETDAQ::JDAQTriggerCounter::getInstance
static JDAQTriggerCounter & getInstance()
Get reference to unique instance of this class object.
Definition: JDAQTriggerCounter.hh:66