BCParameter Class Reference

#include <BCParameter.h>

List of all members.

---

Detailed Description

A class representing a parameter of a model.

Author:

Daniel Kollar

Kevin Kröninger

Version:

1.0

Date:

08.2008 This class represents a parameter of a model. It contains information about the name and the range of the parameter.

Definition at line 29 of file BCParameter.h.

Public Member Functions
Constructors and destructors
	BCParameter (const BCParameter &parameter)
	BCParameter (const char *name, double lowerlimit, double upperlimit)
	BCParameter ()
	~BCParameter ()
Member functions (get)
int	GetIndex ()
double	GetLowerLimit ()
std::string	GetName ()
double	GetRangeWidth ()
double	GetUpperLimit ()
Member functions (miscellaneous methods)
bool	IsAtLimit (double value)
double	IsNuisance ()
void	PrintSummary ()
Assignment operators
BCParameter &	operator= (const BCParameter &parameter)
Member functions (set)
void	SetIndex (int index)
void	SetLimits (double lowerlimit=0, double upperlimit=1)
void	SetLowerLimit (double limit=0)
void	SetName (const char *name)
void	SetNuisance (int nuisance=1)
void	SetUpperLimit (double limit=1)
Private Member Functions
void	Copy (BCParameter &parameter) const
Private Attributes
int	fIndex
double	fLowerLimit
std::string	fName
int	fNuisance
double	fUpperLimit

---

Constructor & Destructor Documentation

BCParameter::BCParameter

(

)

The default constructor.

Definition at line 17 of file BCParameter.cxx.

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

A constructor.

Parameters:

	name	The name of the parameter.
	lowerlimit	The lower limit of the parameter values.
	upperlimit	The upper limit of the parameter values.

Definition at line 29 of file BCParameter.cxx.

BCParameter::BCParameter

(

const BCParameter &

parameter

)

The default copy constructor.

Definition at line 42 of file BCParameter.cxx.

BCParameter::~BCParameter

(

)

The default destructor.

Definition at line 63 of file BCParameter.cxx.

---

Member Function Documentation

void BCParameter::Copy

(

BCParameter &

parameter

)

const [private]

Definition at line 91 of file BCParameter.cxx.

int BCParameter::GetIndex

(

)

[inline]

Returns the index of the parameter within the parameter container of a BCModel.

Returns:

The index of the parameter in the model.

Definition at line 86 of file BCParameter.h.

double BCParameter::GetLowerLimit

(

)

[inline]

Returns:

The lower limit of the parameter values.

Definition at line 92 of file BCParameter.h.

std::string BCParameter::GetName

(

)

[inline]

Returns:

The name of the parameter.

Definition at line 78 of file BCParameter.h.

double BCParameter::GetRangeWidth

(

)

[inline]

Returns the range width of the parameter values. It is always a positive value.

Returns:

The range width of the parameter values.

Definition at line 106 of file BCParameter.h.

double BCParameter::GetUpperLimit

(

)

[inline]

Returns:

The upper limit of the parameter values.

Definition at line 98 of file BCParameter.h.

bool BCParameter::IsAtLimit

(

double

value

)

Returns true if the value is at a parameter limit.

Returns:

flag States if value is at parameter limit.

Definition at line 104 of file BCParameter.cxx.

double BCParameter::IsNuisance

(

)

[inline]

Returns 1 if parameter is a nuisance parameter or 0 if not.

Returns:

1 - is nuisance paramete, 0 - is not nuisance parameter

Definition at line 166 of file BCParameter.h.

BCParameter & BCParameter::operator=

(

const BCParameter &

parameter

)

The defaut assignment operator.

Definition at line 51 of file BCParameter.cxx.

void BCParameter::PrintSummary

(

)

Prints a parameter summary on the screen.

Definition at line 70 of file BCParameter.cxx.

void BCParameter::SetIndex

(

int

index

)

[inline]

Set the index of the parameter within the parameter container of a BCModel.

Parameters:

index

The index of the parameter.

Definition at line 125 of file BCParameter.h.

void BCParameter::SetLimits	(	double	lowerlimit = 0,
		double	upperlimit = 1
	)			[inline]

Set the limits of the parameter values.

Parameters:

	lowerlimit	The lower limit of the parameter values.
	upperlimit	The upper limit of the parameter values.

Definition at line 147 of file BCParameter.h.

void BCParameter::SetLowerLimit

(

double

limit = 0

)

[inline]

Set the lower limit of the parameter values.

Parameters:

limit

The lower limit of the parameter values.

Definition at line 132 of file BCParameter.h.

void BCParameter::SetName

(

const char *

name

)

[inline]

Parameters:

name

The name of the parameter.

Definition at line 117 of file BCParameter.h.

void BCParameter::SetNuisance

(

int

nuisance = 1

)

[inline]

Set parameter to be nuisance.

Parameters:

nuisance

1 - nuisance, 0 - not nuisance

Definition at line 154 of file BCParameter.h.

void BCParameter::SetUpperLimit

(

double

limit = 1

)

[inline]

Set the upper limit of the parameter values.

Parameters:

limit

The upper limit of the parameter values.

Definition at line 139 of file BCParameter.h.

---

Member Data Documentation

int BCParameter::fIndex [private]

The index of the parameter within the BCParameterSet of a BCModel.

Definition at line 198 of file BCParameter.h.

double BCParameter::fLowerLimit [private]

The lower limit of the parameter value.

Definition at line 203 of file BCParameter.h.

std::string BCParameter::fName [private]

The name of the parameter.

Definition at line 192 of file BCParameter.h.

int BCParameter::fNuisance [private]

Flag to specify whether to integrate over this parameter or not.

Definition at line 214 of file BCParameter.h.

double BCParameter::fUpperLimit [private]

The upper limit of the parameter value.

Definition at line 208 of file BCParameter.h.