DAQ super frame header. More...

#include <JDAQSuperFrameHeader.hh>

Inheritance diagram for KM3NETDAQ::JDAQSuperFrameHeader:

Public Member Functions
	JDAQSuperFrameHeader ()
	Default constructor.

	JDAQSuperFrameHeader (const JDAQChronometer &chronometer, const int id)
	Constructor.

	JDAQSuperFrameHeader (const JDAQChronometer &chronometer, const int id, const JDAQFrameStatus &status)
	Constructor.

const JDAQSuperFrameHeader &	getDAQSuperFrameHeader () const
	Get DAQ super frame header.

void	setDAQSuperFrameHeader (const JDAQSuperFrameHeader &header)
	Set DAQ super frame header.

	ClassDef (JDAQSuperFrameHeader, 2)

const JDAQHeader &	getDAQHeader () const
	Get DAQ header.

void	setDAQHeader (const JDAQHeader &header)
	Set DAQ header.

	ClassDef (JDAQHeader, 2)

	ClassDef (JDAQChronometer, 3)

const JDAQChronometer &	getDAQChronometer () const
	Get DAQ chronometer.

void	setDAQChronometer (const JDAQChronometer &chronometer)
	Set DAQ chronometer.

int	getDetectorID () const
	Get detector identifier.

int	getRunNumber () const
	Get run number.

int	getFrameIndex () const
	Get frame index.

JDAQUTCExtended	getTimesliceStart () const
	Get start of timeslice.

void	setRunNumber (const int run)
	Set run number.

void	setFrameIndex (const int frame_index)
	Set frame index.

void	setTimesliceStart (const JDAQUTCExtended &timeslice_start)
	Set timeslice start time.

const JDAQModuleIdentifier &	getModuleIdentifier () const
	Get Module identifier.

void	setModuleIdentifier (const JDAQModuleIdentifier &module)
	Set Module identifier.

int	getModuleID () const
	Get module identifier.

	ClassDefNV (JDAQModuleIdentifier, 1)

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	detector_id

int	run

int	frame_index

JDAQUTCExtended	timeslice_start

int	id

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, JDAQSuperFrameHeader &header)
	Read DAQ super frame header from input.

JWriter &	operator<< (JWriter &out, const JDAQSuperFrameHeader &header)
	Write DAQ super frame header to output.

Detailed Description

DAQ super frame header.

Definition at line 19 of file JDAQSuperFrameHeader.hh.

Constructor & Destructor Documentation

◆ JDAQSuperFrameHeader() [1/3]

KM3NETDAQ::JDAQSuperFrameHeader::JDAQSuperFrameHeader ( )

inline

Default constructor.

Definition at line 33 of file JDAQSuperFrameHeader.hh.

                           :
      JDAQHeader          (),
      JDAQModuleIdentifier(),
      JDAQFrameStatus     ()
    {}

◆ JDAQSuperFrameHeader() [2/3]

KM3NETDAQ::JDAQSuperFrameHeader::JDAQSuperFrameHeader	(	const JDAQChronometer &	chronometer,
		const int	id )

inline

Constructor.

Parameters

chronometer	chronometer
id	module identifier

Definition at line 46 of file JDAQSuperFrameHeader.hh.

                                                    :
      JDAQHeader          (chronometer),
      JDAQModuleIdentifier(id),
      JDAQFrameStatus     (JDAQFrameStatus::getInstance())
    {}

◆ JDAQSuperFrameHeader() [3/3]

KM3NETDAQ::JDAQSuperFrameHeader::JDAQSuperFrameHeader	(	const JDAQChronometer &	chronometer,
		const int	id,
		const JDAQFrameStatus &	status )

inline

Constructor.

Parameters

chronometer	chronometer
id	module identifier
status	frame status

Definition at line 61 of file JDAQSuperFrameHeader.hh.

                                                        :
      JDAQHeader          (chronometer),
      JDAQModuleIdentifier(id),
      JDAQFrameStatus     (status)
    {}

Member Function Documentation

◆ getDAQSuperFrameHeader()

const JDAQSuperFrameHeader & KM3NETDAQ::JDAQSuperFrameHeader::getDAQSuperFrameHeader ( ) const

inline

Get DAQ super frame header.

Returns: DAQ super frame header

Definition at line 75 of file JDAQSuperFrameHeader.hh.

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

◆ setDAQSuperFrameHeader()

void KM3NETDAQ::JDAQSuperFrameHeader::setDAQSuperFrameHeader ( const JDAQSuperFrameHeader & header )

inline

Set DAQ super frame header.

Parameters

header DAQ super frame header

Definition at line 86 of file JDAQSuperFrameHeader.hh.

    {
      static_cast<JDAQSuperFrameHeader&>(*this) = header;
    }

◆ ClassDef() [1/3]

KM3NETDAQ::JDAQSuperFrameHeader::ClassDef	(	JDAQSuperFrameHeader	,
		2	)

◆ getDAQHeader()

const JDAQHeader & KM3NETDAQ::JDAQHeader::getDAQHeader ( ) const

