Data frame of one optical module. More...

#include <JDAQSuperFrame.hh>

Inheritance diagram for KM3NETDAQ::JDAQSuperFrame:

Public Types
typedef JDAQFrame::const_iterator	const_iterator

typedef JDAQFrame::iterator	iterator

typedef JDAQFrame::const_reverse_iterator	const_reverse_iterator

typedef JDAQFrame::reverse_iterator	reverse_iterator

Public Member Functions
	JDAQSuperFrame ()
	Default constructor. More...

	JDAQSuperFrame (const JDAQSuperFrameHeader &header)
	Constructor. More...

	JDAQSuperFrame (const JDAQSuperFrame &super_frame)
	Copy constructor. More...

JDAQSuperFrame &	add (const JDAQSuperFrame &super_frame)
	Add data from same optical module. More...

JDAQSuperFrame &	add (const JDAQHit &hit)
	Add hit. More...

JDAQSuperFrame &	add (const JDAQFrame &frame)
	Add data. More...

JDAQSuperFrame &	add (const int number_of_hits, const JDAQHit *data)
	Add data. More...

virtual int	getSize () const
	Get size of object. More...

	ClassDef (JDAQSuperFrame, 3)

	ClassDef (JDAQPreamble, 1)

int	getLength () const
	Get length. More...

int	getDataType () const
	Get data type. More...

	ClassDefNV (JDAQAbstractPreamble, 1)

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

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

	ClassDef (JDAQSuperFrameHeader, 2)

	ClassDef (JDAQHeader, 2)

	ClassDef (JDAQChronometer, 3)

const JDAQHeader &	getDAQHeader () const
	Get DAQ header. More...

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

const JDAQChronometer &	getDAQChronometer () const
	Get DAQ chronometer. More...

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

int	getDetectorID () const
	Get detector identifier. More...

int	getRunNumber () const
	Get run number. More...

int	getFrameIndex () const
	Get frame index. More...

JDAQUTCExtended	getTimesliceStart () const
	Get start of timeslice. More...

void	setRunNumber (const int run)
	Set run number. More...

void	setFrameIndex (const int frame_index)
	Set frame index. More...

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

const JDAQModuleIdentifier &	getModuleIdentifier () const
	Get Module identifier. More...

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

int	getModuleID () const
	Get module identifier. More...

	ClassDefNV (JDAQModuleIdentifier, 1)

	ClassDefNV (JDAQFrameStatus, 1)

const JDAQFrameStatus &	getDAQFrameStatus () 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...

int	countActiveChannels () const
	Count active channels. More...

bool	hasUDPTrailer () const
	Get UDP trailer status. More...

void	setHighRateVeto (const int tdc, const bool value)
	Set high-rate veto. More...

void	clear ()
	Clear data. More...

const_iterator	begin () const

iterator	begin ()

const_iterator	end () const

iterator	end ()

const_reverse_iterator	rbegin () const

reverse_iterator	rbegin ()

const_reverse_iterator	rend () const

reverse_iterator	rend ()

bool	empty () const

int	size () const

const JDAQHit *	data () const

JDAQHit *	data ()

const JDAQHit &	operator[] (int index) const
	Get hit at given index. More...

JDAQFrameSubset	subset (const int i1, const int i2) const
	Get subset of data. More...

void	swap (JDAQFrame &frame)
	Swap data. More...

	ClassDef (JDAQFrame, 1)

Static Public Member Functions
static int	sizeOf ()
	Get size of object. More...

static int	sizeOf ()
	Get size of object. More...

static const JDAQFrameStatus &	getInstance ()
	Get reference to unique instance of this class object. More...

Public Attributes
int	numberOfHits

JDAQHit *	buffer

Protected Member Functions
void	setLength ()
	Set length. More...

void	resize (const int number_of_hits)
	Resize internal buffer. More...

Protected Attributes
int	length

int	type

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
JReader &	operator>> (JReader &in, JDAQSuperFrame &frame)
	Read JDAQSuperFrame from input. More...

JWriter &	operator<< (JWriter &out, const JDAQSuperFrame &frame)
	Write JDAQSuperFrame to output. More...

Detailed Description

Data frame of one optical module.

Definition at line 27 of file JDAQSuperFrame.hh.

Member Typedef Documentation

◆ const_iterator

typedef JDAQFrame::const_iterator KM3NETDAQ::JDAQSuperFrame::const_iterator

