Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
KM3NETDAQ::JDAQFrameStatus Class Reference

DAQ frame status. More...

#include <JDAQFrameStatus.hh>

Inheritance diagram for KM3NETDAQ::JDAQFrameStatus:
KM3NETDAQ::JDAQSummaryFrame KM3NETDAQ::JDAQSuperFrameHeader KM3NETDAQ::JDAQSuperFrame

Public Member Functions

 JDAQFrameStatus ()
 Default constructor. More...
 
 JDAQFrameStatus (const int __daq, const int __status, const int __fifo, const int __status_3=0, const int __status_4=0)
 Constructor. More...
 
const JDAQFrameStatusgetDAQFrameStatus () const
 Get DAQ frame status. More...
 
void setDAQFrameStatus (const JDAQFrameStatus &status)
 Set DAQ frame status. More...
 
int getDAQStatus () const
 Get DAQ status. More...
 
int getStatus () const
 Get TDC and White Rabbit status. More...
 
int getFIFOStatus () const
 Get FIFO status. More...
 
bool testDAQStatus () const
 Test DAQ status of packets. More...
 
bool testStatus () const
 Test TDC and White Rabbit status. More...
 
int getUDPNumberOfReceivedPackets () const
 Get number of received UDP packets. More...
 
int getUDPMaximalSequenceNumber () const
 Get maximal sequence number of UDP packet. More...
 
bool testWhiteRabbitStatus () const
 Test White Rabbit status. More...
 
bool testTDCStatus () const
 Test TDC status. More...
 
bool testHighRateVeto () const
 Test high-rate veto status. More...
 
bool testHighRateVeto (const int tdc) const
 Test high-rate veto status. More...
 
int countHighRateVeto () const
 Count high-rate veto status. More...
 
bool testFIFOStatus () const
 Test FIFO status. More...
 
bool testFIFOStatus (const int tdc) const
 Test FIFO status. More...
 
int countFIFOStatus () const
 Count FIFO status. More...
 
bool hasUDPTrailer () const
 Get UDP trailer status. More...
 
void setHighRateVeto (const int tdc, const bool value)
 Set high-rate veto. More...
 
 ClassDefNV (JDAQFrameStatus, 1)
 

Static Public Member Functions

static const JDAQFrameStatusgetInstance ()
 Get reference to unique instance of this class object. More...
 
static int sizeOf ()
 Get size of object. More...
 

Protected Attributes

int daq
 
int status
 
int fifo
 
int status_3
 
int status_4
 

Friends

JReaderoperator>> (JReader &in, JDAQFrameStatus &status)
 Read DAQ frame status from input. More...
 
JWriteroperator<< (JWriter &out, const JDAQFrameStatus &status)
 Write DAQ frame status to output. More...
 

Detailed Description

DAQ frame status.

Definition at line 23 of file JDAQFrameStatus.hh.

Constructor & Destructor Documentation

KM3NETDAQ::JDAQFrameStatus::JDAQFrameStatus ( )
inline

Default constructor.

Definition at line 28 of file JDAQFrameStatus.hh.

KM3NETDAQ::JDAQFrameStatus::JDAQFrameStatus ( const int  __daq,
const int  __status,
const int  __fifo,
const int  __status_3 = 0,
const int  __status_4 = 0 
)
inline

Constructor.

Parameters
__daqDAQ status
__statusTDC status
__fifoFIFO status
__status_3spare
__status_4spare

Definition at line 46 of file JDAQFrameStatus.hh.

50  :
51  daq (__daq),
52  status (__status),
53  fifo (__fifo),
54  status_3(__status_3),
55  status_4(__status_4)
56  {}

Member Function Documentation

static const JDAQFrameStatus& KM3NETDAQ::JDAQFrameStatus::getInstance ( )
inlinestatic

Get reference to unique instance of this class object.

This instance has default values which correspond to a valid DAQ frame status.

Returns
reference to this class object

Definition at line 66 of file JDAQFrameStatus.hh.

67  {
71 
72  return status;
73  }
static const JBits DAQ_UDP_RECEIVED_PACKETS(0, 15)
Mask of UDP received packets.
int write(const int value) const
Write given value as bit mask.
Definition: JDAQ.hh:115
int write(const int value) const
Write given value as bit mask.
Definition: JDAQ.hh:238
static const JBits DAQ_FIFO(0, 30)
FIFO almost full bits.
static const JBit DAQ_UDP_TRAILER(31)
UDP trailer.
static const JBit DAQ_WHITE_RABBIT(31)
White Rabbit status.
static const JBits DAQ_UDP_SEQUENCE_NUMBER(16, 31)
Mask of UDP sequence number.
JDAQFrameStatus()
Default constructor.
const JDAQFrameStatus& KM3NETDAQ::JDAQFrameStatus::getDAQFrameStatus ( ) const
inline

Get DAQ frame status.

Returns
DAQ frame status

Definition at line 81 of file JDAQFrameStatus.hh.

