JSupport/JSummaryRouter.hh

Go to the documentation of this file.

#ifndef __JSUPPORT__JSUMMARYROUTER__
#define __JSUPPORT__JSUMMARYROUTER__

#include "km3net-dataformat/online/JDAQSummaryslice.hh"
#include "km3net-dataformat/online/JDAQModuleIdentifier.hh"
#include "km3net-dataformat/online/JDAQPMTIdentifier.hh"

#include "JTools/JRouter.hh"


/**
 * \author mdejong
 */

namespace JSUPPORT {}
namespace JPP { using namespace JSUPPORT; }

namespace JSUPPORT {

  using KM3NETDAQ::JDAQSummaryslice;
  using KM3NETDAQ::JDAQSummaryFrame;
  using KM3NETDAQ::JDAQModuleIdentifier;
  using KM3NETDAQ::JDAQPMTIdentifier;
  

  /**
   * Router for fast addressing of summary data in JDAQSummaryslice data structure
   * as a function of the optical module identifier and PMT address.
   *
   * The member method JSummaryRouter::update should be used to update the internal router for a given event.\n
   * The member method JSummaryRouter::getRate can then be used to obtain the measured singles rate for a given PMT.\n
   * Note that if there is no measured rate or if it is below the specified default rate, the default rate is taken.
   */
  class JSummaryRouter {
  public:
    /**
     * Constructor.
     *
     * \param  rate_Hz         default singles rate [Hz]
     */
    JSummaryRouter(const double rate_Hz = 0.0) :
      rate_Hz(rate_Hz),
      router (-1),
      summary(NULL)
    {}


    /**
     * Get default rate.
     *
     * \return                 rate [Hz]
     */
    double getRate() const
    {
      return rate_Hz;
    }


    /**
     * Set default rate.
     *
     * \param  rate_Hz         rate [Hz]
     */
    void setRate(const double rate_Hz)
    {
      this->rate_Hz = rate_Hz;
    }


    /**
     * Update router.
     *
     * \param  ps              pointer to new summary slice
     */
    void update(const JDAQSummaryslice* ps)
    {
      // 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));
        }
      }
    }


    /**
     * Check validity of summary data.
     *
     * \return                 true if summary data available; else false
     */
    bool is_valid() const
    {
      return summary != NULL;
    }


    /**
     * Get summary slice.
     *
     *                         pointer to summary slice (may be NULL)
     */
    const JDAQSummaryslice* getSummaryslice() const
    {
      return summary;
    }


    /**
     * Get address of module.
     *
     * \param  module          module
     * \return                 address
     */
    const int getAddress(const JDAQModuleIdentifier& module) const
    {
      return router.get(module.getModuleID());
    }
    

    /**
     * Get summary frame.
     *
     * \param  module          module
     * \return                 summary frame
     */
    const JDAQSummaryFrame& getSummaryFrame(const JDAQModuleIdentifier& module) const
    {
      return (*summary)[getAddress(module)];
    }
    

    /**
     * Has summary frame.
     *
     * \param  module          module
     * \return                 true if module present; else false
     */
    bool hasSummaryFrame(const JDAQModuleIdentifier& module) const
    {
      return router.has(module.getModuleID());
    }


    /**
     * Get rate.
     *
     * \param  id              PMT identifier
     * \return                 rate [Hz]
     */
    double getRate(const JDAQPMTIdentifier& id) const
    {
      if (this->hasSummaryFrame(id.getModuleIdentifier())) {

        const double R = this->getSummaryFrame(id.getModuleIdentifier()).getRate(id.getPMTAddress());

        if (R > rate_Hz) {
          return R;
        }
      }

      return rate_Hz;
    }

  private:
    double                  rate_Hz;
    JTOOLS::JRouter<int>    router;
    const JDAQSummaryslice* summary;
  };
}

#endif