Definition at line 34 of file JDAQSuperFrame.hh.

◆ iterator

typedef JDAQFrame::iterator KM3NETDAQ::JDAQSuperFrame::iterator

Definition at line 35 of file JDAQSuperFrame.hh.

◆ const_reverse_iterator

typedef JDAQFrame::const_reverse_iterator KM3NETDAQ::JDAQSuperFrame::const_reverse_iterator

Definition at line 36 of file JDAQSuperFrame.hh.

◆ reverse_iterator

typedef JDAQFrame::reverse_iterator KM3NETDAQ::JDAQSuperFrame::reverse_iterator

Definition at line 37 of file JDAQSuperFrame.hh.

Constructor & Destructor Documentation

◆ JDAQSuperFrame() [1/3]

KM3NETDAQ::JDAQSuperFrame::JDAQSuperFrame ( )

inline

Default constructor.

Definition at line 43 of file JDAQSuperFrame.hh.

                      :
       JDAQPreamble(JDAQType<JDAQSuperFrame>()),
       JDAQSuperFrameHeader(),
       JDAQFrame()
     {}

◆ JDAQSuperFrame() [2/3]

KM3NETDAQ::JDAQSuperFrame::JDAQSuperFrame ( const JDAQSuperFrameHeader & header )

inline

Constructor.

Parameters

header JDAQ super frame header

Definition at line 55 of file JDAQSuperFrame.hh.

                                                        :
       JDAQPreamble(JDAQType<JDAQSuperFrame>()),
       JDAQSuperFrameHeader(header),
       JDAQFrame()
     {}

◆ JDAQSuperFrame() [3/3]

KM3NETDAQ::JDAQSuperFrame::JDAQSuperFrame ( const JDAQSuperFrame & super_frame )

inline

Copy constructor.

Parameters

super_frame JDAQ super frame

Definition at line 67 of file JDAQSuperFrame.hh.

                                                       :
       JDAQPreamble(JDAQType<JDAQSuperFrame>()),
       JDAQSuperFrameHeader(super_frame.getDAQSuperFrameHeader()),
       JDAQFrame(super_frame)
     {}

Member Function Documentation

◆ add() [1/4]

JDAQSuperFrame& KM3NETDAQ::JDAQSuperFrame::add ( const JDAQSuperFrame & super_frame )

inline

Add data from same optical module.

Parameters

super_frame JDAQ super frame

Returns: this JDAQ super frame

Definition at line 80 of file JDAQSuperFrame.hh.

     {
       if (this->getModuleID() != super_frame.getModuleID())
         throw JDAQException("JDAQSuperFrame::add(): Different module identifiers.");
  
       return add(static_cast<const JDAQFrame&>(super_frame));
     }

◆ add() [2/4]

JDAQSuperFrame& KM3NETDAQ::JDAQSuperFrame::add ( const JDAQHit & hit )

inline

Add hit.

Parameters

hit JDAQ hit

Returns: this JDAQ frame

Definition at line 95 of file JDAQSuperFrame.hh.

     {
       return add(1, &hit);
     }

◆ add() [3/4]

JDAQSuperFrame& KM3NETDAQ::JDAQSuperFrame::add ( const JDAQFrame & frame )

inline

Add data.

Parameters

frame JDAQ frame

Returns: this JDAQ frame

Definition at line 107 of file JDAQSuperFrame.hh.

     {
       return add(frame.numberOfHits, frame.buffer);
     }

◆ add() [4/4]

JDAQSuperFrame& KM3NETDAQ::JDAQSuperFrame::add	(	const int	number_of_hits,
		const JDAQHit *	data
	)

inline

Add data.

Parameters

number_of_hits	number of hits
data	pointer to data

Returns: this data frame

Definition at line 120 of file JDAQSuperFrame.hh.

     {
       JDAQFrame::add(number_of_hits, data);
  
       return *this;
     }

◆ getSize()

virtual int KM3NETDAQ::JDAQSuperFrame::getSize ( ) const

inlinevirtual

Get size of object.

Returns: number of bytes

Reimplemented from KM3NETDAQ::JDAQPreamble.

Definition at line 167 of file JDAQSuperFrame.hh.

     { 
       return (JDAQPreamble        ::sizeOf()  +  
               JDAQSuperFrameHeader::sizeOf()  +  
               sizeof(int)  +  numberOfHits * JDAQHit::sizeOf());
     }

