ConsensusMap::ColumnHeader Struct Reference

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

#include <OpenMS/KERNEL/ConsensusMap.h>

Inheritance diagram for ConsensusMap::ColumnHeader:

Collaboration diagram for ConsensusMap::ColumnHeader:

Public Member Functions
	ColumnHeader ()=default
	Default constructor.
	ColumnHeader (const ColumnHeader &)=default
	Copy constructor.
ColumnHeader &	operator= (const ColumnHeader &)=default
	Copy assignment.
unsigned	getLabelAsUInt (const std::string &experiment_type) const
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 std::string &name) const
	Returns the value corresponding to a string, or DataValue::EMPTY if not found.
DataValue	getMetaValue (const std::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 std::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 std::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 std::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< std::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.
MetaInfoConstIterator	metaBegin () const
	Returns a const iterator to the beginning of the meta info entries.
MetaInfoConstIterator	metaEnd () const
	Returns a const iterator to the end of the meta info entries.
Size	metaSize () const
	Returns the number of meta info entries.

Public Attributes
std::string	filename
	File name of the mzML file.
std::string	label
	Label e.g. 'heavy' and 'light' for ICAT, or 'sample1' and 'sample2' for label-free quantitation.
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.
UInt64	unique_id = UniqueIdInterface::INVALID
	Unique id of the file.

Additional Inherited Members
Public Types inherited from MetaInfoInterface
using	MetaInfoConstIterator = MetaInfo::const_iterator
	Const iterator type for iterating over meta info entries.
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

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 std::string &

experiment_type

)

const

operator=()

ColumnHeader & operator= ( const ColumnHeader &  )

default

Copy assignment.

Member Data Documentation

filename

std::string filename

File name of the mzML file.

label

std::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

UInt64 unique_id = UniqueIdInterface::INVALID

Unique id of the file.