JEvtWeightFactorHelper.hh

Go to the documentation of this file.

#ifndef __JAANET__JEVTWEIGHTFACTORHELPER__
#define __JAANET__JEVTWEIGHTFACTORHELPER__

#include "km3net-dataformat/offline/Evt.hh"

#include "JLang/JSharedPointer.hh"

#include "JAAnet/JEvtWeightFactor.hh"

/**
 * \author bjung
 */

namespace JAANET {
  
  using JLANG::JSharedPointer;
  using JLANG::JNullPointerException;
  
  
  /**
   * Helper class for event-weight factor.
   */
  struct JEvtWeightFactorHelper :
    public JSharedPointer<JEvtWeightFactor>
  {
    using JSharedPointer<JEvtWeightFactor>::is_valid;
    
    /**
     * Default constructor.
     */
    JEvtWeightFactorHelper()
    {}
    
    
    /**
     * Constructor.
     *
     * \param  factor            event-weight factor
     */
    JEvtWeightFactorHelper(const JEvtWeightFactor& factor)
    {
      configure(factor);
    }
    
    
    /**
     * Configure event-weight factor.
     *
     * \param  factor            event-weight factor
     */
    void configure(const JEvtWeightFactor& factor)
    {
      reset(factor.clone());
    }

    
    /**
     * Get weight-factor of given event.
     *
     * \param  evt               event
     * \return                   event-weight factor
     */
    double getFactor(const Evt& evt) const
    {
      if (is_valid()) {
        return get()->getFactor(evt);
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::getFactor(): Unspecified event-weighting factor.");
      }
    }
    
    
    /**
     * Get flux of given event.
     *
     * \param  evt               event
     * \return                   flux         [GeV * m^-2 * sr^-1 * s^-1]
     */
    double getFlux(const Evt& evt) const
    {
      if (is_valid()) {
        return get()->getFlux(evt);
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::getFlux(): Unspecified flux function.");
      }
    }
  };
}

#endif