Base class for sample treatments (Digestion, Modification, Tagging, ...) More...
#include <OpenMS/METADATA/SampleTreatment.h>
Public Member Functions | |
| SampleTreatment (const String &type) | |
| Constructor. More... | |
| SampleTreatment (const SampleTreatment &) | |
| Copy constructor. More... | |
| virtual | ~SampleTreatment () |
| destructor More... | |
| SampleTreatment & | operator= (const SampleTreatment &) |
| Assignment operator. More... | |
| virtual bool | operator== (const SampleTreatment &rhs) const |
| Equality 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... | |
| virtual SampleTreatment * | clone () const =0 |
| A clone methode. More... | |
Public Member Functions inherited from MetaInfoInterface | |
| MetaInfoInterface () | |
| constructor More... | |
| MetaInfoInterface (const MetaInfoInterface &rhs) | |
| copy constructor More... | |
| ~MetaInfoInterface () | |
| destructor More... | |
| MetaInfoInterface & | operator= (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 DataValue & | getMetaValue (const String &name) const |
| returns the value corresponding to a string More... | |
| const DataValue & | getMetaValue (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 | type_ |
| String | comment_ |
Protected Attributes inherited from MetaInfoInterface | |
| MetaInfo * | meta_ |
| pointer to the MetaInfo object. 0 by default More... | |
Private Member Functions | |
| SampleTreatment () | |
| Default constructor hidden to force setting of a type. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from MetaInfoInterface | |
| static MetaInfoRegistry & | metaRegistry () |
| retuns a reference to the MetaInfoRegistry More... | |
Protected Member Functions inherited from MetaInfoInterface | |
| void | createIfNotExists_ () |
| creates the MetaInfo object if it does not exist More... | |
Base class for sample treatments (Digestion, Modification, Tagging, ...)
Virtual base class for all sample treatments.
The type of the treatment can be determined through the getType() method.
| SampleTreatment | ( | const String & | type | ) |
Constructor.
Use a unique type string for each treatment type
| SampleTreatment | ( | const SampleTreatment & | ) |
Copy constructor.
|
virtual |
destructor
|
private |
Default constructor hidden to force setting of a type.
|
pure virtual |
A clone methode.
clone method that creates a copy and retuns a pointer (base class pointer). Used to copy sample treatments when only a pointer to this base class is available.
Implemented in Modification, Tagging, and Digestion.
| const String& getComment | ( | ) | const |
returns the description of the sample treatment
| const String& getType | ( | ) | const |
return the treatment type
The type_ has to be set in the default constructor. It is used to determine the kind of sample treatment, when only a pointer to this base class is available.
| SampleTreatment& operator= | ( | const SampleTreatment & | ) |
Assignment operator.
|
virtual |
Equality operator.
The equality operators of derived classes also take a SampleTreatment reference as argument. They check the type and cast the reference to the right type if the type matches.
Reimplemented in Modification, Tagging, and Digestion.
| void setComment | ( | const String & | comment | ) |
sets the description of the sample treatment
|
protected |
|
protected |
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5 |