Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Attributes | List of all members
Digestion Class Reference

Meta information about digestion of a sample. More...

#include <OpenMS/METADATA/Digestion.h>

Inheritance diagram for Digestion:
SampleTreatment MetaInfoInterface

Public Member Functions

 Digestion ()
 default constructor More...
 
 Digestion (const Digestion &)
 copy constructor More...
 
virtual ~Digestion ()
 destructor More...
 
Digestionoperator= (const Digestion &)
 assignment operator More...
 
virtual bool operator== (const SampleTreatment &rhs) const
 Equality operator. More...
 
virtual SampleTreatmentclone () const
 clone method. See SampleTreatment More...
 
const StringgetEnzyme () const
 returns the enzyme name (default is "") More...
 
void setEnzyme (const String &enzyme)
 sets the enzyme name More...
 
double getDigestionTime () const
 returns the digestion time in minutes (default is 0.0) More...
 
void setDigestionTime (double digestion_time)
 sets the digestion time in minutes More...
 
double getTemperature () const
 return the temperature during digestion in degree C (default is 0.0) More...
 
void setTemperature (double temperature)
 sets the temperature during digestion in degree C More...
 
double getPh () const
 returns the pH value (default is 0.0) More...
 
void setPh (double ph)
 sets the pH value More...
 
- Public Member Functions inherited from SampleTreatment
 SampleTreatment (const String &type)
 Constructor. More...
 
 SampleTreatment (const SampleTreatment &)
 Copy constructor. More...
 
virtual ~SampleTreatment ()
 destructor More...
 
SampleTreatmentoperator= (const SampleTreatment &)
 Assignment operator. More...
 
const StringgetType () const
 return the treatment type More...
 
const StringgetComment () const
 returns the description of the sample treatment More...
 
void setComment (const String &comment)
 sets the description of the sample treatment More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 constructor More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 copy constructor More...
 
 ~MetaInfoInterface ()
 destructor More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 assignment operator More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 returns the value corresponding to a string More...
 
const DataValuegetMetaValue (UInt index) const
 returns the value corresponding to an index More...
 
bool metaValueExists (const String &name) const
 returns if this MetaInfo is set More...
 
bool metaValueExists (UInt index) const
 returns if this MetaInfo is set More...
 
void setMetaValue (const String &name, const DataValue &value)
 sets the DataValue corresponding to a name More...
 
void setMetaValue (UInt index, const DataValue &value)
 sets the DataValue corresponding to an index More...
 
void removeMetaValue (const String &name)
 Removes the DataValue corresponding to name if it exists. More...
 
void removeMetaValue (UInt index)
 Removes the DataValue corresponding to index if it exists. More...
 
void getKeys (std::vector< String > &keys) const
 fills the given vector with a list of all keys for which a value is set More...
 
void getKeys (std::vector< UInt > &keys) const
 fills the given vector with a list of all keys for which a value is set More...
 
bool isMetaEmpty () const
 returns if the MetaInfo is empty More...
 
void clearMetaInfo ()
 removes all meta values More...
 

Protected Attributes

String enzyme_
 
double digestion_time_
 
double temperature_
 
double ph_
 
- Protected Attributes inherited from SampleTreatment
String type_
 
String comment_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 returns a reference to the MetaInfoRegistry More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 creates the MetaInfo object if it does not exist More...
 

Detailed Description

Meta information about digestion of a sample.

Representation of a digestion.

Constructor & Destructor Documentation

Digestion ( )

default constructor

Digestion ( const Digestion )

copy constructor

virtual ~Digestion ( )
virtual

destructor

Member Function Documentation

virtual SampleTreatment* clone ( ) const
virtual

clone method. See SampleTreatment

Implements SampleTreatment.

double getDigestionTime ( ) const

returns the digestion time in minutes (default is 0.0)

const String& getEnzyme ( ) const

returns the enzyme name (default is "")

double getPh ( ) const

returns the pH value (default is 0.0)

double getTemperature ( ) const

return the temperature during digestion in degree C (default is 0.0)

Digestion& operator= ( const Digestion )

assignment operator

virtual bool operator== ( const SampleTreatment rhs) const
virtual

Equality operator.

Although this operator takes a reference to a SampleTreatment as argument it tests for the equality of Tagging instances!

Reimplemented from SampleTreatment.

void setDigestionTime ( double  digestion_time)

sets the digestion time in minutes

void setEnzyme ( const String enzyme)

sets the enzyme name

void setPh ( double  ph)

sets the pH value

void setTemperature ( double  temperature)

sets the temperature during digestion in degree C

Member Data Documentation

double digestion_time_
protected
String enzyme_
protected
double ph_
protected
double temperature_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Tue Aug 25 2015 05:53:59 using doxygen 1.8.9.1