82  {
83  return static_cast<const JDAQFrameStatus&>(*this);
84  }
JDAQFrameStatus()
Default constructor.
void KM3NETDAQ::JDAQFrameStatus::setDAQFrameStatus ( const JDAQFrameStatus status)
inline

Set DAQ frame status.

Parameters
statusDAQ frame status

Definition at line 92 of file JDAQFrameStatus.hh.

93  {
94  static_cast<JDAQFrameStatus&>(*this) = status;
95  }
JDAQFrameStatus()
Default constructor.
int KM3NETDAQ::JDAQFrameStatus::getDAQStatus ( ) const
inline

Get DAQ status.

Returns
DAQ status

Definition at line 103 of file JDAQFrameStatus.hh.

104  {
105  return this->daq;
106  }
int KM3NETDAQ::JDAQFrameStatus::getStatus ( ) const
inline

Get TDC and White Rabbit status.

Returns
status

Definition at line 114 of file JDAQFrameStatus.hh.

115  {
116  return this->status;
117  }
int KM3NETDAQ::JDAQFrameStatus::getFIFOStatus ( ) const
inline

Get FIFO status.

Returns
FIFO status

Definition at line 125 of file JDAQFrameStatus.hh.

126  {
127  return this->fifo;
128  }
bool KM3NETDAQ::JDAQFrameStatus::testDAQStatus ( ) const
inline

Test DAQ status of packets.

Returns
true if okay; else false

Definition at line 136 of file JDAQFrameStatus.hh.

137  {
139  }
bool hasUDPTrailer() const
Get UDP trailer status.
int getUDPNumberOfReceivedPackets() const
Get number of received UDP packets.
int getUDPMaximalSequenceNumber() const
Get maximal sequence number of UDP packet.
bool KM3NETDAQ::JDAQFrameStatus::testStatus ( ) const
inline

Test TDC and White Rabbit status.

Returns
true if okay; else false

Definition at line 147 of file JDAQFrameStatus.hh.

148  {
149  return testWhiteRabbitStatus() && testTDCStatus();
150  }
bool testTDCStatus() const
Test TDC status.
bool testWhiteRabbitStatus() const
Test White Rabbit status.
int KM3NETDAQ::JDAQFrameStatus::getUDPNumberOfReceivedPackets ( ) const
inline

Get number of received UDP packets.

Returns
UDP received packets

Definition at line 158 of file JDAQFrameStatus.hh.

159  {
160  return DAQ_UDP_RECEIVED_PACKETS.read(this->daq);
161  }
static const JBits DAQ_UDP_RECEIVED_PACKETS(0, 15)
Mask of UDP received packets.
int read(const int mask) const
Read given bit mask as value.
Definition: JDAQ.hh:250
int KM3NETDAQ::JDAQFrameStatus::getUDPMaximalSequenceNumber ( ) const
inline

Get maximal sequence number of UDP packet.

Returns
UDP sequence number

Definition at line 169 of file JDAQFrameStatus.hh.

170  {
171  return DAQ_UDP_SEQUENCE_NUMBER.read(this->daq);
172  }
int read(const int mask) const
Read given bit mask as value.
Definition: JDAQ.hh:250
static const JBits DAQ_UDP_SEQUENCE_NUMBER(16, 31)
Mask of UDP sequence number.
bool KM3NETDAQ::JDAQFrameStatus::testWhiteRabbitStatus ( ) const
inline

Test White Rabbit status.

Returns
true if okay; else false

Definition at line 180 of file JDAQFrameStatus.hh.

181  {
182  return DAQ_WHITE_RABBIT.has(this->status);
183  }
bool has(const int mask) const
Test bit.
Definition: JDAQ.hh:139
static const JBit DAQ_WHITE_RABBIT(31)
White Rabbit status.
bool KM3NETDAQ::JDAQFrameStatus::testTDCStatus ( ) const
inline

Test TDC status.

Returns
true if okay; else false

Definition at line 191 of file JDAQFrameStatus.hh.

192  {
193  return !testHighRateVeto();
194  }
bool testHighRateVeto() const
Test high-rate veto status.
bool KM3NETDAQ::JDAQFrameStatus::testHighRateVeto ( ) const
inline

Test high-rate veto status.

Returns
true if one of the TDCs is high-rate vetoed; else false

Definition at line 202 of file JDAQFrameStatus.hh.

203  {
204  return DAQ_TDC.has(this->status);
205  }
bool has(const int mask) const
Test bit mask.
Definition: JDAQ.hh:262
static const JBits DAQ_TDC(0, 30)
TDC high-rate veto status.
bool KM3NETDAQ::JDAQFrameStatus::testHighRateVeto ( const int  tdc) const
inline

Test high-rate veto status.

Parameters
tdcTDC
Returns
true if TDC is high-rate vetoed; else false

Definition at line 214 of file JDAQFrameStatus.hh.

215  {
216  return JBit(tdc).has(this->status);
217  }
int KM3NETDAQ::JDAQFrameStatus::countHighRateVeto ( ) const
inline

