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 (or DataValue::EMPTY if not found) More... | |
| const DataValue & | getMetaValue (UInt index) const |
| Returns the value corresponding to an index (or 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 | 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... | |
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
◆ MetaInfoInterface() [1/2]
Constructor.
◆ MetaInfoInterface() [2/2]
| MetaInfoInterface | ( | const MetaInfoInterface & | rhs | ) |
Copy constructor.
◆ ~MetaInfoInterface()
| ~MetaInfoInterface | ( | ) |
Destructor.
Member Function Documentation
◆ clearMetaInfo()
| void clearMetaInfo | ( | ) |
Removes all meta values.
◆ createIfNotExists_()
|
inlineprotected |
Creates the MetaInfo object if it does not exist.
◆ getKeys() [1/2]
| void getKeys | ( | std::vector< String > & | keys | ) | const |
Fills the given vector with a list of all keys for which a value is set.
◆ getKeys() [2/2]
| void getKeys | ( | std::vector< UInt > & | keys | ) | const |
Fills the given vector with a list of all keys for which a value is set.
◆ getMetaValue() [1/2]
Returns the value corresponding to a string (or DataValue::EMPTY if not found)
Referenced by IDEvaluationBase::addSearchFile(), DataFilters::metaPasses_(), PrecursorIonSelection::TotalScoreMore::operator()(), PrecursorIonSelection::SeqTotalScoreMore::operator()(), and MRMTransitionGroupPicker::pickTransitionGroup().
◆ getMetaValue() [2/2]
Returns the value corresponding to an index (or DataValue::EMPTY if not found)
◆ isMetaEmpty()
| bool isMetaEmpty | ( | ) | const |
Returns if the MetaInfo is empty.
◆ metaRegistry()
|
static |
Returns a reference to the MetaInfoRegistry.
◆ metaValueExists() [1/2]
| bool metaValueExists | ( | const String & | name | ) | const |
Returns whether an entry with the given name exists.
Referenced by MascotGenericFile::getNextSpectrum_(), and DataFilters::metaPasses_().
◆ metaValueExists() [2/2]
| bool metaValueExists | ( | UInt | index | ) | const |
Returns whether an entry with the given index exists.
◆ operator!=()
| bool operator!= | ( | const MetaInfoInterface & | rhs | ) | const |
Equality operator.
◆ operator=()
| MetaInfoInterface& operator= | ( | const MetaInfoInterface & | rhs | ) |
Assignment operator.
Referenced by RichPeak2D::operator=().
◆ operator==()
| bool operator== | ( | const MetaInfoInterface & | rhs | ) | const |
Equality operator.
Referenced by RichPeak2D::operator==().
◆ removeMetaValue() [1/2]
| void removeMetaValue | ( | const String & | name | ) |
Removes the DataValue corresponding to name if it exists.
Referenced by MascotGenericFile::getNextSpectrum_().
◆ removeMetaValue() [2/2]
◆ setMetaValue() [1/2]
Sets the DataValue corresponding to a name.
Referenced by MRMTransitionGroupPicker::createMRMFeature(), MascotGenericFile::getNextSpectrum_(), MsInspectFile::load(), SpecArrayFile::load(), MascotInfile::load(), XMassFile::load(), IDEvaluationBase::loadCurve(), TOPPRNPxl::main_(), TOPPOpenPepXLLF::main_(), TOPPOpenPepXL::main_(), TOPPMetaProSIP::main_(), RNPxlSearch::postProcessHits_(), ChromatogramExtractor::prepareSpectra_(), ChromatogramExtractor::return_chromatogram(), and MRMTransitionGroup< SpectrumT, TransitionT >::subset().
◆ setMetaValue() [2/2]
Sets the DataValue corresponding to an index.