Digestion Class Reference

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

#include <OpenMS/METADATA/Digestion.h>

Inheritance diagram for Digestion:

Collaboration diagram for Digestion:

Public Member Functions
	Digestion ()
	Default constructor. More...
	Digestion (const Digestion &)=default
	Copy constructor. More...
	Digestion (Digestion &&)=default
	Move constructor. More...
	~Digestion () override
	Destructor. More...
Digestion &	operator= (const Digestion &)=default
	Assignment operator. More...
Digestion &	operator= (Digestion &&) &=default
	Move assignment operator. More...
bool	operator== (const SampleTreatment &rhs) const override
	Equality operator. More...
SampleTreatment *	clone () const override
	clone method. See SampleTreatment More...
const String &	getEnzyme () 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...
SampleTreatment &	operator= (const SampleTreatment &)=default
	Assignment operator. More...
SampleTreatment &	operator= (SampleTreatment &&) &=default
	Move assignment operator. More...
const String &	getType () const
	return the treatment type More...
const String &	getComment () 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...
MetaInfoInterface &	operator= (const MetaInfoInterface &rhs)
	Assignment operator. More...
MetaInfoInterface &	operator= (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 DataValue &	getMetaValue (const String &name, const DataValue &default_value=DataValue::EMPTY) const
	Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
const DataValue &	getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
	Returns the value corresponding to an index, or a default value (default: 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
MetaInfo *	meta_
	Pointer to the MetaInfo object (0 by default) More...

Additional Inherited Members
Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry &	metaRegistry ()
	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