OpenMS  2.8.0
List of all members
Identification Class Reference

Represents a object which can store the information of an analysisXML instance. More...

#include <OpenMS/METADATA/Identification.h>

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

Public Member Functions

constructors,destructors,assignment operator
 Identification ()=default
 Default constructor. More...
 
 Identification (const Identification &source)=default
 Copy constructor. More...
 
 Identification (Identification &&)=default
 Move constructor. More...
 
virtual ~Identification ()
 Destructor. More...
 
Identificationoperator= (const Identification &source)=default
 Assignment operator. More...
 
Identificationoperator= (Identification &&) &=default
 Move assignment operator. More...
 
bool operator== (const Identification &rhs) const
 Equality operator. More...
 
bool operator!= (const Identification &rhs) const
 Inequality operator. More...
 
- 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 DataValue &default_value=DataValue::EMPTY) const
 Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
 
const DataValuegetMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
 Returns the value corresponding to an index, or a default value (default: 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...
 

Accessors

String id_
 Identifier. More...
 
DateTime creation_date_
 Date and time the search was performed. More...
 
std::vector< SpectrumIdentificationspectrum_identifications_
 
void setCreationDate (const DateTime &date)
 sets the date and time the file was written More...
 
const DateTimegetCreationDate () const
 returns the date and time the file was created More...
 
void setSpectrumIdentifications (const std::vector< SpectrumIdentification > &ids)
 sets the spectrum identifications More...
 
void addSpectrumIdentification (const SpectrumIdentification &id)
 adds a spectrum identification More...
 
const std::vector< SpectrumIdentification > & getSpectrumIdentifications () const
 returns the spectrum identifications stored More...
 

Additional Inherited Members

- 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

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

Todo:
docu (Andreas)

Constructor & Destructor Documentation

◆ Identification() [1/3]

Identification ( )
default

Default constructor.

◆ Identification() [2/3]

Identification ( const Identification source)
default

Copy constructor.

◆ Identification() [3/3]

Identification ( Identification &&  )
default

Move constructor.

◆ ~Identification()

virtual ~Identification ( )
virtual

Destructor.

Member Function Documentation

◆ addSpectrumIdentification()

void addSpectrumIdentification ( const SpectrumIdentification id)

adds a spectrum identification

◆ getCreationDate()

const DateTime& getCreationDate ( ) const

returns the date and time the file was created

◆ getSpectrumIdentifications()

const std::vector<SpectrumIdentification>& getSpectrumIdentifications ( ) const

returns the spectrum identifications stored

◆ operator!=()

bool operator!= ( const Identification rhs) const

Inequality operator.

◆ operator=() [1/2]

Identification& operator= ( const Identification source)
default

Assignment operator.

◆ operator=() [2/2]

Identification& operator= ( Identification &&  ) &
default

Move assignment operator.

◆ operator==()

bool operator== ( const Identification rhs) const

Equality operator.

◆ setCreationDate()

void setCreationDate ( const DateTime date)

sets the date and time the file was written

◆ setSpectrumIdentifications()

void setSpectrumIdentifications ( const std::vector< SpectrumIdentification > &  ids)

sets the spectrum identifications

Member Data Documentation

◆ creation_date_

DateTime creation_date_
protected

Date and time the search was performed.

◆ id_

String id_
protected

Identifier.

◆ spectrum_identifications_

std::vector<SpectrumIdentification> spectrum_identifications_
protected