ConfigParameter.h

Go to the documentation of this file.

#ifndef _utl_ConfigParameter_h_
#define _utl_ConfigParameter_h_

#include <memory>
#include <string>  // std::string cannot be fwd-declared.


namespace utl {

  class RandomEngine;
  class VRandomSampler;
  class Branch;


  class ConfigParameter {
  public:
    typedef double Type;

    ConfigParameter(utl::RandomEngine& eng, const utl::Branch& configData);

    ~ConfigParameter();

    Type operator()() const;

    enum FunctionType  {
      eFixed,    //< Constant function.
      ePDF,      //< Probability density distribution.
      eCDF,      //< Cummulative density distribution.
      eValueList //< The values are taken one-by-one from a list.
    };

    static const char* const kFunctionTypeTags[];

    enum Parametrization {
      eFormula,
      eFormulaWithVariable,
      eMap,
      eTabulatedFunction,
      eVector,
      eVectorPair
    };

    static const char* const kParametrizationTags[];

    static const char* const kInterpolationTags[];

  private:
    utl::RandomEngine& fEngine;
    std::unique_ptr<utl::VRandomSampler> fSampler;
    mutable Type fLastValue;  // placeholder for the last previous value.
    bool fDelta = false;
  };

}


#endif