All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
ProcessingStep Struct Reference

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 ()
 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

ProcessingSoftwareRef software_ref
 
std::vector< InputFileRefinput_file_refs
 
DateTime date_time
 
std::set< DataProcessing::ProcessingActionactions
 

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

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>() 
)
inlineexplicit

◆ ProcessingStep() [2/2]

ProcessingStep ( const ProcessingStep other)
default

Member Function Documentation

◆ operator<()

◆ operator==()

Member Data Documentation

◆ actions

◆ date_time

◆ input_file_refs

std::vector<InputFileRef> input_file_refs

◆ software_ref