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

Interface for classes that can store arbitrary meta information (Type-Name-Value tuples). More...

#include <OpenMS/METADATA/MetaInfoInterface.h>

Inheritance diagram for MetaInfoInterface:
Acquisition AcquisitionInfo ChromatogramSettings ConsensusMap ConsensusMap::FileDescription ContactPerson CVTermList DataProcessing ExperimentalSettings Identification IdentificationHit Instrument InstrumentSettings IonDetector IonSource MassAnalyzer MetaInfoDescription PeptideHit PeptideIdentification ProteinHit ProteinIdentification ProteinIdentification::SearchParameters RichPeak1D RichPeak2D Sample SampleTreatment ScanWindow SpectrumIdentification SpectrumSettings

Public Member Functions

 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...
 

Static Public Member Functions

static MetaInfoRegistrymetaRegistry ()
 returns a reference to the MetaInfoRegistry More...
 

Protected Member Functions

void createIfNotExists_ ()
 creates the MetaInfo object if it does not exist More...
 

Protected Attributes

MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

Detailed Description

Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).

MetaInfoInterface is a base class for all classes that use one MetaInfo object as member. If you want to add meta information to a class, let it publicly inherit the MetaInfoInterface. Meta information is an array of Type-Name-Value tuples.

Constructor & Destructor Documentation

constructor

copy constructor

destructor

Member Function Documentation

void clearMetaInfo ( )

removes all meta values

void createIfNotExists_ ( )
inlineprotected

creates the MetaInfo object if it does not exist

void getKeys ( std::vector< String > &  keys) const

fills the given vector with a list of all keys for which a value is set

Referenced by MzXMLHandler< MapType >::writeUserParam_(), MzDataHandler< MapType >::writeUserParam_(), and MzMLHandler< MapType >::writeUserParam_().

void getKeys ( std::vector< UInt > &  keys) const

fills the given vector with a list of all keys for which a value is set

const DataValue& getMetaValue ( const String name) const
const DataValue& getMetaValue ( UInt  index) const

returns the value corresponding to an index

bool isMetaEmpty ( ) const

returns if the MetaInfo is empty

Referenced by MzDataHandler< MapType >::writeTo().

static MetaInfoRegistry& metaRegistry ( )
static

returns a reference to the MetaInfoRegistry

bool metaValueExists ( const String name) const

returns if this MetaInfo is set

Referenced by DataFilters::metaPasses_(), and MzXMLHandler< MapType >::writeTo().

bool metaValueExists ( UInt  index) const

returns if this MetaInfo is set

bool operator!= ( const MetaInfoInterface rhs) const

Equality operator.

MetaInfoInterface& operator= ( const MetaInfoInterface rhs)

assignment operator

Referenced by RichPeak1D::operator=(), and RichPeak2D::operator=().

bool operator== ( const MetaInfoInterface rhs) const

Equality operator.

Referenced by RichPeak1D::operator==(), and RichPeak2D::operator==().

void removeMetaValue ( const String name)

Removes the DataValue corresponding to name if it exists.

void removeMetaValue ( UInt  index)

Removes the DataValue corresponding to index if it exists.

void setMetaValue ( const String name,
const DataValue value 
)
void setMetaValue ( UInt  index,
const DataValue value 
)

sets the DataValue corresponding to an index

Member Data Documentation

MetaInfo* meta_
protected

pointer to the MetaInfo object. 0 by default


OpenMS / TOPP release 2.0.0 Documentation generated on Fri May 29 2015 17:20:40 using doxygen 1.8.9.1