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

#include <OpenMS/METADATA/MetaInfoInterface.h>

Inheritance diagram for MetaInfoInterface:

Collaboration diagram for MetaInfoInterface:

Public Member Functions
	MetaInfoInterface ()=default
	Constructor.

	MetaInfoInterface (const MetaInfoInterface &rhs)
	Copy constructor.

	MetaInfoInterface (MetaInfoInterface &&) noexcept
	Move constructor.

	~MetaInfoInterface ()
	Destructor.

MetaInfoInterface &	operator= (const MetaInfoInterface &rhs)
	Assignment operator.

MetaInfoInterface &	operator= (MetaInfoInterface &&) noexcept
	Move assignment operator.

void	swap (MetaInfoInterface &rhs)
	Swap contents.

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, or DataValue::EMPTY if not found.

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

const DataValue &	getMetaValue (UInt index) const
	Returns the value corresponding to the index, or DataValue::EMPTY if not found.

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

bool	metaValueExists (const String &name) const
	Returns whether an entry with the given name exists.

bool	metaValueExists (UInt index) const
	Returns whether an entry with the given index exists.

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	addMetaValues (const MetaInfoInterface &from)

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 ()
	Returns a reference to the MetaInfoRegistry.

Protected Member Functions
void	createIfNotExists_ ()
	Creates the MetaInfo object if it does not exist.

Protected Attributes
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

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/3]

MetaInfoInterface ( )

default

Constructor.

◆ MetaInfoInterface() [2/3]

MetaInfoInterface ( const MetaInfoInterface & rhs )

Copy constructor.

◆ MetaInfoInterface() [3/3]

MetaInfoInterface ( MetaInfoInterface && )

noexcept

Move constructor.

◆ ~MetaInfoInterface()

~MetaInfoInterface ( )

Destructor.

Member Function Documentation

◆ addMetaValues()

void addMetaValues ( const MetaInfoInterface & from )

Copy all meta values from from to this object (both named String and indexed UInt keys). Existing entries with the same key are overwritten; others are preserved.

Referenced by Observation::merge(), and ScoredProcessingResult::merge().

◆ clearMetaInfo()

void clearMetaInfo ( )

Removes all meta values.

◆ createIfNotExists_()

void 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/4]

const DataValue & getMetaValue ( const String & name ) const

Returns the value corresponding to a string, or DataValue::EMPTY if not found.

Referenced by NuXLLinearRescore::apply(), NuXLRTPrediction::buildPredictorsAndResponse_(), NuXLRTPrediction::buildPredictorsAndResponseFromIdentifiedFeatures_(), LayerDataPeak::chromatogram_flag_set(), FullSwathFileConsumer::consumeSpectrum(), IdentificationDataConverter::exportObservationMatchToMzTab_(), XFDRAlgorithm::getMinIonsMatched_(), MascotGenericFile::getNextSpectrum_(), ProteinIdentification::Mapping::getPrimaryMSRunPath(), IDScoreGetterSetter::getTDLabel_(), LayerDataPeak::isDIAData(), LayerDataPeak::isIonMobilityData(), FeatureFinderAlgorithmMetaboIdent::FeatureCompare::operator()(), FeatureFinderIdentificationAlgorithm::FeatureCompare::operator()(), IDBoostGraph::GetScoreTgTVisitor::operator()(), IDBoostGraph::GetScoreTgTVisitor::operator()(), MRMTransitionGroupPicker::pickTransitionGroup(), and IDScoreGetterSetter::setScoreAndMoveIfTarget_().

◆ getMetaValue() [2/4]

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

◆ getMetaValue() [3/4]

const DataValue & getMetaValue ( UInt index ) const

Returns the value corresponding to the index, or DataValue::EMPTY if not found.

◆ getMetaValue() [4/4]

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

◆ isMetaEmpty()

bool isMetaEmpty ( ) const

Returns if the MetaInfo is empty.

◆ metaRegistry()

static MetaInfoRegistry & 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 IDScoreGetterSetter::checkTDAnnotation_(), LayerDataPeak::chromatogram_flag_set(), FullSwathFileConsumer::consumeSpectrum(), IdentificationDataConverter::exportObservationMatchToMzTab_(), MascotGenericFile::getNextSpectrum_(), LayerDataPeak::isDIAData(), LayerDataPeak::isIonMobilityData(), and FeatureFinderAlgorithmMetaboIdent::FeatureFilterQuality::operator()().

◆ 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=() [1/2]

MetaInfoInterface & operator= ( const MetaInfoInterface & rhs )

Assignment operator.

◆ operator=() [2/2]

MetaInfoInterface & operator= ( MetaInfoInterface && )

noexcept

Move assignment operator.

◆ operator==()

bool operator== ( const MetaInfoInterface & rhs ) const

Equality 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]

void removeMetaValue ( UInt index )

Removes the DataValue corresponding to index if it exists.

◆ setMetaValue() [1/2]

void setMetaValue	(	const String &	name,
		const DataValue &	value
	)

Sets the DataValue corresponding to a name.

Referenced by NuXLRTPrediction::annotatePredictions_(), MRMTransitionGroupPicker::createMRMFeature(), MascotGenericFile::getNextSpectrum_(), MsInspectFile::load(), SpecArrayFile::load(), XMassFile::load(), MRMTransitionGroupPicker::pickFragmentChromatograms(), MRMTransitionGroupPicker::pickPrecursorChromatograms(), NucleicAcidSearchEngine::postProcessHits_(), ChromatogramExtractor::prepareSpectra_(), ChromatogramExtractor::return_chromatogram(), XFDRAlgorithm::setInterProtein_(), XFDRAlgorithm::setIntraProtein_(), and IDScoreGetterSetter::setScoreAndMoveIfTarget_().

◆ setMetaValue() [2/2]

void setMetaValue	(	UInt	index,
		const DataValue &	value
	)

Sets the DataValue corresponding to an index.

◆ swap()

void swap ( MetaInfoInterface & rhs )

Swap contents.

Referenced by LinearResampler::raster().

Member Data Documentation

◆ meta_

MetaInfo* meta_ = nullptr

protected

Pointer to the MetaInfo object.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes