BCParameter.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008, Daniel Kollar and Kevin Kroeninger. 
 * All rights reserved. 
 * 
 * For the licensing terms see doc/COPYING. 
 */ 

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

#ifndef __BCPARAMETER__H
#define __BCPARAMETER__H

#include <string>
#include <vector>

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

class BCParameter
{

 public:

   /* @{ */ 

   BCParameter(); 

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

   BCParameter(const BCParameter & parameter); 

   ~BCParameter(); 

   /* @} */ 

   /* @{ */ 

   BCParameter & operator = (const BCParameter & parameter); 

   /* @} */ 

   /* @{ */ 

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

   int GetIndex()
   { return fIndex; }; 

   double GetLowerLimit()
   { return fLowerLimit; }; 

   double GetUpperLimit()
   { return fUpperLimit; }; 

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

   /* @} */ 

   /* @{ */ 

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

   void SetIndex(int index) 
   { fIndex = index; }; 

   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 SetNuisance(int nuisance = 1)
   { fNuisance = nuisance; };

   /* @} */ 

   /* @{ */ 

   double IsNuisance()
   { return fNuisance; }; 

   bool IsAtLimit(double value); 

   void PrintSummary(); 

   /* @} */ 

 private: 

   /* 
    * Copies this BCParameter into another one 
    */ 
   void Copy(BCParameter & parameter) const; 

   std::string fName; 

   int fIndex; 

   double fLowerLimit; 

   double fUpperLimit; 

   int fNuisance;

}; 

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

/*
 * \typedef 
 * \brief A vector of pointer to BCParameter. 
 */
typedef std::vector<BCParameter*> BCParameterSet; 

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

#endif 

---