OpenMS
Digestion Class Reference

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

#include <OpenMS/METADATA/Digestion.h>

Inheritance diagram for Digestion:
[legend]
Collaboration diagram for Digestion:
[legend]

Public Member Functions

 Digestion ()
 Default constructor. More...
 
 Digestion (const Digestion &)=default
 Copy constructor. More...
 
 Digestion (Digestion &&)=default
 Move constructor. More...
 
 ~Digestion () override
 Destructor. More...
 
Digestionoperator= (const Digestion &)=default
 Assignment operator. More...
 
Digestionoperator= (Digestion &&) &=default
 Move assignment operator. More...
 
bool operator== (const SampleTreatment &rhs) const override
 Equality operator. More...
 
SampleTreatmentclone () const override
 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 &)=default
 Copy constructor. More...
 
 SampleTreatment (SampleTreatment &&)=default
 Move constructor. More...
 
virtual ~SampleTreatment ()
 Destructor. More...
 
SampleTreatmentoperator= (const SampleTreatment &)=default
 Assignment operator. More...
 
SampleTreatmentoperator= (SampleTreatment &&) &=default
 Move 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 (MetaInfoInterface &&) noexcept
 Move constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
void swap (MetaInfoInterface &rhs)
 Swap contents. 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, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (const String &name, const DataValue &default_value) const
 Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found. More...
 
const DataValuegetMetaValue (UInt index) const
 Returns the value corresponding to the index, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (UInt index, const DataValue &default_value) const
 Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found. More...
 
bool metaValueExists (const String &name) const
 Returns whether an entry with the given name exists. More...
 
bool metaValueExists (UInt index) const
 Returns whether an entry with the given index exists. 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 addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one 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() [1/3]

Digestion ( )

Default constructor.

◆ Digestion() [2/3]

Digestion ( const Digestion )
default

Copy constructor.

◆ Digestion() [3/3]

Digestion ( Digestion &&  )
default

Move constructor.

◆ ~Digestion()

~Digestion ( )
override

Destructor.

Member Function Documentation

◆ clone()

SampleTreatment* clone ( ) const
overridevirtual

clone method. See SampleTreatment

Implements SampleTreatment.

◆ getDigestionTime()

double getDigestionTime ( ) const

returns the digestion time in minutes (default is 0.0)

◆ getEnzyme()

const String& getEnzyme ( ) const

returns the enzyme name (default is "")

◆ getPh()

double getPh ( ) const

returns the pH value (default is 0.0)

◆ getTemperature()

double getTemperature ( ) const

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

◆ operator=() [1/2]

Digestion& operator= ( const Digestion )
default

Assignment operator.

◆ operator=() [2/2]

Digestion& operator= ( Digestion &&  ) &
default

Move assignment operator.

◆ operator==()

bool operator== ( const SampleTreatment rhs) const
overridevirtual

Equality operator.

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

Reimplemented from SampleTreatment.

◆ setDigestionTime()

void setDigestionTime ( double  digestion_time)

sets the digestion time in minutes

◆ setEnzyme()

void setEnzyme ( const String enzyme)

sets the enzyme name

◆ setPh()

void setPh ( double  ph)

sets the pH value

◆ setTemperature()

void setTemperature ( double  temperature)

sets the temperature during digestion in degree C

Member Data Documentation

◆ digestion_time_

double digestion_time_
protected

◆ enzyme_

String enzyme_
protected

◆ ph_

double ph_
protected

◆ temperature_

double temperature_
protected