inlineinherited

Get DAQ header.

Returns: DAQ header

Definition at line 49 of file JDAQHeader.hh.

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

◆ setDAQHeader()

void KM3NETDAQ::JDAQHeader::setDAQHeader ( const JDAQHeader & header )

inlineinherited

Set DAQ header.

Parameters

header DAQ header

Definition at line 60 of file JDAQHeader.hh.

    { 
      static_cast<JDAQHeader&>(*this) = header;
    }

◆ ClassDef() [2/3]

KM3NETDAQ::JDAQHeader::ClassDef	(	JDAQHeader	,
		2	)

inherited

◆ ClassDef() [3/3]

KM3NETDAQ::JDAQChronometer::ClassDef	(	JDAQChronometer	,
		3	)

inherited

◆ getDAQChronometer()

const JDAQChronometer & KM3NETDAQ::JDAQChronometer::getDAQChronometer ( ) const

inlineinherited

Get DAQ chronometer.

Returns: DAQ chronometer

Definition at line 88 of file JDAQChronometer.hh.

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

◆ setDAQChronometer()

void KM3NETDAQ::JDAQChronometer::setDAQChronometer ( const JDAQChronometer & chronometer )

inlineinherited

Set DAQ chronometer.

Parameters

chronometer DAQ chronometer

Definition at line 99 of file JDAQChronometer.hh.

    { 
      static_cast<JDAQChronometer&>(*this) = chronometer;
    }

◆ getDetectorID()

int KM3NETDAQ::JDAQChronometer::getDetectorID ( ) const

inlineinherited

Get detector identifier.

Returns: detector identifier

Definition at line 110 of file JDAQChronometer.hh.

    { 
      return detector_id; 
    }

◆ getRunNumber()

int KM3NETDAQ::JDAQChronometer::getRunNumber ( ) const

inlineinherited

Get run number.

Returns: run number

Definition at line 121 of file JDAQChronometer.hh.

    { 
      return run; 
    }

◆ getFrameIndex()

int KM3NETDAQ::JDAQChronometer::getFrameIndex ( ) const

inlineinherited

Get frame index.

Returns: frame index

Definition at line 132 of file JDAQChronometer.hh.

    { 
      return frame_index; 
    }

◆ getTimesliceStart()

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::getTimesliceStart ( ) const

inlineinherited

Get start of timeslice.

Returns: timeslice start

Definition at line 144 of file JDAQChronometer.hh.

    {
      return timeslice_start;
    }

◆ setRunNumber()

void KM3NETDAQ::JDAQChronometer::setRunNumber ( const int run )

inlineinherited

Set run number.

Parameters

run	run number

Definition at line 155 of file JDAQChronometer.hh.

    { 
      this->run = run;
    }

◆ setFrameIndex()

void KM3NETDAQ::JDAQChronometer::setFrameIndex ( const int frame_index )

inlineinherited

Set frame index.

Parameters

frame_index frame index

Definition at line 166 of file JDAQChronometer.hh.

    { 
      this->frame_index = frame_index;
    }

◆ setTimesliceStart()

void KM3NETDAQ::JDAQChronometer::setTimesliceStart ( const JDAQUTCExtended & timeslice_start )

inlineinherited

Set timeslice start time.

Parameters

timeslice_start timeslice start time

Definition at line 177 of file JDAQChronometer.hh.

    {
      this->timeslice_start = timeslice_start;
    }

◆ getModuleIdentifier()

const JDAQModuleIdentifier & KM3NETDAQ::JDAQModuleIdentifier::getModuleIdentifier ( ) const

inlineinherited

Get Module identifier.

Returns: Module identifier

Definition at line 50 of file JDAQModuleIdentifier.hh.

    { 
      return *this; 
    }

◆ setModuleIdentifier()

void KM3NETDAQ::JDAQModuleIdentifier::setModuleIdentifier ( const JDAQModuleIdentifier & module )

inlineinherited

Set Module identifier.

Parameters

module Module identifier

Definition at line 61 of file JDAQModuleIdentifier.hh.

    { 
      *this = module;
    }

◆ getModuleID()

int KM3NETDAQ::JDAQModuleIdentifier::getModuleID ( ) const

inlineinherited

Get module identifier.

Returns: module identifier

Definition at line 72 of file JDAQModuleIdentifier.hh.

    { 
      return id;
    }

◆ ClassDefNV() [1/2]

KM3NETDAQ::JDAQModuleIdentifier::ClassDefNV	(	JDAQModuleIdentifier	,
		1	)

inherited

◆ getInstance()

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

inlinestaticinherited

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

inlineinherited

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 )

inlineinherited

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

inlineinherited

Get DAQ status.

Returns: DAQ status

Definition at line 102 of file JDAQFrameStatus.hh.

    { 
      return this->daq;
    }

◆ getStatus()

int KM3NETDAQ::JDAQFrameStatus::getStatus ( ) const

inlineinherited

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

inlineinherited

Get FIFO status.

Returns: FIFO status

Definition at line 124 of file JDAQFrameStatus.hh.

    { 
      return this->fifo;
    }

