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.
bool	is_valid () const
	Check validity of summary data.
const JDAQSummaryslice *	getSummaryslice () const
	Get summary slice.
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 double rate_Hz) const
	Get rate.

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.

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

Constructor & Destructor Documentation

JSummaryRouter()

JSUPPORT::JSummaryRouter::JSummaryRouter ( )

inline

Default constructor.

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

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

Member Function Documentation

update()

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

inline

Update router.

Parameters

ps	pointer to new summary slice

Definition at line 52 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));
        }
      }
    }

is_valid()

bool JSUPPORT::JSummaryRouter::is_valid ( ) const

inline

Check validity of summary data.

Returns

true if summary data available; else false

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

    {
      return summary != NULL;
    }

getSummaryslice()

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

inline

Get summary slice.

Returns

pointer to summary slice (may be NULL)

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

    {
      return summary;
    }

getAddress()

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

inline

Get address of module.

Parameters

module

module

Returns

address

Definition at line 103 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 115 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 127 of file JSupport/JSummaryRouter.hh.

    {
      if (router.has(module.getModuleID()))
        return (*summary)[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 143 of file JSupport/JSummaryRouter.hh.

    {
      if (router.has(module.getModuleID())) {
 
        return (*summary)[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()

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

Member Data Documentation

router

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

private

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

summary

const JDAQSummaryslice* JSUPPORT::JSummaryRouter::summary

private

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

frame

JDAQSummaryFrame JSUPPORT::JSummaryRouter::frame

mutableprivate

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

---

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

• JSupport/JSummaryRouter.hh