SpectrumIdentification Class Reference

#include <OpenMS/FORMAT/HANDLERS/MzIdentMLHandler.h>

Inheritance diagram for SpectrumIdentification:

Collaboration diagram for SpectrumIdentification:

constructors,destructors,assignment operator
String	id_
	Identifier.
std::vector< IdentificationHit >	hits_
	Single peptide hits.
	SpectrumIdentification ()=default
	Default constructor.
virtual	~SpectrumIdentification ()
	Destructor.
	SpectrumIdentification (const SpectrumIdentification &)=default
	Copy constructor.
	SpectrumIdentification (SpectrumIdentification &&)=default
	Move constructor.
SpectrumIdentification &	operator= (const SpectrumIdentification &)=default
	Assignment operator.
SpectrumIdentification &	operator= (SpectrumIdentification &&) &=default
	Move assignment operator.
bool	operator== (const SpectrumIdentification &rhs) const
	Equality operator.
bool	operator!= (const SpectrumIdentification &rhs) const
	Inequality operator.
void	setHits (const std::vector< IdentificationHit > &hits)
	sets the identification hits of this spectrum identification (corresponds to single peptide hit in the list)
void	addHit (const IdentificationHit &hit)
	adds a single identification hit to the hits
const std::vector< IdentificationHit > &	getHits () const
	returns the identification hits of this spectrum identification

Additional Inherited Members
Public Member Functions inherited from MetaInfoInterface
	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 inherited from MetaInfoInterface
static MetaInfoRegistry &	metaRegistry ()
	Returns a reference to the MetaInfoRegistry.
Protected Member Functions inherited from MetaInfoInterface
void	createIfNotExists_ ()
	Creates the MetaInfo object if it does not exist.
Protected Attributes inherited from MetaInfoInterface
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

Detailed Description

@brief Represents a object which can store the information of an analysisXML instance

Todo:

docu (Andreas)

    @ingroup Metadata

Constructor & Destructor Documentation

SpectrumIdentification() [1/3]

SpectrumIdentification ( )

default

Default constructor.

~SpectrumIdentification()

virtual ~SpectrumIdentification ( )

virtual

Destructor.

SpectrumIdentification() [2/3]

SpectrumIdentification ( const SpectrumIdentification &  )

default

Copy constructor.

SpectrumIdentification() [3/3]

SpectrumIdentification ( SpectrumIdentification &&  )

default

Move constructor.

Member Function Documentation

addHit()

void addHit

(

const IdentificationHit &

hit

)

adds a single identification hit to the hits

getHits()

const std::vector< IdentificationHit > & getHits

(

)

const

returns the identification hits of this spectrum identification

operator!=()

bool operator!=

(

const SpectrumIdentification &

rhs

)

const

Inequality operator.

operator=() [1/2]

SpectrumIdentification & operator= ( const SpectrumIdentification &  )

default

Assignment operator.

operator=() [2/2]

SpectrumIdentification & operator= ( SpectrumIdentification &&  ) &

default

Move assignment operator.

operator==()

bool operator==

(

const SpectrumIdentification &

rhs

)

const

Equality operator.

setHits()

void setHits

(

const std::vector< IdentificationHit > &

hits

)

sets the identification hits of this spectrum identification (corresponds to single peptide hit in the list)

Member Data Documentation

hits_

std::vector<IdentificationHit> hits_

protected

Single peptide hits.

id_

String id_

protected

Identifier.