Data processing step that is applied to the data (e.g. database search, PEP calculation, filtering, ConsensusID). More...

#include <OpenMS/METADATA/ID/ProcessingStep.h>

Inheritance diagram for ProcessingStep:

[legend]

Collaboration diagram for ProcessingStep:

[legend]

Public Member Functions
	ProcessingStep (ProcessingSoftwareRef software_ref, const std::vector< InputFileRef > &input_file_refs=std::vector< InputFileRef >(), const DateTime &date_time=DateTime::now(), const std::set< DataProcessing::ProcessingAction > &actions=std::set< DataProcessing::ProcessingAction >())

	ProcessingStep (const ProcessingStep &other)=default

bool	operator< (const ProcessingStep &other) const

bool	operator== (const ProcessingStep &other) 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 String &name) const
	Returns the value corresponding to a string, or DataValue::EMPTY if not found.

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

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 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 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 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< 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.

Public Attributes
ProcessingSoftwareRef	software_ref

std::vector< InputFileRef >	input_file_refs

DateTime	date_time

std::set< DataProcessing::ProcessingAction >	actions

Additional Inherited Members
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

Data processing step that is applied to the data (e.g. database search, PEP calculation, filtering, ConsensusID).

Constructor & Destructor Documentation

◆ ProcessingStep() [1/2]

ProcessingStep	(	ProcessingSoftwareRef	software_ref,
		const std::vector< InputFileRef > &	input_file_refs = `std::vector<InputFileRef>()`,
		const DateTime &	date_time = `DateTime::now()`,
		const std::set< DataProcessing::ProcessingAction > &	actions = `std::set<DataProcessing::ProcessingAction>()`
	)