Interface for classes that can store arbitrary meta information (Type-Name-Value tuples). More...
#include <OpenMS/METADATA/MetaInfoInterface.h>
Public Member Functions | |
| MetaInfoInterface () | |
| constructor | |
| MetaInfoInterface (const MetaInfoInterface &rhs) | |
| copy constructor | |
| ~MetaInfoInterface () | |
| destructor | |
| MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) |
| assignment operator | |
| bool | operator== (const MetaInfoInterface &rhs) const |
| Equality operator. | |
| bool | operator!= (const MetaInfoInterface &rhs) const |
| Equality operator. | |
| const DataValue & | getMetaValue (const String &name) const |
| returns the value corresponding to a string | |
| const DataValue & | getMetaValue (UInt index) const |
| returns the value corresponding to an index | |
| bool | metaValueExists (const String &name) const |
| returns if this MetaInfo is set | |
| bool | metaValueExists (UInt index) const |
| returns if this MetaInfo is set | |
| void | setMetaValue (const String &name, const DataValue &value) |
| sets the DataValue corresponding to a name | |
| void | setMetaValue (UInt index, const DataValue &value) |
| sets the DataValue corresponding to an index | |
| 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 | getKeys (std::vector< String > &keys) const |
| fills the given vector with a list of all keys for which a value is set | |
| void | getKeys (std::vector< UInt > &keys) const |
| fills the given vector with a list of all keys for which a value is set | |
| bool | isMetaEmpty () const |
| returns if the MetaInfo is empty | |
| void | clearMetaInfo () |
| removes all meta values | |
Static Public Member Functions | |
| static MetaInfoRegistry & | metaRegistry () |
| retuns a reference to the MetaInfoRegistry | |
Protected Member Functions | |
| void | createIfNotExists_ () |
| creates the MetaInfo object if it does not exist | |
Protected Attributes | |
| MetaInfo * | meta_ |
| pointer to the MetaInfo object. 0 by default | |
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 publically inherit the MetaInfoInterface. Meta information is an array of Type-Name-Value tupels.
Constructor & Destructor Documentation
constructor
| MetaInfoInterface | ( | const MetaInfoInterface & | rhs | ) |
copy constructor
| ~MetaInfoInterface | ( | ) |
destructor
Member Function Documentation
| void clearMetaInfo | ( | ) |
removes all meta values
| void createIfNotExists_ | ( | ) | [inline, protected] |
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_(), MzMLHandler< MapType >::writeUserParam_(), and MzDataHandler< 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(), DataFilters::metaPasses_(), PrecursorIonSelection::SeqTotalScoreMore::operator()(), PrecursorIonSelection::TotalScoreMore::operator()(), MRMTransitionGroupPicker::pickTransitionGroup(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), MzXMLHandler< MapType >::writeTo(), MzXMLHandler< MapType >::writeUserParam_(), MzMLHandler< MapType >::writeUserParam_(), and MzDataHandler< MapType >::writeUserParam_().
| bool isMetaEmpty | ( | ) | const |
returns if the MetaInfo is empty
Referenced by MzDataHandler< MapType >::writeTo().
| static MetaInfoRegistry& metaRegistry | ( | ) | [static] |
retuns 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 operator!= | ( | const MetaInfoInterface & | rhs | ) | const |
Equality operator.
| MetaInfoInterface& operator= | ( | const MetaInfoInterface & | rhs | ) |
assignment operator
Reimplemented in ProteinHit.
Referenced by RichPeak2D::operator=(), and RichPeak1D::operator=().
| bool operator== | ( | const MetaInfoInterface & | rhs | ) | const |
Equality operator.
Referenced by RichPeak2D::operator==(), and RichPeak1D::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 >::fillChromatogramData_(), MzMLHandler< MapType >::fillData_(), ModelFitter< PeakType, FeatureType >::fit(), MzMLHandler< MapType >::handleCVParam_(), MzMLHandler< MapType >::handleUserParam_(), XMassFile::load(), SpecArrayFile::load(), MsInspectFile::load(), KroenikFile::load(), IDEvaluationBase::loadCurve(), TOPPRNPxl::main_(), OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), ChromatogramExtractor::prepareSpectra_(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), MzMLHandler< MapType >::startElement(), and MzDataHandler< MapType >::startElement().
sets the DataValue corresponding to an index
Member Data Documentation
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |