Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Attributes | List of all members
ModelDescription< D > Class Template Reference

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

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

Public Member Functions

 ModelDescription ()
 Default constructor. More...
 
 ModelDescription (const ModelDescription &source)
 copy constructor More...
 
 ModelDescription (const BaseModel< D > *model)
 constructor provided for convenience More...
 
virtual ~ModelDescription ()
 destructor More...
 
virtual ModelDescriptionoperator= (const ModelDescription &source)
 assignment operator More...
 
BaseModel< D > * createModel ()
 
const StringgetName () const
 Non-mutable access to model name. More...
 
StringgetName ()
 Mutable access to the model name. More...
 
void setName (const String &name)
 Set the model name. More...
 
const ParamgetParam () const
 Non-mutable access to model parameters. More...
 
ParamgetParam ()
 Mutable access to the model parameters. More...
 
void setParam (const Param &param)
 Set the model parameters. More...
 
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 ( )
inlinevirtual

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().

const String& getName ( ) const
inline

Non-mutable access to model name.

Accessors

String& getName ( )
inline

Mutable access to the model name.

const Param& getParam ( ) const
inline
Param& getParam ( )
inline

Mutable access to the model parameters.

virtual bool operator!= ( const ModelDescription< D > &  rhs) const
inlinevirtual
virtual ModelDescription& operator= ( const ModelDescription< D > &  source)
inlinevirtual

assignment operator

virtual bool operator== ( const ModelDescription< D > &  rhs) const
inlinevirtual
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
Param parameters_
protected

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:34 using doxygen 1.8.5