BCParameter.h

Go to the documentation of this file.

#ifndef __BCPARAMETER__H
#define __BCPARAMETER__H

/*
 * Copyright (C) 2007-2013, the BAT core developer team
 * All rights reserved.
 *
 * For the licensing terms see doc/COPYING.
 * For documentation see http://mpp.mpg.de/bat
 */

// ---------------------------------------------------------
#include <string>

// ---------------------------------------------------------

class BCParameter
{

   public:

      BCParameter();

      BCParameter(const char* name, double lowerlimit, double upperlimit, const char* latexname = "");

      const std::string & GetName() const
         { return fName; }

      const std::string & GetLatexName() const
         { return (fLatexName.empty()) ? fName : fLatexName; }

      double GetLowerLimit() const
         { return fLowerLimit; }

      double GetUpperLimit() const
         { return fUpperLimit; }

      double GetRangeWidth() const
         { return (fUpperLimit > fLowerLimit) ? fUpperLimit - fLowerLimit : fLowerLimit - fUpperLimit; }

      bool FillHistograms() const
         { return fFillHistograms; }

      bool Fixed() const
         { return fFixed; }

      double GetFixedValue() const
         { return fFixedValue; }

      unsigned GetNbins() const
         { return fNbins; }

      void SetName(const char * name)
         { fName = name; }

      void SetLatexName(const char * latex_name)
         { fLatexName = latex_name; }

      void SetLowerLimit(double limit = 0)
         { fLowerLimit = limit; }

      void SetUpperLimit(double limit = 1)
         { fUpperLimit = limit; }

      void SetLimits(double lowerlimit = 0, double upperlimit = 1)
         { fLowerLimit = lowerlimit; fUpperLimit = upperlimit; }

      void Fix(double value)
      {
         fFixed = true;
         fFixedValue = value;
      }

      void Unfix()
         { fFixed = false; }

      void FillHistograms(bool flag)
         { fFillHistograms = flag; }

      void SetNbins(unsigned nbins)
         { fNbins = nbins; }
      bool IsAtLimit(double value) const;

      bool IsValid(double value) const
      { return (fLowerLimit <= value) && (value <= fUpperLimit) ? true : false; }

      void PrintSummary() const;

   private:
      std::string fName;

      double fLowerLimit;

      double fUpperLimit;

      std::string fLatexName;

      bool fFixed;

      double fFixedValue;

      bool fFillHistograms;

      unsigned fNbins;
};
#endif