| OpenMS 2.5.0

Public Member Functions | Public Attributes | List of all members
DataProcessingStep Struct Reference

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

`#include <OpenMS/METADATA/ID/DataProcessingStep.h>`

Inheritance diagram for DataProcessingStep:

## Public Member Functions

| DataProcessingStep (ProcessingSoftwareRef software_ref, const std::vector< InputFileRef > &input_file_refs=std::vector< InputFileRef >(), const std::vector< String > &primary_files=std::vector< String >(), const DateTime &date_time=DateTime::now(), std::set< DataProcessing::ProcessingAction > actions=std::set< DataProcessing::ProcessingAction >())
| DataProcessingStep (const DataProcessingStep &other)=default
bool | operator< (const DataProcessingStep &other) const
bool | operator== (const DataProcessingStep &other) 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...
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs)
| Assignment operator. More...
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept
| Move assignment operator. More...
bool | operator== (const MetaInfoInterface &rhs) const
| Equality operator. More...
bool | operator!= (const MetaInfoInterface &rhs) const
| Equality operator. More...
const DataValue & | getMetaValue (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 DataValue & | getMetaValue (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 | 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

ProcessingSoftwareRef | software_ref
std::vector< InputFileRef > | input_file_refs
std::vector< String > | primary_files
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. More...
Protected Member Functions inherited from MetaInfoInterface
void | createIfNotExists_ ()
| Creates the MetaInfo object if it does not exist. More...
Protected Attributes inherited from MetaInfoInterface
MetaInfo * | meta_
| Pointer to the MetaInfo object (0 by default) More...

## Detailed Description

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

## Constructor & Destructor Documentation

## ◆ DataProcessingStep() [1/2]

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

inline explicit

## ◆ DataProcessingStep() [2/2]

DataProcessingStep | ( | const DataProcessingStep & | other | ) |

default

## Member Function Documentation

## ◆ operator<()

bool operator< | ( | const DataProcessingStep & | other | ) | const

inline

References DataProcessingStep::actions, DataProcessingStep::date_time, DataProcessingStep::input_file_refs, DataProcessingStep::primary_files, and DataProcessingStep::software_ref.

## ◆ operator==()

bool operator== | ( | const DataProcessingStep & | other | ) | const

inline

References DataProcessingStep::actions, DataProcessingStep::date_time, DataProcessingStep::input_file_refs, DataProcessingStep::primary_files, and DataProcessingStep::software_ref.

## Member Data Documentation

## ◆ actions

std::set<DataProcessing::ProcessingAction> actions

Referenced by DataProcessingStep::operator<(), and DataProcessingStep::operator==().

## ◆ date_time

DateTime date_time

Referenced by DataProcessingStep::operator<(), and DataProcessingStep::operator==().

## ◆ input_file_refs

std::vector<InputFileRef> input_file_refs

Referenced by DataProcessingStep::operator<(), and DataProcessingStep::operator==().

## ◆ primary_files

std::vector<String> primary_files

Referenced by DataProcessingStep::operator<(), and DataProcessingStep::operator==().

## ◆ software_ref

ProcessingSoftwareRef software_ref

Referenced by DataProcessingStep::operator<(), and DataProcessingStep::operator==().