Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Protected Attributes | 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:
MetaInfoInterface

Public Member Functions

constructors,destructors,assignment operator
 Identification ()
 default constructor More...
 
virtual ~Identification ()
 destructor More...
 
 Identification (const Identification &source)
 copy constructor More...
 
Identificationoperator= (const Identification &source)
 assignment operator More...
 
bool operator== (const Identification &rhs) const
 Equality operator. More...
 
bool operator!= (const Identification &rhs) const
 Inequality operator. More...
 
Accessors
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...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 constructor More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 copy constructor More...
 
 ~MetaInfoInterface ()
 destructor More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 assignment operator 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 More...
 
const DataValuegetMetaValue (UInt index) const
 returns the value corresponding to an index More...
 
bool metaValueExists (const String &name) const
 returns if this MetaInfo is set More...
 
bool metaValueExists (UInt index) const
 returns if this MetaInfo is set 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 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...
 

Protected Attributes

String id_
 Identifier. More...
 
DateTime creation_date_
 Date and time the search was performed. More...
 
std::vector< SpectrumIdentificationspectrum_identifications_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default 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...
 

Detailed Description

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

Todo:
docu (Andreas)

Constructor & Destructor Documentation

default constructor

virtual ~Identification ( )
virtual

destructor

Identification ( const Identification source)

copy constructor

Member Function Documentation

void addSpectrumIdentification ( const SpectrumIdentification id)

adds a spectrum identification

const DateTime& getCreationDate ( ) const

returns the date and time the file was created

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

returns the spectrum identifications stored

bool operator!= ( const Identification rhs) const

Inequality operator.

Identification& operator= ( const Identification source)

assignment operator

bool operator== ( const Identification rhs) const

Equality operator.

void setCreationDate ( const DateTime date)

sets the date and time the file was written

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

sets the spectrum identifications

Member Data Documentation

DateTime creation_date_
protected

Date and time the search was performed.

String id_
protected

Identifier.

std::vector<SpectrumIdentification> spectrum_identifications_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:28 using doxygen 1.8.11