◆ ClassDef() [1/6]

KM3NETDAQ::JDAQSuperFrame::ClassDef	(	JDAQSuperFrame	,
		3
	)

◆ sizeOf() [1/2]

static int KM3NETDAQ::JDAQPreamble::sizeOf ( )

inlinestaticinherited

Get size of object.

Returns: number of bytes

Definition at line 110 of file JDAQPreamble.hh.

     {
       return JDAQAbstractPreamble::sizeOf();
     }

◆ ClassDef() [2/6]

KM3NETDAQ::JDAQPreamble::ClassDef	(	JDAQPreamble	,
		1
	)

inherited

◆ setLength()

void KM3NETDAQ::JDAQPreamble::setLength ( )

inlineprotectedinherited

Set length.

Definition at line 134 of file JDAQPreamble.hh.

     { 
       length = getSize();
     }

◆ getLength()

int KM3NETDAQ::JDAQAbstractPreamble::getLength ( ) const

inlineinherited

Get length.

Returns: number of bytes

Definition at line 48 of file JDAQAbstractPreamble.hh.

     { 
       return length;
     }

◆ getDataType()

int KM3NETDAQ::JDAQAbstractPreamble::getDataType ( ) const

inlineinherited

Get data type.

Returns: data type

Definition at line 59 of file JDAQAbstractPreamble.hh.

     { 
       return type; 
     }

◆ ClassDefNV() [1/3]

KM3NETDAQ::JDAQAbstractPreamble::ClassDefNV	(	JDAQAbstractPreamble	,
		1
	)

inherited

◆ getDAQSuperFrameHeader()

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

inlineinherited

Get DAQ super frame header.

Returns: DAQ super frame header

Definition at line 76 of file JDAQSuperFrameHeader.hh.

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

◆ setDAQSuperFrameHeader()

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

inlineinherited

Set DAQ super frame header.

Parameters

header DAQ super frame header

Definition at line 87 of file JDAQSuperFrameHeader.hh.

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

◆ sizeOf() [2/2]

static int KM3NETDAQ::JDAQSuperFrameHeader::sizeOf ( )

inlinestaticinherited

Get size of object.

Returns: number of bytes

Definition at line 132 of file JDAQSuperFrameHeader.hh.

     {
       return (JDAQHeader          ::sizeOf() +
               JDAQModuleIdentifier::sizeOf() +
               JDAQFrameStatus     ::sizeOf());
     }

◆ ClassDef() [3/6]

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

inherited

◆ ClassDef() [4/6]

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

inherited

◆ ClassDef() [5/6]

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

inherited

◆ getDAQHeader()

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

inlineinherited

Get DAQ header.

Returns: DAQ header

Definition at line 51 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 62 of file JDAQHeader.hh.

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

◆ 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() [2/3]

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

inherited

◆ ClassDefNV() [3/3]

