JSUPPORT::JSummaryRouter Class Reference

Router for fast addressing of summary data in KM3NETDAQ::JDAQSummaryslice data structure as a function of the optical module identifier and PMT address. More...

#include <JSummaryRouter.hh>

Inheritance diagram for JSUPPORT::JSummaryRouter:

Public Member Functions
	JSummaryRouter ()
	Default constructor.
void	update (const JDAQSummaryslice *ps)
	Update router.
const int	getAddress (const JDAQModuleIdentifier &module) const
	Get address of module.
bool	hasSummaryFrame (const JDAQModuleIdentifier &module) const
	Has summary frame.
const JDAQSummaryFrame &	getSummaryFrame (const JDAQModuleIdentifier &module) const
	Get summary frame.
const JDAQSummaryFrame &	getSummaryFrame (const JDAQModuleIdentifier &module, const double rate_Hz) const
	Get summary frame.
double	getRate (const JDAQPMTIdentifier &id) const
	Get rate.
double	getRate (const JDAQPMTIdentifier &id, const double rate_Hz) const
	Get rate.
std::ostream &	print (std::ostream &out, const bool lpr=false) const
	Print DAQ summary.
	ClassDef (JDAQSummaryslice, 6)
	ClassDef (JDAQPreamble, 1)
	ClassDef (JDAQSummarysliceHeader, 2)
	ClassDef (JDAQHeader, 2)
	ClassDef (JDAQChronometer, 3)
int	getLength () const
	Get length.
int	getDataType () const
	Get data type.
	ClassDefNV (JDAQAbstractPreamble, 1)
const JDAQSummarysliceHeader &	getDAQSummarysliceHeader () const
	Get DAQ summary slice header.
const JDAQHeader &	getDAQHeader () const
	Get DAQ header.
void	setDAQHeader (const JDAQHeader &header)
	Set DAQ header.
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.

Static Public Member Functions
static void	actionAtFileOpen (int version)
	Action method at file open.
template<class T >
static JDAQPreamble	getDAQPreamble (const T &object)
	Get DAQ preamble.

Protected Attributes
int	length
int	type
int	detector_id
int	run
int	frame_index
JDAQUTCExtended	timeslice_start

Private Attributes
JTOOLS::JRouter< int >	router
JDAQSummaryFrame	frame

Detailed Description

Router for fast addressing of summary data in KM3NETDAQ::JDAQSummaryslice data structure as a function of the optical module identifier and PMT address.

The member method update() should be used to update the internal router for a given event. The member method getRate(const JDAQPMTIdentifier&) const can subsequently be used to obtain the measured singles rate for a given PMT.

Definition at line 36 of file JSupport/JSummaryRouter.hh.

Constructor & Destructor Documentation

JSummaryRouter()

JSUPPORT::JSummaryRouter::JSummaryRouter ( )

inline

Default constructor.

Definition at line 43 of file JSupport/JSummaryRouter.hh.

                     :
      router (-1)
    {}

Member Function Documentation

update()

void JSUPPORT::JSummaryRouter::update ( const JDAQSummaryslice * ps )

inline

Update router.

Parameters

ps	pointer to new summary slice

Definition at line 53 of file JSupport/JSummaryRouter.hh.

    {
      if (ps != NULL) {
 
        // reset internal router
 
        for (JDAQSummaryslice::const_iterator i = this->begin(); i != this->end(); ++i) {
          router.put(i->getModuleID(), router.getDefaultAddress());
        }
      
        static_cast<JDAQSummaryslice&>(*this) = *ps;
 
        // set internal router
 
        for (JDAQSummaryslice::const_iterator i = this->begin(); i != this->end(); ++i) {
          router.put(i->getModuleID(), distance(this->cbegin(), i));
        }
      }
    }

getAddress()

const int JSUPPORT::JSummaryRouter::getAddress ( const JDAQModuleIdentifier & module ) const

inline

Get address of module.

Parameters

module

module

Returns

address

Definition at line 80 of file JSupport/JSummaryRouter.hh.

    {
      return router.get(module.getModuleID());
    }

hasSummaryFrame()

bool JSUPPORT::JSummaryRouter::hasSummaryFrame ( const JDAQModuleIdentifier & module ) const

inline

Has summary frame.

Parameters

module

module

Returns

true if module present; else false

Definition at line 92 of file JSupport/JSummaryRouter.hh.

    {
      return router.has(module.getModuleID());
    }

getSummaryFrame() [1/2]

const JDAQSummaryFrame & JSUPPORT::JSummaryRouter::getSummaryFrame ( const JDAQModuleIdentifier & module ) const

inline

Get summary frame.

Parameters

module

module

Returns

summary frame

Definition at line 104 of file JSupport/JSummaryRouter.hh.

    {
      if (router.has(module.getModuleID()))
        return (*this)[getAddress(module)];
      else
        THROW(JValueOutOfRange, "Module identifier " << module);
    }

getSummaryFrame() [2/2]

const JDAQSummaryFrame & JSUPPORT::JSummaryRouter::getSummaryFrame ( const JDAQModuleIdentifier & module, const double rate_Hz ) const

inline

Get summary frame.

Parameters

module	module
rate_Hz	default rate [Hz]

Returns

summary frame

Definition at line 120 of file JSupport/JSummaryRouter.hh.

    {
      if (router.has(module.getModuleID())) {
 
        return (*this)[getAddress(module)];
 
      } else {
 
        frame.setModuleIdentifier(module);
        frame.setDAQFrameStatus(JDAQFrameStatus::getInstance());     // valid status
 
        for (int i = 0; i != NUMBER_OF_PMTS; ++i) {
          frame.setRate(i, rate_Hz);
        }
 
        return frame;
      }
    }

