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. More...

	JSummaryRouter (const double rate_Hz)
	Constructor with default rate. More...

const JDAQSummaryFrame &	getSummaryFrame () const
	Get default summary frame. More...

double	getRate () const
	Get default rate. More...

bool	hasDefault () const
	Has default. More...

void	setDefault (const double rate_Hz)
	Set default. More...

void	unsetDefault ()
	Unset default. More...

void	update (const JDAQSummaryslice *ps)
	Update router. More...

bool	is_valid () const
	Check validity of summary data. More...

const JDAQSummaryslice *	getSummaryslice () const
	Get summary slice. More...

const int	getAddress (const JDAQModuleIdentifier &module) const
	Get address of module. More...

bool	hasSummaryFrame (const JDAQModuleIdentifier &module) const
	Has summary frame. More...

const JDAQSummaryFrame &	getSummaryFrame (const JDAQModuleIdentifier &module) const
	Get summary frame. More...

double	getRate (const JDAQPMTIdentifier &id) const
	Get rate. More...

Static Public Attributes
static const int	MODULE_IDENTIFIER = 1
	module identifier to allow default More...

Private Attributes
JTOOLS::JRouter< int >	router

const JDAQSummaryslice *	summary

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.

Optionally, a default rate can be set. In that case, a default KM3NETDAQ::JDAQSummaryFrame is setup which is used when no summary data are available or if the rate is below the specified default rate.
Note that the default rate is subject to the limited accuracy of the summary data.

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

Constructor & Destructor Documentation

JSUPPORT::JSummaryRouter::JSummaryRouter ( )

inline

Default constructor.

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

                      :
       router (-1),
       summary(NULL)
     {}

JSUPPORT::JSummaryRouter::JSummaryRouter ( const double rate_Hz )

inline

Constructor with default rate.

Parameters

rate_Hz singles rate [Hz]

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

                                          :
       router (-1),
       summary(NULL)
     {
       setDefault(rate_Hz);
     }

Member Function Documentation

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

inline

Get default summary frame.

Returns: summary frame

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

     {
       return frame;
     }

double JSUPPORT::JSummaryRouter::getRate ( ) const

inline

Get default rate.

Returns: rate [Hz]

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

     {
       return frame.getRate(0);
     }

bool JSUPPORT::JSummaryRouter::hasDefault ( ) const

inline

Has default.

Returns: true if default has been set; else false

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

     {
       return (frame.getModuleID() == MODULE_IDENTIFIER);
     }

void JSUPPORT::JSummaryRouter::setDefault ( const double rate_Hz )

inline

Set default.

Parameters

rate_Hz rate [Hz]

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

     {
       using namespace KM3NETDAQ;
 
       frame.setModuleIdentifier(MODULE_IDENTIFIER);                // allow default
       frame.setDAQFrameStatus(JDAQFrameStatus::getInstance());     // valid status
 
       for (int i = 0; i != NUMBER_OF_PMTS; ++i) {
         frame.setRate(i, rate_Hz);
       }
     }

void JSUPPORT::JSummaryRouter::unsetDefault ( )

inline

Unset default.

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

     {
       using namespace KM3NETDAQ;
 
       frame.setModuleIdentifier(JDAQModuleIdentifier());           // disallow default
       frame.setDAQFrameStatus(JDAQFrameStatus());                  // invalid status
 
       for (int i = 0; i != NUMBER_OF_PMTS; ++i) {
         frame[i] = JDAQRate();
       }
     }

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

inline

Update router.

Parameters

ps	pointer to new summary slice

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

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

bool JSUPPORT::JSummaryRouter::is_valid ( ) const

inline

Check validity of summary data.

Returns: true if summary data available; else false

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

     {
       return summary != NULL;
     }

const JDAQSummaryslice* JSUPPORT::JSummaryRouter::getSummaryslice ( ) const

inline

Get summary slice.

pointer to summary slice (may be NULL)

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

     {
       return summary;
     }

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

inline

Get address of module.

Parameters

module module

Returns: address

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

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

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 200 of file JSupport/JSummaryRouter.hh.

     {
       return router.has(module.getModuleID()) || this->hasDefault();
     }

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

inline

Get summary frame.

Parameters

module module

Returns: summary frame

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

     {
       if      (router.has(module.getModuleID()))
         return (*summary)[getAddress(module)];
       else if (this->hasDefault())
         return frame;
       else
         THROW(JValueOutOfRange, "Invalid module identifier " << module);
     }

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

inline

Get rate.

Parameters

id	PMT identifier

Returns: rate [Hz]

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

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