OpenMS
ConsensusMap::ColumnHeader Struct Reference

Description of the columns in a consensus map. More...

#include <OpenMS/KERNEL/ConsensusMap.h>

Inheritance diagram for ConsensusMap::ColumnHeader:
[legend]
Collaboration diagram for ConsensusMap::ColumnHeader:
[legend]

Public Member Functions

 ColumnHeader ()=default
 Default constructor. More...
 
 ColumnHeader (const ColumnHeader &)=default
 Copy constructor. More...
 
ColumnHeaderoperator= (const ColumnHeader &)=default
 Copy assignment. More...
 
unsigned getLabelAsUInt (const String &experiment_type) const
 
- 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...
 

Public Attributes

String filename
 File name of the mzML file. More...
 
String label
 Label e.g. 'heavy' and 'light' for ICAT, or 'sample1' and 'sample2' for label-free quantitation. More...
 
Size size = 0
 Number of elements (features, peaks, ...). This is e.g. used to check for correct element indices when writing a consensus map TODO fix that. More...
 
UInt64 unique_id = UniqueIdInterface::INVALID
 Unique id of the file. 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

Description of the columns in a consensus map.

Constructor & Destructor Documentation

◆ ColumnHeader() [1/2]

ColumnHeader ( )
default

Default constructor.

◆ ColumnHeader() [2/2]

ColumnHeader ( const ColumnHeader )
default

Copy constructor.

Member Function Documentation

◆ getLabelAsUInt()

unsigned getLabelAsUInt ( const String experiment_type) const

◆ operator=()

ColumnHeader& operator= ( const ColumnHeader )
default

Copy assignment.

Member Data Documentation

◆ filename

String filename

File name of the mzML file.

◆ label

String label

Label e.g. 'heavy' and 'light' for ICAT, or 'sample1' and 'sample2' for label-free quantitation.

◆ size

Size size = 0

Number of elements (features, peaks, ...). This is e.g. used to check for correct element indices when writing a consensus map TODO fix that.

◆ unique_id

Unique id of the file.