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.

	JSummaryRouter (const double rate_Hz)
	Constructor with default rate.

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

double	getRate () const
	Get default rate.

bool	hasDefault () const
	Has default.

void	setDefault (const double rate_Hz)
	Set default.

void	unsetDefault ()
	Unset default.

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.

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

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

Private Attributes
JTOOLS::JRouter< int >	router

const JDAQSummaryslice *	summary

JDAQSummaryFrame	frame

double	rate_Hz

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

◆ JSummaryRouter() [1/2]

JSUPPORT::JSummaryRouter::JSummaryRouter ( )

inline

Default constructor.

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

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

◆ JSummaryRouter() [2/2]

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

inline

Constructor with default rate.

Parameters

rate_Hz singles rate [Hz]

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

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

Member Function Documentation

◆ getSummaryFrame() [1/2]

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

inline

Get default summary frame.

Returns: summary frame

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

    {
      return frame;
    }

◆ getRate() [1/2]

double JSUPPORT::JSummaryRouter::getRate ( ) const

inline

Get default rate.

Returns: rate [Hz]

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

    {
      return this->rate_Hz;
    }

◆ hasDefault()

bool JSUPPORT::JSummaryRouter::hasDefault ( ) const

inline

Has default.

Returns: true if default has been set; else false

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

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

◆ setDefault()

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

inline

Set default.

Parameters

rate_Hz rate [Hz]

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

    {
      using namespace KM3NETDAQ;
 
      this->rate_Hz = rate_Hz;
 
      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);
      }
    }

◆ unsetDefault()

void JSUPPORT::JSummaryRouter::unsetDefault ( )

inline

Unset default.

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

◆ update()

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

inline

Update router.

Parameters

ps	pointer to new summary slice

Definition at line 141 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 169 of file JSupport/JSummaryRouter.hh.

    {
      return summary != NULL;
    }

◆ getSummaryslice()

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

inline

Get summary slice.

                    pointer to summary slice (may be NULL)

Definition at line 180 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 192 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 204 of file JSupport/JSummaryRouter.hh.

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

◆ getSummaryFrame() [2/2]

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

inline

Get summary frame.

Parameters

module module

Returns: summary frame

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

◆ getRate() [2/2]

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

inline

Get rate.

Parameters

id	PMT identifier

Returns: rate [Hz]

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

Member Data Documentation

◆ MODULE_IDENTIFIER

const int JSUPPORT::JSummaryRouter::MODULE_IDENTIFIER = 1

static

module identifier to allow default

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

◆ router

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

private

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

◆ summary

const JDAQSummaryslice* JSUPPORT::JSummaryRouter::summary

private

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

◆ frame

JDAQSummaryFrame JSUPPORT::JSummaryRouter::frame

private

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

◆ rate_Hz

double JSUPPORT::JSummaryRouter::rate_Hz

private

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

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

JSupport/JSummaryRouter.hh

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JSummaryRouter() [1/2]

◆ JSummaryRouter() [2/2]

Member Function Documentation

◆ getSummaryFrame() [1/2]

◆ getRate() [1/2]

◆ hasDefault()

◆ setDefault()

◆ unsetDefault()

◆ update()

◆ is_valid()

◆ getSummaryslice()

◆ getAddress()

◆ hasSummaryFrame()

◆ getSummaryFrame() [2/2]

◆ getRate() [2/2]

Member Data Documentation

◆ MODULE_IDENTIFIER

◆ router

◆ summary

◆ frame

◆ rate_Hz