JSUPPORT::JSummaryFileRouter Class Reference

File router for fast addressing of summary data. More...

#include <JSummaryFileRouter.hh>

Inheritance diagram for JSUPPORT::JSummaryFileRouter:

Public Member Functions
	JSummaryFileRouter (const std::string &file_name)
	Constructor. More...
	JSummaryFileRouter (const std::string &file_name, const double rate_Hz)
	Constructor. More...
void	update (const JDAQHeader &header)
	Update router. More...
const JDAQSummaryFrame &	getSummaryFrame () const
	Get default summary frame. More...
const JDAQSummaryFrame &	getSummaryFrame (const JDAQModuleIdentifier &module) const
	Get summary frame. More...
double	getRate () const
	Get default rate. More...
double	getRate (const JDAQPMTIdentifier &id) const
	Get 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...

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

Detailed Description

File router for fast addressing of summary data.

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 at the closest time of the event.

Definition at line 36 of file JSummaryFileRouter.hh.

Constructor & Destructor Documentation

JSUPPORT::JSummaryFileRouter::JSummaryFileRouter ( const std::string &  file_name )

inline

Constructor.

Parameters

file_name

file name

Definition at line 46 of file JSummaryFileRouter.hh.

                                                   :
      JSummaryRouter(),
      JTreeScanner<JDAQSummaryslice, JDAQEvaluator>(file_name)
    {}

JSUPPORT::JSummaryFileRouter::JSummaryFileRouter ( const std::string &  file_name, const double  rate_Hz  )

inline

Constructor.

Parameters

file_name	file name
rate_Hz	default singles rate [Hz]

Definition at line 58 of file JSummaryFileRouter.hh.

                                                   :
      JSummaryRouter(rate_Hz),
      JTreeScanner<JDAQSummaryslice, JDAQEvaluator>(file_name)
    {}

Member Function Documentation

void JSUPPORT::JSummaryFileRouter::update ( const JDAQHeader &  header )

inline

Update router.

Parameters

header

header

Definition at line 70 of file JSummaryFileRouter.hh.

    {
      static Long64_t previous = -1;

      const  Long64_t index    = this->find(header);

      if (index != -1) {

        if (index != previous) {

          previous = index;

          JSummaryRouter::update(this->getEntry(index));
        }
      }
    }

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

inlineinherited

Get default summary frame.

Returns

summary frame

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

    {
      return frame;
    }

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

inlineinherited

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

double JSUPPORT::JSummaryRouter::getRate ( ) const

inlineinherited

Get default rate.

Returns

rate [Hz]

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

    {
      return this->rate_Hz;
    }

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

inlineinherited

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

bool JSUPPORT::JSummaryRouter::hasDefault ( ) const

inlineinherited

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

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

inlineinherited

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

void JSUPPORT::JSummaryRouter::unsetDefault ( )

inlineinherited

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

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

inlineinherited

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

bool JSUPPORT::JSummaryRouter::is_valid ( ) const

inlineinherited

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

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

inlineinherited

Get summary slice.

pointer to summary slice (may be NULL)

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

    {
      return summary;
    }

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

inlineinherited

Get address of module.

Parameters

module

module

Returns

address

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

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

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

inlineinherited

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

Member Data Documentation

const int JSUPPORT::JSummaryRouter::MODULE_IDENTIFIER = 1

staticinherited

module identifier to allow default

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

---

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

• JSummaryFileRouter.hh