KM3NETDAQ::JDAQFrameStatus Class Reference

DAQ frame status. More...

#include <JDAQFrameStatus.hh>

Inheritance diagram for KM3NETDAQ::JDAQFrameStatus:

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

Static Public Member Functions
static const JDAQFrameStatus &	getInstance ()
	Get reference to unique instance of this class object.

Protected Attributes
int	daq
int	status
int	fifo
int	status_3
int	status_4

Friends
size_t	getSizeof ()
	Definition of method to get size of data type.
JReader &	operator>> (JReader &in, JDAQFrameStatus &status)
	Read DAQ frame status from input.
JWriter &	operator<< (JWriter &out, const JDAQFrameStatus &status)
	Write DAQ frame status to output.

Detailed Description

DAQ frame status.

Definition at line 17 of file JDAQFrameStatus.hh.

Constructor & Destructor Documentation

JDAQFrameStatus() [1/2]

KM3NETDAQ::JDAQFrameStatus::JDAQFrameStatus ( )

inline

Default constructor.

Definition at line 27 of file JDAQFrameStatus.hh.

                      :
      daq     (0),
      status  (0),
      fifo    (0),
      status_3(0),
      status_4(0)
    {}

JDAQFrameStatus() [2/2]

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

__daq	DAQ status
__status	TDC status
__fifo	FIFO status
__status_3	spare
__status_4	spare

Definition at line 45 of file JDAQFrameStatus.hh.

                                              :
      daq     (__daq),
      status  (__status),
      fifo    (__fifo),
      status_3(__status_3),
      status_4(__status_4)
    {}

Member Function Documentation

getInstance()

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 65 of file JDAQFrameStatus.hh.

    {
      static const JDAQFrameStatus status(DAQ_UDP_RECEIVED_PACKETS.write(2) | DAQ_UDP_SEQUENCE_NUMBER.write(1),
                                          DAQ_WHITE_RABBIT.write(1),
                                          DAQ_FIFO.write(0) | DAQ_UDP_TRAILER.write(1));
 
      return status;
    }

getDAQFrameStatus()

const JDAQFrameStatus & KM3NETDAQ::JDAQFrameStatus::getDAQFrameStatus ( ) const

inline

Get DAQ frame status.

Returns

DAQ frame status

Definition at line 80 of file JDAQFrameStatus.hh.

    {
      return static_cast<const JDAQFrameStatus&>(*this);
    }

setDAQFrameStatus()

void KM3NETDAQ::JDAQFrameStatus::setDAQFrameStatus ( const JDAQFrameStatus & status )

inline

Set DAQ frame status.

Parameters

status

DAQ frame status

Definition at line 91 of file JDAQFrameStatus.hh.

    {
      static_cast<JDAQFrameStatus&>(*this) = status;
    }

getDAQStatus()

int KM3NETDAQ::JDAQFrameStatus::getDAQStatus ( ) const

inline

Get DAQ status.

Returns

DAQ status

Definition at line 102 of file JDAQFrameStatus.hh.

    { 
      return this->daq;
    }

getStatus()

int KM3NETDAQ::JDAQFrameStatus::getStatus ( ) const

inline

Get TDC and White Rabbit status.

Returns

status

Definition at line 113 of file JDAQFrameStatus.hh.

    { 
      return this->status;
    }

getFIFOStatus()

int KM3NETDAQ::JDAQFrameStatus::getFIFOStatus ( ) const

inline

Get FIFO status.

Returns

FIFO status

Definition at line 124 of file JDAQFrameStatus.hh.

    { 
      return this->fifo;
    }

testDAQStatus()

bool KM3NETDAQ::JDAQFrameStatus::testDAQStatus ( ) const

inline

Test DAQ status of packets.

Returns

true if okay; else false

Definition at line 135 of file JDAQFrameStatus.hh.

    { 
      return (getUDPNumberOfReceivedPackets() == (getUDPMaximalSequenceNumber() + 1)) && hasUDPTrailer();
    }

testStatus()

bool KM3NETDAQ::JDAQFrameStatus::testStatus ( ) const

inline

Test TDC and White Rabbit status.

Returns

true if okay; else false

Definition at line 146 of file JDAQFrameStatus.hh.

    { 
      return testWhiteRabbitStatus() && testTDCStatus();
    }

getUDPNumberOfReceivedPackets()

int KM3NETDAQ::JDAQFrameStatus::getUDPNumberOfReceivedPackets ( ) const

inline

Get number of received UDP packets.

Returns

UDP received packets

Definition at line 157 of file JDAQFrameStatus.hh.

    { 
      return DAQ_UDP_RECEIVED_PACKETS.read(this->daq);
    }

getUDPMaximalSequenceNumber()

int KM3NETDAQ::JDAQFrameStatus::getUDPMaximalSequenceNumber ( ) const

inline

Get maximal sequence number of UDP packet.

Returns

UDP sequence number

Definition at line 168 of file JDAQFrameStatus.hh.

    { 
      return DAQ_UDP_SEQUENCE_NUMBER.read(this->daq);
    }

testWhiteRabbitStatus()

bool KM3NETDAQ::JDAQFrameStatus::testWhiteRabbitStatus ( ) const

inline

Test White Rabbit status.

Returns

true if okay; else false

