Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

ModelDescription Class Template Reference
[FeatureFinder]

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

List of all members.


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

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 ModelDescriptionoperator= (const ModelDescription &source)
 assignment operator
BaseModel< D > * createModel ()
const StringgetName () const
 Non-mutable access to model name.
StringgetName ()
 Mutable access to the model name.
void setName (const String &name)
 Set the model name.
const ParamgetParam () const
 Non-mutable access to model parameters.
ParamgetParam ()
 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_

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

virtual ModelDescription& operator= ( const ModelDescription< D > &  source  )  [inline, virtual]

assignment operator

BaseModel<D>* createModel (  )  [inline]

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

const String& getName (  )  const [inline]

Non-mutable access to model name.

Accessors

String& getName (  )  [inline]

Mutable access to the model name.

void setName ( const String name  )  [inline]

Set the model name.

const Param& getParam (  )  const [inline]

Non-mutable access to model parameters.

Param& getParam (  )  [inline]

Mutable access to the model parameters.

void setParam ( const Param param  )  [inline]

Set the model parameters.

virtual bool operator== ( const ModelDescription< D > &  rhs  )  const [inline, virtual]

virtual bool operator!= ( const ModelDescription< D > &  rhs  )  const [inline, virtual]


Member Data Documentation

String name_ [protected]

Param parameters_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:47 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1