OpenMS
SampleTreatment Class Referenceabstract

Base class for sample treatments (Digestion, Modification, Tagging, ...) More...

#include <OpenMS/METADATA/SampleTreatment.h>

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

Public Member Functions

 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...
 
virtual bool operator== (const SampleTreatment &rhs) const
 
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...
 
virtual SampleTreatmentclone () const =0
 A clone method. 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 type_
 
String comment_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 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 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

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.

Constructor & Destructor Documentation

◆ SampleTreatment() [1/4]

SampleTreatment ( const String type)
explicit

Constructor.

Use a unique type string for each treatment type

◆ SampleTreatment() [2/4]

SampleTreatment ( const SampleTreatment )
default

Copy constructor.

Note
Do not forget to call it when you derive a class from SampleTreatment!

◆ SampleTreatment() [3/4]

SampleTreatment ( SampleTreatment &&  )
default

Move constructor.

◆ ~SampleTreatment()

virtual ~SampleTreatment ( )
virtual

Destructor.

◆ SampleTreatment() [4/4]

SampleTreatment ( )
private

Default constructor hidden to force setting of a type.

Member Function Documentation

◆ clone()

virtual SampleTreatment* clone ( ) const
pure virtual

A clone method.

clone method that creates a copy and returns a pointer (base class pointer). Used to copy sample treatments when only a pointer to this base class is available.

Implemented in Tagging, Modification, and Digestion.

◆ getComment()

const String& getComment ( ) const

returns the description of the sample treatment

◆ getType()

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.

◆ operator=() [1/2]

SampleTreatment& operator= ( const SampleTreatment )
default

Assignment operator.

Note
Do not forget to call it when you derive a class from SampleTreatment!

◆ operator=() [2/2]

SampleTreatment& operator= ( SampleTreatment &&  ) &
default

Move assignment operator.

◆ operator==()

virtual bool operator== ( const SampleTreatment rhs) const
virtual
@brief 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.
Note
Do not forget to call it when you derive a class from SampleTreatment!

Reimplemented in Tagging, Modification, and Digestion.

◆ setComment()

void setComment ( const String comment)

sets the description of the sample treatment

Member Data Documentation

◆ comment_

String comment_
protected

◆ type_

String type_
protected