laura is hosted by Hepforge, IPPP Durham
Laura++  v3r5
A maximum likelihood fitting package for performing Dalitz-plot analysis.
LauAbsRValue Class Referenceabstract

Pure abstract base class for defining a parameter containing an R value. More...

#include <LauAbsRValue.hh>

Inheritance diagram for LauAbsRValue:
LauFormulaPar LauParameter

Public Member Functions

 LauAbsRValue ()
 Constructor. More...
 
virtual ~LauAbsRValue ()
 Destructor. More...
 
 LauAbsRValue (const LauAbsRValue &)
 Copy constructor. More...
 
LauAbsRValueoperator= (const LauAbsRValue &)
 Copy assignment operator. More...
 
virtual const TString & name () const =0
 Return the name of the parameter. More...
 
virtual void name (const TString &newName)=0
 Set the parameter name. More...
 
virtual Double_t value () const =0
 Return the value of the parameter. More...
 
virtual Double_t unblindValue () const =0
 The unblinded value of the parameter. More...
 
virtual Double_t genValue () const =0
 The value generated for the parameter. More...
 
virtual Double_t initValue () const =0
 The initial value of the parameter. More...
 
virtual Bool_t gaussConstraint () const =0
 Check whether a Gaussian constraints is applied. More...
 
virtual Double_t constraintMean () const =0
 The mean of the Gaussian constraint. More...
 
virtual Double_t constraintWidth () const =0
 The width of the Gaussian constraint. More...
 
virtual std::vector
< LauParameter * > 
getPars ()=0
 Return the list of LauParameters on which the LauAbsRValue depends. More...
 
virtual Bool_t isLValue () const =0
 Is the parameter also an L value or not. More...
 
virtual Bool_t fixed () const =0
 Check is the parameter is fixed or floated. More...
 
virtual Bool_t blind () const =0
 The blinding state. More...
 

Detailed Description

Pure abstract base class for defining a parameter containing an R value.

Pure abstract base class for defining a parameter containing an R value, either a LauParameter or a LauFormulaPar

Definition at line 43 of file LauAbsRValue.hh.

Constructor & Destructor Documentation

LauAbsRValue::LauAbsRValue ( )
inline

Constructor.

Definition at line 47 of file LauAbsRValue.hh.

virtual LauAbsRValue::~LauAbsRValue ( )
inlinevirtual

Destructor.

Definition at line 50 of file LauAbsRValue.hh.

LauAbsRValue::LauAbsRValue ( const LauAbsRValue )
inline

Copy constructor.

Definition at line 53 of file LauAbsRValue.hh.

Member Function Documentation

virtual Bool_t LauAbsRValue::blind ( ) const
pure virtual

The blinding state.

Returns
the blinding state: kTRUE means that it is blinded, kFALSE that it is not blinded

Implemented in LauParameter, and LauFormulaPar.

virtual Double_t LauAbsRValue::constraintMean ( ) const
pure virtual

The mean of the Gaussian constraint.

Returns
the mean value of the Gaussian constraint

Implemented in LauParameter, and LauFormulaPar.

virtual Double_t LauAbsRValue::constraintWidth ( ) const
pure virtual

The width of the Gaussian constraint.

Returns
the width of the Gaussian constraint

Implemented in LauParameter, and LauFormulaPar.

virtual Bool_t LauAbsRValue::fixed ( ) const
pure virtual

Check is the parameter is fixed or floated.

Returns
the boolean flag whether the parameter is fixed

Implemented in LauParameter, and LauFormulaPar.

virtual Bool_t LauAbsRValue::gaussConstraint ( ) const
pure virtual

Check whether a Gaussian constraints is applied.

Returns
the boolean flag true/false whether a Gaussian constraint is applied

Implemented in LauParameter, and LauFormulaPar.

virtual Double_t LauAbsRValue::genValue ( ) const
pure virtual

The value generated for the parameter.

Returns
the value generated for the parameter

Implemented in LauParameter, and LauFormulaPar.

virtual std::vector<LauParameter*> LauAbsRValue::getPars ( )
pure virtual

Return the list of LauParameters on which the LauAbsRValue depends.

Returns
the list of LauParameters

Implemented in LauParameter, and LauFormulaPar.

virtual Double_t LauAbsRValue::initValue ( ) const
pure virtual

The initial value of the parameter.

Returns
the initial value of the parameter given to the fitter

Implemented in LauParameter, and LauFormulaPar.

virtual Bool_t LauAbsRValue::isLValue ( ) const
pure virtual

Is the parameter also an L value or not.

Returns
whether the parameter is also an L value

Implemented in LauParameter, and LauFormulaPar.

virtual const TString& LauAbsRValue::name ( ) const
pure virtual

Return the name of the parameter.

Returns
the name of the parameter

Implemented in LauParameter, and LauFormulaPar.

virtual void LauAbsRValue::name ( const TString &  newName)
pure virtual

Set the parameter name.

Parameters
[in]newNamethe name of the parameter

Implemented in LauParameter, and LauFormulaPar.

LauAbsRValue& LauAbsRValue::operator= ( const LauAbsRValue )
inline

Copy assignment operator.

Definition at line 56 of file LauAbsRValue.hh.

virtual Double_t LauAbsRValue::unblindValue ( ) const
pure virtual

The unblinded value of the parameter.

Returns
the unblinded value of the parameter

Implemented in LauParameter, and LauFormulaPar.

virtual Double_t LauAbsRValue::value ( ) const
pure virtual

Return the value of the parameter.

Returns
the value of the parameter

Implemented in LauParameter, and LauFormulaPar.


The documentation for this class was generated from the following file: