GFluxExposureI.h

Go to the documentation of this file.

//____________________________________________________________________________
/*!

\class   genie::flux::GFluxExposureI

\brief   GENIE interface for uniform flux exposure iterface

         Unified flux exposure interface to be used by flux drivers
         that can support such.

\author  Robert Hatcher <rhatcher \at fnal.gov>
         Fermi National Accelerator Laboratory

\created 2015-03-17

\cpright Copyright (c) 2003-2024, The GENIE Collaboration
         for the full text of the license visit http://copyright.genie-mc.org
*/
//____________________________________________________________________________

#ifndef GENIE_FLUX_GFLUXEXPOSUREI_H
#define GENIE_FLUX_GFLUXEXPOSUREI_H

#include <string>
#include <ctype.h>

namespace genie {
namespace flux {

  typedef enum EExposure {
    kUnknown   = 0,
    kPOTs      = 1,  // particles (protons) on target
    kSeconds   = 2,  // exposure duration
    kNExposureTypes  //
  } Exposure_t;

  class GFluxExposureI {

  public:

    GFluxExposureI(genie::flux::Exposure_t etype);
    virtual ~GFluxExposureI();

    /// what units are returned by GetTotalExposure?
    const char*             GetExposureUnits() const;
    genie::flux::Exposure_t GetExposureType() const;

    //
    // define the GFluxExposureI interface:
    //
    virtual double    GetTotalExposure() const = 0;

    /// # of rays generated
    virtual long int  NFluxNeutrinos() const = 0;


    // string conversions for the associated enum
    static const char*              AsString(genie::flux::Exposure_t etype);
    static genie::flux::Exposure_t  StringToEnum(const char* chars, int maxChar=0);

  private:
    genie::flux::Exposure_t fEType;

  };

} // namespace flux
} // namespace genie

#endif //GENIE_FLUX_GFLUXEXPOSUREI_H