◆ testDAQStatus()

bool KM3NETDAQ::JDAQFrameStatus::testDAQStatus ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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 )

inlineinherited

Set high-rate veto.

Parameters

tdc	TDC
value	value

Definition at line 321 of file JDAQFrameStatus.hh.

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

◆ ClassDefNV() [2/2]

KM3NETDAQ::JDAQFrameStatus::ClassDefNV	(	JDAQFrameStatus	,
		1	)

inherited

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,
		JDAQSuperFrameHeader &	header )

friend

Read DAQ super frame header from input.

Parameters

in	reader
header	DAQ super frame header

Returns: reader

Definition at line 39 of file JDAQSuperFrameHeaderIO.hh.

  {
    in >> static_cast<JDAQHeader&>          (header);
    in >> static_cast<JDAQModuleIdentifier&>(header);
    in >> static_cast<JDAQFrameStatus&>     (header);
 
    return in;
  }

◆ operator<<

JWriter & operator<<	(	JWriter &	out,
		const JDAQSuperFrameHeader &	header )

friend

Write DAQ super frame header to output.

Parameters

out	writer
header	DAQ supe frame header

Returns: writer

Definition at line 56 of file JDAQSuperFrameHeaderIO.hh.

  {
    out << static_cast<const JDAQHeader&>          (header);
    out << static_cast<const JDAQModuleIdentifier&>(header);
    out << static_cast<const JDAQFrameStatus&>     (header);
 
    return out;
  }

Member Data Documentation

◆ detector_id

int KM3NETDAQ::JDAQChronometer::detector_id

protectedinherited

Definition at line 187 of file JDAQChronometer.hh.

◆ run

int KM3NETDAQ::JDAQChronometer::run

protectedinherited

Definition at line 188 of file JDAQChronometer.hh.

◆ frame_index

int KM3NETDAQ::JDAQChronometer::frame_index

protectedinherited

Definition at line 189 of file JDAQChronometer.hh.

◆ timeslice_start

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::timeslice_start

protectedinherited

Definition at line 190 of file JDAQChronometer.hh.

◆ id

int KM3NETDAQ::JDAQModuleIdentifier::id

protectedinherited

Definition at line 112 of file JDAQModuleIdentifier.hh.

◆ daq

int KM3NETDAQ::JDAQFrameStatus::daq

protectedinherited

Definition at line 330 of file JDAQFrameStatus.hh.

◆ status

int KM3NETDAQ::JDAQFrameStatus::status

protectedinherited

Definition at line 331 of file JDAQFrameStatus.hh.

◆ fifo

int KM3NETDAQ::JDAQFrameStatus::fifo

protectedinherited

Definition at line 332 of file JDAQFrameStatus.hh.

◆ status_3

int KM3NETDAQ::JDAQFrameStatus::status_3

protectedinherited

Definition at line 333 of file JDAQFrameStatus.hh.

◆ status_4

int KM3NETDAQ::JDAQFrameStatus::status_4

protectedinherited

Definition at line 334 of file JDAQFrameStatus.hh.

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

JDAQSuperFrameHeader.hh

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JDAQSuperFrameHeader() [1/3]

◆ JDAQSuperFrameHeader() [2/3]

◆ JDAQSuperFrameHeader() [3/3]

Member Function Documentation

◆ getDAQSuperFrameHeader()

◆ setDAQSuperFrameHeader()

◆ ClassDef() [1/3]

◆ getDAQHeader()

◆ setDAQHeader()

◆ ClassDef() [2/3]

◆ ClassDef() [3/3]

◆ getDAQChronometer()

◆ setDAQChronometer()

◆ getDetectorID()

◆ getRunNumber()

◆ getFrameIndex()

◆ getTimesliceStart()

◆ setRunNumber()

◆ setFrameIndex()

◆ setTimesliceStart()

◆ getModuleIdentifier()

◆ setModuleIdentifier()

◆ getModuleID()

◆ ClassDefNV() [1/2]

◆ getInstance()

◆ getDAQFrameStatus()

◆ setDAQFrameStatus()

◆ getDAQStatus()

◆ getStatus()

◆ getFIFOStatus()

◆ testDAQStatus()

◆ testStatus()

◆ getUDPNumberOfReceivedPackets()

◆ getUDPMaximalSequenceNumber()

◆ testWhiteRabbitStatus()

◆ testTDCStatus()

◆ testHighRateVeto() [1/2]

◆ testHighRateVeto() [2/2]

◆ countHighRateVeto()

◆ testFIFOStatus() [1/2]

◆ testFIFOStatus() [2/2]

◆ countFIFOStatus()

◆ countActiveChannels()

◆ hasUDPTrailer()

◆ setHighRateVeto()

◆ ClassDefNV() [2/2]

Friends And Related Symbol Documentation

◆ getSizeof

◆ operator>>

◆ operator<<

Member Data Documentation

◆ detector_id

◆ run

◆ frame_index

◆ timeslice_start

◆ id

◆ daq

◆ status

◆ fifo

◆ status_3

◆ status_4