KM3NETDAQ::JDAQFrameStatus::ClassDefNV	(	JDAQFrameStatus	,
		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 66 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 81 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 92 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 103 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 114 of file JDAQFrameStatus.hh.

     { 
       return this->status;
     }

◆ getFIFOStatus()

int KM3NETDAQ::JDAQFrameStatus::getFIFOStatus ( ) const

inlineinherited

Get FIFO status.

Returns: FIFO status

Definition at line 125 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 136 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 147 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 158 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 169 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 180 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 191 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 202 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 214 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 225 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 246 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 258 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 269 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 288 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 310 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 322 of file JDAQFrameStatus.hh.

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

◆ clear()

void KM3NETDAQ::JDAQFrame::clear ( )

inlineinherited

Clear data.

Definition at line 128 of file JDAQFrame.hh.

     {
       if (buffer != NULL) {
         free(buffer);
       }
  
       numberOfHits = 0;
       buffer       = NULL;
     }

◆ begin() [1/2]

const_iterator KM3NETDAQ::JDAQFrame::begin ( ) const

inlineinherited

Definition at line 139 of file JDAQFrame.hh.

139 { return buffer; }

◆ begin() [2/2]

iterator KM3NETDAQ::JDAQFrame::begin ( )

inlineinherited

Definition at line 143 of file JDAQFrame.hh.

143 { return buffer; }

◆ end() [1/2]

const_iterator KM3NETDAQ::JDAQFrame::end ( ) const

inlineinherited

Definition at line 140 of file JDAQFrame.hh.

140 { return buffer + numberOfHits; }

◆ end() [2/2]

iterator KM3NETDAQ::JDAQFrame::end ( )

inlineinherited

Definition at line 144 of file JDAQFrame.hh.

144 { return buffer + numberOfHits; }

◆ rbegin() [1/2]

const_reverse_iterator KM3NETDAQ::JDAQFrame::rbegin ( ) const

inlineinherited

Definition at line 147 of file JDAQFrame.hh.

147 { return const_reverse_iterator(end()); }

◆ rbegin() [2/2]

reverse_iterator KM3NETDAQ::JDAQFrame::rbegin ( )

inlineinherited

Definition at line 151 of file JDAQFrame.hh.

151 { return reverse_iterator(end()); }

◆ rend() [1/2]

const_reverse_iterator KM3NETDAQ::JDAQFrame::rend ( ) const

inlineinherited

Definition at line 148 of file JDAQFrame.hh.

148 { return const_reverse_iterator(begin()); }

◆ rend() [2/2]

reverse_iterator KM3NETDAQ::JDAQFrame::rend ( )

inlineinherited

Definition at line 152 of file JDAQFrame.hh.

152 { return reverse_iterator(begin()); }

◆ empty()

bool KM3NETDAQ::JDAQFrame::empty ( ) const

inlineinherited

Definition at line 155 of file JDAQFrame.hh.

155 { return numberOfHits == 0; }

◆ size()

int KM3NETDAQ::JDAQFrame::size ( ) const

inlineinherited

Definition at line 157 of file JDAQFrame.hh.

157 { return numberOfHits; }

◆ data() [1/2]

const JDAQHit* KM3NETDAQ::JDAQFrame::data ( ) const

inlineinherited

Definition at line 159 of file JDAQFrame.hh.

159 { return buffer; }

◆ data() [2/2]

JDAQHit* KM3NETDAQ::JDAQFrame::data ( )

inlineinherited

Definition at line 160 of file JDAQFrame.hh.

160 { return buffer; }

◆ operator[]()

const JDAQHit& KM3NETDAQ::JDAQFrame::operator[] ( int index ) const

inlineinherited

Get hit at given index.

Parameters

index index

Returns: hit

Definition at line 169 of file JDAQFrame.hh.

     {
       return buffer[index];
     }

◆ subset()

JDAQFrameSubset KM3NETDAQ::JDAQFrame::subset	(	const int	i1,
		const int	i2
	)		const

inlineinherited

Get subset of data.

Parameters

i1	first index of hit (included)
i2	last index of hit (excluded)

Returns: JDAQ frame

Definition at line 181 of file JDAQFrame.hh.

     {
       return JDAQFrameSubset(i2 - i1, buffer + i1);
     }

◆ swap()

void KM3NETDAQ::JDAQFrame::swap ( JDAQFrame & frame )

inlineinherited

Swap data.

Parameters

frame JDAQ frame

Definition at line 224 of file JDAQFrame.hh.

     {
       std::swap(numberOfHits, frame.numberOfHits);
       std::swap(buffer,       frame.buffer);
     }

◆ ClassDef() [6/6]

KM3NETDAQ::JDAQFrame::ClassDef	(	JDAQFrame	,
		1
	)

inherited

◆ resize()

void KM3NETDAQ::JDAQFrame::resize ( const int number_of_hits )

inlineprotectedinherited

Resize internal buffer.

This method increases the size of the buffer if necessary. Otherwise, the current size is maintained.

Parameters

number_of_hits total number of hits to allocate

Definition at line 287 of file JDAQFrame.hh.

     {
       if (number_of_hits > numberOfHits) {
  
         const int number_of_bytes = number_of_hits * sizeof(JDAQHit);
  
         if (buffer == NULL)
           buffer = (JDAQHit*) malloc(number_of_bytes);
         else
           buffer = (JDAQHit*) realloc(buffer, number_of_bytes);
  
         if (buffer == NULL)
           throw JDAQException("JDAQFrame::resize(): Memory exception.");
  
         numberOfHits = number_of_hits;
       }
     }

Friends And Related Function Documentation

◆ operator>>

JReader& operator>>	(	JReader &	in,
		JDAQSuperFrame &	frame
	)

friend

Read JDAQSuperFrame from input.

Parameters

in	JReader
frame	JDAQSuperFrame

Returns: JReader

Definition at line 135 of file JDAQSuperFrame.hh.

     {
       in >> static_cast<JDAQPreamble&>        (frame);
       in >> static_cast<JDAQSuperFrameHeader&>(frame);
       in >> static_cast<JDAQFrame&>           (frame);
  
       return in;
     }

◆ operator<<

JWriter& operator<<	(	JWriter &	out,
		const JDAQSuperFrame &	frame
	)

friend

Write JDAQSuperFrame to output.

Parameters

out	JWriter
frame	JDAQSuperFrame

Returns: JWriter

Definition at line 152 of file JDAQSuperFrame.hh.

     {
       out << static_cast<const JDAQPreamble&>        (frame);
       out << static_cast<const JDAQSuperFrameHeader&>(frame);
       out << static_cast<const JDAQFrame&>           (frame);
  
       return out;
     }

Member Data Documentation

◆ length

int KM3NETDAQ::JDAQAbstractPreamble::length

protectedinherited

Definition at line 79 of file JDAQAbstractPreamble.hh.

◆ type

int KM3NETDAQ::JDAQAbstractPreamble::type

protectedinherited

Definition at line 80 of file JDAQAbstractPreamble.hh.

◆ detector_id

int KM3NETDAQ::JDAQChronometer::detector_id

protectedinherited

Definition at line 237 of file JDAQChronometer.hh.

◆ run

int KM3NETDAQ::JDAQChronometer::run

protectedinherited

Definition at line 238 of file JDAQChronometer.hh.

◆ frame_index

int KM3NETDAQ::JDAQChronometer::frame_index

protectedinherited

Definition at line 239 of file JDAQChronometer.hh.

◆ timeslice_start

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::timeslice_start

protectedinherited

Definition at line 240 of file JDAQChronometer.hh.

◆ id

int KM3NETDAQ::JDAQModuleIdentifier::id

protectedinherited

Definition at line 153 of file JDAQModuleIdentifier.hh.

◆ daq

int KM3NETDAQ::JDAQFrameStatus::daq

protectedinherited

Definition at line 384 of file JDAQFrameStatus.hh.

◆ status

int KM3NETDAQ::JDAQFrameStatus::status

protectedinherited

Definition at line 385 of file JDAQFrameStatus.hh.

◆ fifo

int KM3NETDAQ::JDAQFrameStatus::fifo

protectedinherited

Definition at line 386 of file JDAQFrameStatus.hh.

◆ status_3

int KM3NETDAQ::JDAQFrameStatus::status_3

protectedinherited

Definition at line 387 of file JDAQFrameStatus.hh.

◆ status_4

int KM3NETDAQ::JDAQFrameStatus::status_4

protectedinherited

Definition at line 388 of file JDAQFrameStatus.hh.

◆ numberOfHits

int KM3NETDAQ::JDAQFrame::numberOfHits

inherited

Definition at line 271 of file JDAQFrame.hh.

◆ buffer

JDAQHit* KM3NETDAQ::JDAQFrame::buffer

inherited

Definition at line 272 of file JDAQFrame.hh.

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

JDAQSuperFrame.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ const_reverse_iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ JDAQSuperFrame() [1/3]

◆ JDAQSuperFrame() [2/3]

◆ JDAQSuperFrame() [3/3]

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ getSize()

◆ ClassDef() [1/6]

◆ sizeOf() [1/2]

◆ ClassDef() [2/6]

◆ setLength()

◆ getLength()

◆ getDataType()

◆ ClassDefNV() [1/3]

◆ getDAQSuperFrameHeader()

◆ setDAQSuperFrameHeader()

◆ sizeOf() [2/2]

◆ ClassDef() [3/6]

◆ ClassDef() [4/6]

◆ ClassDef() [5/6]

◆ getDAQHeader()

◆ setDAQHeader()

◆ getDAQChronometer()

◆ setDAQChronometer()

◆ getDetectorID()

◆ getRunNumber()

◆ getFrameIndex()

◆ getTimesliceStart()

◆ setRunNumber()

◆ setFrameIndex()

◆ setTimesliceStart()

◆ getModuleIdentifier()

◆ setModuleIdentifier()

◆ getModuleID()

◆ ClassDefNV() [2/3]

◆ ClassDefNV() [3/3]

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

◆ clear()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]