ModelDescription< D > Class Template Reference

Stores the name and parameters of a model. More...

#include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/ModelDescription.h>

List of all members.

Public Member Functions
	ModelDescription ()
	Default constructor.
	ModelDescription (const ModelDescription &source)
	copy constructor
	ModelDescription (const BaseModel< D > *model)
	constructor provided for convenience
virtual	~ModelDescription ()
	destructor
virtual ModelDescription &	operator= (const ModelDescription &source)
	assignment operator
BaseModel< D > *	createModel ()
const String &	getName () const
	Non-mutable access to model name.
String &	getName ()
	Mutable access to the model name.
void	setName (const String &name)
	Set the model name.
const Param &	getParam () const
	Non-mutable access to model parameters.
Param &	getParam ()
	Mutable access to the model parameters.
void	setParam (const Param &param)
	Set the model parameters.
Predicates
virtual bool	operator== (const ModelDescription &rhs) const
virtual bool	operator!= (const ModelDescription &rhs) const
Protected Attributes
String	name_
Param	parameters_

---

Detailed Description

template<UInt D>
class OpenMS::ModelDescription< D >

Stores the name and parameters of a model.

This class also allows reconstruction of the model.

See also:

BaseModel

---

Constructor & Destructor Documentation

ModelDescription

(

)

[inline]

Default constructor.

ModelDescription

(

const ModelDescription< D > &

source

)

[inline]

copy constructor

ModelDescription

(

const BaseModel< D > *

model

)

[inline]

constructor provided for convenience

virtual ~ModelDescription

(

)

[inline, virtual]

destructor

---

Member Function Documentation

BaseModel<D>* createModel

(

)

[inline]

creates model from the parameters defined in this class returns 0 if no description is set.

Referenced by ModelFitter< PeakType, FeatureType >::fit(), ProductModel< 2 >::operator=(), and ProductModel< 2 >::ProductModel().

String& getName

(

)

[inline]

Mutable access to the model name.

const String& getName

(

)

const [inline]

Non-mutable access to model name.

Accessors

const Param& getParam

(

)

const [inline]

Non-mutable access to model parameters.

Referenced by FeatureFinderAlgorithmSimplest< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmSimple< PeakType, FeatureType >::run().

Param& getParam

(

)

[inline]

Mutable access to the model parameters.

virtual bool operator!=

(

const ModelDescription< D > &

rhs

)

const [inline, virtual]

virtual ModelDescription& operator=

(

const ModelDescription< D > &

source

)

[inline, virtual]

assignment operator

virtual bool operator==

(

const ModelDescription< D > &

rhs

)

const [inline, virtual]

Referenced by ModelDescription< 2 >::operator!=().

void setName

(

const String &

name

)

[inline]

Set the model name.

void setParam

(

const Param &

param

)

[inline]

Set the model parameters.

---

Member Data Documentation

String name_ [protected]

Referenced by ModelDescription< 2 >::createModel(), ModelDescription< 2 >::getName(), ModelDescription< 2 >::operator=(), ModelDescription< 2 >::operator==(), and ModelDescription< 2 >::setName().

Param parameters_ [protected]

Referenced by ModelDescription< 2 >::createModel(), ModelDescription< 2 >::getParam(), ModelDescription< 2 >::operator=(), ModelDescription< 2 >::operator==(), and ModelDescription< 2 >::setParam().