OpenMS
SpectrumIdentification Class Reference

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

Inheritance diagram for SpectrumIdentification:
[legend]
Collaboration diagram for SpectrumIdentification:
[legend]

constructors,destructors,assignment operator

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

Additional Inherited Members

- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 Constructor. More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 Copy constructor. More...
 
 MetaInfoInterface (MetaInfoInterface &&) noexcept
 Move constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
void swap (MetaInfoInterface &rhs)
 Swap contents. More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 Returns the value corresponding to a string, or DataValue::EMPTY if not found. More...
 
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
More...
 
const DataValuegetMetaValue (UInt index) const
 Returns the value corresponding to the index, or DataValue::EMPTY if not found. More...
 
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
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 addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one 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 inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 Returns a reference to the MetaInfoRegistry. More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 Creates the MetaInfo object if it does not exist. More...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

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]

Default constructor.

◆ ~SpectrumIdentification()

virtual ~SpectrumIdentification ( )
virtual

Destructor.

◆ SpectrumIdentification() [2/3]

Copy constructor.

◆ SpectrumIdentification() [3/3]

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.