Interface for classes that can store arbitrary meta information (Type-Name-Value tuples). More...
#include <OpenMS/METADATA/MetaInfoInterface.h>
Public Member Functions | |
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... | |
Static Public Member Functions | |
static MetaInfoRegistry & | metaRegistry () |
returns a reference to the MetaInfoRegistry More... | |
Protected Member Functions | |
void | createIfNotExists_ () |
creates the MetaInfo object if it does not exist More... | |
Protected Attributes | |
MetaInfo * | meta_ |
pointer to the MetaInfo object. 0 by default More... | |
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
MetaInfoInterface | ( | const MetaInfoInterface & | rhs | ) |
copy constructor
~MetaInfoInterface | ( | ) |
destructor
void clearMetaInfo | ( | ) |
removes all meta values
|
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
returns the value corresponding to a string
Referenced by IDEvaluationBase::addSearchFile(), MzMLHandler< MapType >::endElement(), DataFilters::metaPasses_(), PrecursorIonSelection::TotalScoreMore::operator()(), PrecursorIonSelection::SeqTotalScoreMore::operator()(), MRMTransitionGroupPicker::pickTransitionGroup(), MzXMLHandler< MapType >::writeTo(), MzXMLHandler< MapType >::writeUserParam_(), MzDataHandler< MapType >::writeUserParam_(), and MzMLHandler< MapType >::writeUserParam_().
bool isMetaEmpty | ( | ) | const |
returns if the MetaInfo is empty
Referenced by MzDataHandler< MapType >::writeTo().
|
static |
returns a reference to the MetaInfoRegistry
returns if this MetaInfo is set
Referenced by MzMLHandler< MapType >::endElement(), DataFilters::metaPasses_(), and MzXMLHandler< MapType >::writeTo().
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.
sets the DataValue corresponding to a name
Referenced by MzDataHandler< MapType >::characters(), MRMTransitionGroupPicker::createMRMFeature(), MzMLHandler< MapType >::handleCVParam_(), MzMLHandler< MapType >::handleUserParam_(), SpecArrayFile::load(), MsInspectFile::load(), MascotInfile::load(), XMassFile::load(), IDEvaluationBase::loadCurve(), TOPPRNPxl::main_(), OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), MzMLHandler< MSExperiment<> >::populateChromatogramsWithData_(), MzMLHandler< MSExperiment<> >::populateSpectraWithData_(), ChromatogramExtractor::prepareSpectra_(), ChromatogramExtractor::return_chromatogram(), MzDataHandler< MapType >::startElement(), and MzMLHandler< MapType >::startElement().
sets the DataValue corresponding to an index
OpenMS / TOPP release 2.0.0 | Documentation generated on Wed Mar 30 2016 12:49:28 using doxygen 1.8.11 |