Count high-rate veto status.

Returns
number of the TDCs with high-rate veto

Definition at line 225 of file JDAQFrameStatus.hh.

226  {
227  int n = 0;
228 
229  if (testHighRateVeto()) {
230  for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
231  if (JBit(pmt).has(this->status)) {
232  ++n;
233  }
234  }
235  }
236 
237  return n;
238  }
bool testHighRateVeto() const
Test high-rate veto status.
static const int NUMBER_OF_PMTS
Total number of PMTs in module.
Definition: JDAQ.hh:26
bool KM3NETDAQ::JDAQFrameStatus::testFIFOStatus ( ) const
inline

Test FIFO status.

Returns
true if one of the TDCs has FIFO almost full; else false

Definition at line 246 of file JDAQFrameStatus.hh.

247  {
248  return DAQ_FIFO.has(this->fifo);
249  }
static const JBits DAQ_FIFO(0, 30)
FIFO almost full bits.
bool has(const int mask) const
Test bit mask.
Definition: JDAQ.hh:262
bool KM3NETDAQ::JDAQFrameStatus::testFIFOStatus ( const int  tdc) const
inline

Test FIFO status.

Parameters
tdcTDC
Returns
true if FIFO is almost full; else false

Definition at line 258 of file JDAQFrameStatus.hh.

259  {
260  return JBit(tdc).has(this->fifo);
261  }
int KM3NETDAQ::JDAQFrameStatus::countFIFOStatus ( ) const
inline

Count FIFO status.

Returns
number of the TDCs with FIFO almost full

Definition at line 269 of file JDAQFrameStatus.hh.

270  {
271  int n = 0;
272 
273  if (testFIFOStatus()) {
274  for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
275  if (JBit(pmt).has(this->fifo)) {
276  ++n;
277  }
278  }
279  }
280 
281  return n;
282  }
static const int NUMBER_OF_PMTS
Total number of PMTs in module.
Definition: JDAQ.hh:26
bool testFIFOStatus() const
Test FIFO status.
bool KM3NETDAQ::JDAQFrameStatus::hasUDPTrailer ( ) const
inline

Get UDP trailer status.

Returns
true if UDP trailer present; else false

Definition at line 290 of file JDAQFrameStatus.hh.

291  {
292  return DAQ_UDP_TRAILER.has(this->fifo);
293  }
static const JBit DAQ_UDP_TRAILER(31)
UDP trailer.
bool has(const int mask) const
Test bit.
Definition: JDAQ.hh:139
void KM3NETDAQ::JDAQFrameStatus::setHighRateVeto ( const int  tdc,
const bool  value 
)
inline

Set high-rate veto.

Parameters
tdcTDC
valuevalue

Definition at line 302 of file JDAQFrameStatus.hh.

303  {
304  JBit(tdc).set(this->status, value);
305  }
static int KM3NETDAQ::JDAQFrameStatus::sizeOf ( )
inlinestatic

Get size of object.

Returns
number of bytes

Definition at line 351 of file JDAQFrameStatus.hh.

352  {
353  return (sizeof(int) +
354  sizeof(int) +
355  sizeof(int) +
356  sizeof(int) +
357  sizeof(int));
358  }
KM3NETDAQ::JDAQFrameStatus::ClassDefNV ( JDAQFrameStatus  ,
 
)

Friends And Related Function Documentation

JReader& operator>> ( JReader in,
JDAQFrameStatus status 
)
friend

Read DAQ frame status from input.

Parameters
inJReader
statusJDAQFrameStatus
Returns
JReader

Definition at line 315 of file JDAQFrameStatus.hh.

316  {
317  in >> status.daq;
318  in >> status.status;
319  in >> status.fifo;
320  in >> status.status_3;
321  in >> status.status_4;
322 
323  return in;
324  }
JWriter& operator<< ( JWriter out,
const JDAQFrameStatus status 
)
friend

Write DAQ frame status to output.

Parameters
outJWriter
statusJDAQFrameStatus
Returns
JWriter

Definition at line 334 of file JDAQFrameStatus.hh.

335  {
336  out << status.daq;
337  out << status.status;
338  out << status.fifo;
339  out << status.status_3;
340  out << status.status_4;
341 
342  return out;
343  }

Member Data Documentation

int KM3NETDAQ::JDAQFrameStatus::daq
protected

Definition at line 364 of file JDAQFrameStatus.hh.

int KM3NETDAQ::JDAQFrameStatus::status
protected

Definition at line 365 of file JDAQFrameStatus.hh.

int KM3NETDAQ::JDAQFrameStatus::fifo
protected

Definition at line 366 of file JDAQFrameStatus.hh.

int KM3NETDAQ::JDAQFrameStatus::status_3
protected

Definition at line 367 of file JDAQFrameStatus.hh.

int KM3NETDAQ::JDAQFrameStatus::status_4
protected

Definition at line 368 of file JDAQFrameStatus.hh.


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