Definition at line 179 of file JDAQFrameStatus.hh.

    {
      return DAQ_WHITE_RABBIT.has(this->status);
    }

testTDCStatus()

bool KM3NETDAQ::JDAQFrameStatus::testTDCStatus ( ) const

inline

Test TDC status.

Returns

true if okay; else false

Definition at line 190 of file JDAQFrameStatus.hh.

    { 
      return !testHighRateVeto();
    }

testHighRateVeto() [1/2]

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 201 of file JDAQFrameStatus.hh.

    {
      return DAQ_TDC.has(this->status);
    }

testHighRateVeto() [2/2]

bool KM3NETDAQ::JDAQFrameStatus::testHighRateVeto ( const int tdc ) const

inline

Test high-rate veto status.

Parameters

tdc

TDC

Returns

true if TDC is high-rate vetoed; else false

Definition at line 213 of file JDAQFrameStatus.hh.

    {
      return JBit(tdc).has(this->status);
    }

countHighRateVeto()

int KM3NETDAQ::JDAQFrameStatus::countHighRateVeto ( ) const

inline

Count high-rate veto status.

Returns

number of the TDCs with high-rate veto

Definition at line 224 of file JDAQFrameStatus.hh.

    {
      int n = 0;
 
      if (testHighRateVeto()) {
        for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
          if (JBit(pmt).has(this->status)) {
            ++n;
          }
        }
      }
      
      return n;
    }

testFIFOStatus() [1/2]

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 245 of file JDAQFrameStatus.hh.

    { 
      return DAQ_FIFO.has(this->fifo);
    }

testFIFOStatus() [2/2]

bool KM3NETDAQ::JDAQFrameStatus::testFIFOStatus ( const int tdc ) const

inline

Test FIFO status.

Parameters

tdc

TDC

Returns

true if FIFO is almost full; else false

Definition at line 257 of file JDAQFrameStatus.hh.

    {
      return JBit(tdc).has(this->fifo);
    }

countFIFOStatus()

int KM3NETDAQ::JDAQFrameStatus::countFIFOStatus ( ) const

inline

Count FIFO status.

Returns

number of the TDCs with FIFO almost full

Definition at line 268 of file JDAQFrameStatus.hh.

    {
      int n = 0;
 
      if (testFIFOStatus()) {
        for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
          if (JBit(pmt).has(this->fifo)) {
            ++n;
          }
        }
      }
 
      return n;
    }

countActiveChannels()

int KM3NETDAQ::JDAQFrameStatus::countActiveChannels ( ) const

inline

Count active channels.

Returns

number of TDCs without high rate veto or FIFO almost full

Definition at line 287 of file JDAQFrameStatus.hh.

    {
      int n = NUMBER_OF_PMTS;
 
      if (testHighRateVeto() || testFIFOStatus()) {
        for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
          if ( JBit(pmt).has(this->status) || JBit(pmt).has(this->fifo) ) {
            --n;
          }
        }
      }
 
      return n;
 
    }

hasUDPTrailer()

bool KM3NETDAQ::JDAQFrameStatus::hasUDPTrailer ( ) const

inline

Get UDP trailer status.

Returns

true if UDP trailer present; else false

Definition at line 309 of file JDAQFrameStatus.hh.

    {
      return DAQ_UDP_TRAILER.has(this->fifo);
    }

setHighRateVeto()

void KM3NETDAQ::JDAQFrameStatus::setHighRateVeto ( const int tdc, const bool value )

inline

Set high-rate veto.

Parameters

tdc	TDC
value	value

Definition at line 321 of file JDAQFrameStatus.hh.

    {
      JBit(tdc).set(this->status, value);
    }

ClassDefNV()

KM3NETDAQ::JDAQFrameStatus::ClassDefNV	(	JDAQFrameStatus	,
		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>>

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

friend

Read DAQ frame status from input.

Parameters

in	reader
status	DAQ frame status

Returns

reader

Definition at line 36 of file JDAQFrameStatusIO.hh.

  {
    in >> status.daq;
    in >> status.status;
    in >> status.fifo;
    in >> status.status_3;
    in >> status.status_4;
 
    return in;
  }

operator<<

JWriter & operator<< ( JWriter & out, const JDAQFrameStatus & status )

friend

Write DAQ frame status to output.

Parameters

out	writer
status	DAQ frame status

Returns

writer

Definition at line 55 of file JDAQFrameStatusIO.hh.

  {
    out << status.daq;
    out << status.status;
    out << status.fifo;
    out << status.status_3;
    out << status.status_4;
 
    return out;
  }

Member Data Documentation

daq

int KM3NETDAQ::JDAQFrameStatus::daq

protected

Definition at line 330 of file JDAQFrameStatus.hh.

status

int KM3NETDAQ::JDAQFrameStatus::status

protected

Definition at line 331 of file JDAQFrameStatus.hh.

fifo

int KM3NETDAQ::JDAQFrameStatus::fifo

protected

Definition at line 332 of file JDAQFrameStatus.hh.

status_3

int KM3NETDAQ::JDAQFrameStatus::status_3

protected

Definition at line 333 of file JDAQFrameStatus.hh.

status_4

int KM3NETDAQ::JDAQFrameStatus::status_4

protected

Definition at line 334 of file JDAQFrameStatus.hh.

---

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

• JDAQFrameStatus.hh