getRate() [1/2]

double JSUPPORT::JSummaryRouter::getRate ( const JDAQPMTIdentifier & id ) const

inline

Get rate.

Parameters

id	PMT identifier

Returns

rate [Hz]

Definition at line 146 of file JSupport/JSummaryRouter.hh.

    {
      if (this->hasSummaryFrame(id.getModuleIdentifier()))
        return this->getSummaryFrame(id.getModuleIdentifier()).getRate(id.getPMTAddress());
      else
        THROW(JValueOutOfRange, "Module identifier " << id.getModuleIdentifier());
    }

getRate() [2/2]

double JSUPPORT::JSummaryRouter::getRate ( const JDAQPMTIdentifier & id, const double rate_Hz ) const

inline

Get rate.

Parameters

id	PMT identifier
rate_Hz	default rate [Hz]

Returns

rate [Hz]

Definition at line 162 of file JSupport/JSummaryRouter.hh.

    {
      double R = 0.0;
 
      if (this->hasSummaryFrame(id.getModuleIdentifier())) {
        R = this->getSummaryFrame(id.getModuleIdentifier()).getRate(id.getPMTAddress());
      }
 
      if (R < rate_Hz) {
        R = rate_Hz;
      }
      
      return R;
    }

print()

std::ostream & KM3NETDAQ::JDAQSummaryslice::print ( std::ostream & out, const bool lpr = false ) const

inlineinherited

Print DAQ summary.

Parameters

out	output stream
lpr	long print

Returns

output stream

Definition at line 88 of file JDAQSummaryslice.hh.

    {
      using namespace std;
 
      out << this->ClassName() << endl;
      out << dynamic_cast<const JDAQPreamble&>   (*this) << endl;
      out << dynamic_cast<const JDAQChronometer&>(*this) << endl;
    
      for (JDAQSummaryslice::const_iterator module = this->begin(); module != this->end(); ++module) {
 
        out << ' ' << setw(10) << module->getModuleID();
        out << ' ' << setw(8)  << setfill('0') << hex << module->getStatus()     << dec << setfill(' ');
        out << '|' << setw(8)  << setfill('0') << hex << module->getFIFOStatus() << dec << setfill(' ');
        out << ' ' << setw(2)  << module->getUDPNumberOfReceivedPackets();
        out << ' ' << setw(2)  << module->getUDPMaximalSequenceNumber();
 
        if (lpr) {
          for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
            out << ' ' << fixed << showpoint << setw(4) << setprecision(1) << module->getRate(pmt) * 1.0e-3;
          }
        }
 
        out << endl;
      }
 
      return out;
    }

actionAtFileOpen()

static void KM3NETDAQ::JDAQSummaryslice::actionAtFileOpen ( int version )

inlinestaticinherited

Action method at file open.

Parameters

version

version

Definition at line 122 of file JDAQSummaryslice.hh.

    {
      JDAQSummaryFrame::ROOT_IO_VERSION = version;
    }

ClassDef() [1/5]

KM3NETDAQ::JDAQSummaryslice::ClassDef ( JDAQSummaryslice , 6  )

inherited

ClassDef() [2/5]

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

inherited

ClassDef() [3/5]

KM3NETDAQ::JDAQSummarysliceHeader::ClassDef ( JDAQSummarysliceHeader , 2  )

inherited

ClassDef() [4/5]

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

inherited

ClassDef() [5/5]

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

inherited

getDAQPreamble()

template<class T >

static JDAQPreamble KM3NETDAQ::JDAQPreamble::getDAQPreamble ( const T & object )

inlinestaticinherited

Get DAQ preamble.

This method should be used for binary I/O to get the actual data for the given object.
To this end, the following method should be overloaded for the corresponding data type.

   size_t  getSizeof(const T&);

Parameters

object

object

Returns

preamble

Definition at line 76 of file JDAQPreamble.hh.

    {
      static JDAQPreamble preamble;
 
      preamble.length = getSizeof(object);
      preamble.type   = KM3NETDAQ::getDataType<T>();
 
      return preamble;
    }

getLength()

int KM3NETDAQ::JDAQAbstractPreamble::getLength ( ) const

inlineinherited

Get length.

Returns

number of bytes

Definition at line 49 of file JDAQAbstractPreamble.hh.

    { 
      return length;
    }

getDataType()

int KM3NETDAQ::JDAQAbstractPreamble::getDataType ( ) const

inlineinherited

Get data type.

Returns

data type

Definition at line 60 of file JDAQAbstractPreamble.hh.

    { 
      return type; 
    }

ClassDefNV()

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

inherited

getDAQSummarysliceHeader()

const JDAQSummarysliceHeader & KM3NETDAQ::JDAQSummarysliceHeader::getDAQSummarysliceHeader ( ) const

inlineinherited

Get DAQ summary slice header.

Returns

DAQ summary slice header

Definition at line 44 of file JDAQSummarysliceHeader.hh.

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

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;
    }

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;
    }

Member Data Documentation

router

JTOOLS::JRouter<int> JSUPPORT::JSummaryRouter::router

private

Definition at line 178 of file JSupport/JSummaryRouter.hh.

frame

JDAQSummaryFrame JSUPPORT::JSummaryRouter::frame

mutableprivate

Definition at line 179 of file JSupport/JSummaryRouter.hh.

length

int KM3NETDAQ::JDAQAbstractPreamble::length

protectedinherited

Definition at line 69 of file JDAQAbstractPreamble.hh.

type

int KM3NETDAQ::JDAQAbstractPreamble::type

protectedinherited

Definition at line 70 of file JDAQAbstractPreamble.hh.

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.

---

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

• JSupport/JSummaryRouter.hh