JSUPPORT::JSummaryRouter Class Reference

Router for fast addressing of summary data in JDAQSummaryslice data structure as a function of the optical module identifier. More...

#include <JSummaryRouter.hh>

Inheritance diagram for JSUPPORT::JSummaryRouter:

Public Member Functions
	JSummaryRouter (const double rate_Hz=0.0)
	Constructor. More...
double	getRate () const
	Get default rate. More...
void	setRate (const double rate_Hz)
	Set default rate. 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...
const JDAQSummaryFrame &	getSummaryFrame (const JDAQModuleIdentifier &module) const
	Get summary frame. More...
bool	hasSummaryFrame (const JDAQModuleIdentifier &module) const
	Has summary frame. More...
double	getRate (const JDAQPMTIdentifier &id) const
	Get rate. More...

Private Attributes
double	rate_Hz
JTOOLS::JRouter< int >	router
const JDAQSummaryslice *	summary

Detailed Description

Router for fast addressing of summary data in JDAQSummaryslice data structure as a function of the optical module identifier.

The member method JSummaryRouter::update should be used to update the internal router for a given event.
The member method JSummaryRouter::getRate can then be used to obtain the measured singles rate for a given PMT.

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

Constructor & Destructor Documentation

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

inline

Constructor.

Parameters

rate_Hz

default singles rate [Hz]

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

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

Member Function Documentation

double JSUPPORT::JSummaryRouter::getRate ( ) const

inline

Get default rate.

Returns

rate [Hz]

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

    {
      return rate_Hz;
    }

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

inline

Set default rate.

Parameters

rate_Hz

rate [Hz]

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

    {
      this->rate_Hz = rate_Hz;
    }

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

inline

Update router.

Parameters

ps	pointer to new summary slice

Definition at line 74 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 102 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 113 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 125 of file JSupport/JSummaryRouter.hh.

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

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

inline

Get summary frame.

Parameters

module

module

Returns

summary frame

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

    {
      return (*summary)[getAddress(module)];
    }

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

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

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

inline

Get rate.

Parameters

id	PMT identifier

Returns

rate [Hz]

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

    {
      if (this->hasSummaryFrame(id.getModuleIdentifier())) 
        return this->getSummaryFrame(id.getModuleIdentifier()).getRate(id.getPMTAddress());
      else
        return rate_Hz;
    }

Member Data Documentation

double JSUPPORT::JSummaryRouter::rate_Hz

private

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

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

private

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

const JDAQSummaryslice* JSUPPORT::JSummaryRouter::summary

private

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

---

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

• JSupport/JSummaryRouter.hh