| OpenMS 2.5.0

DataProcessingStep.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Hendrik Weisser $
32 // $Authors: Hendrik Weisser $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/METADATA/DataProcessing.h>
38 #include <OpenMS/METADATA/ID/DataProcessingSoftware.h>
39
40 namespace OpenMS
41 {
42 namespace IdentificationDataInternal
43 {
46 struct DataProcessingStep: public MetaInfoInterface
47 {
48 ProcessingSoftwareRef software_ref;
49
50 std::vector<InputFileRef> input_file_refs;
51
52 std::vector<String> primary_files; // path(s) to primary MS data
53
54 DateTime date_time;
55
56 // @TODO: add processing actions that are relevant for ID data
57 std::set<DataProcessing::ProcessingAction> actions;
58
59 explicit DataProcessingStep(
60 ProcessingSoftwareRef software_ref,
61 const std::vector<InputFileRef>& input_file_refs =
62 std::vector<InputFileRef>(), const std::vector<String>& primary_files =
63 std::vector<String>(), const DateTime& date_time = DateTime::now(),
64 std::set<DataProcessing::ProcessingAction> actions =
65 std::set<DataProcessing::ProcessingAction>()):
66 software_ref(software_ref), input_file_refs(input_file_refs),
67 primary_files(primary_files), date_time(date_time), actions(actions)
68 {
69 }
70
71 DataProcessingStep(const DataProcessingStep& other) = default;
72
73 // don't compare meta data (?):
74 bool operator<(const DataProcessingStep& other) const
75 {
76 return (std::tie(software_ref, input_file_refs, primary_files,
77 date_time, actions) <
78 std::tie(other.software_ref, other.input_file_refs,
79 other.primary_files, other.date_time, other.actions));
80 }
81
82 // don't compare meta data (?):
83 bool operator==(const DataProcessingStep& other) const
84 {
85 return (std::tie(software_ref, input_file_refs, primary_files,
86 date_time, actions) ==
87 std::tie(other.software_ref, other.input_file_refs,
88 other.primary_files, other.date_time, other.actions));
89 }
90 };
91
92 typedef std::set<DataProcessingStep> DataProcessingSteps;
93 typedef IteratorWrapper<DataProcessingSteps::iterator> ProcessingStepRef;
94
95 }
96 }
OpenMS::DateTime::now
static DateTime now()
Returns the current date and time.
OpenMS::IdentificationDataInternal::DataProcessingStep
Data processing step that is applied to the data (e.g. database search, PEP calculation, filtering, ConsensusID).
Definition: DataProcessingStep.h:46
OpenMS::IdentificationDataInternal::DataProcessingStep::software_ref
ProcessingSoftwareRef software_ref
Definition: DataProcessingStep.h:48
OpenMS::IdentificationDataInternal::DataProcessingStep::DataProcessingStep
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 >())
Definition: DataProcessingStep.h:59
OpenMS::IdentificationDataInternal::IteratorWrapper< DataProcessingSoftwares::iterator >
DataProcessing.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::DateTime
DateTime Class.
Definition: DateTime.h:54
OpenMS::IdentificationDataInternal::DataProcessingStep::operator<
bool operator<(const DataProcessingStep &other) const
Definition: DataProcessingStep.h:74
OpenMS::IdentificationDataInternal::DataProcessingSteps
std::set< DataProcessingStep > DataProcessingSteps
Definition: DataProcessingStep.h:92
OpenMS::IdentificationDataInternal::DataProcessingStep::date_time
DateTime date_time
Definition: DataProcessingStep.h:54
OpenMS::IdentificationDataInternal::DataProcessingStep::input_file_refs
std::vector< InputFileRef > input_file_refs
Definition: DataProcessingStep.h:50
OpenMS::IdentificationDataInternal::DataProcessingStep::actions
std::set< DataProcessing::ProcessingAction > actions
Definition: DataProcessingStep.h:57
OpenMS::IdentificationDataInternal::DataProcessingStep::operator==
bool operator==(const DataProcessingStep &other) const
Definition: DataProcessingStep.h:83
OpenMS::IdentificationDataInternal::ProcessingStepRef
IteratorWrapper< DataProcessingSteps::iterator > ProcessingStepRef
Definition: DataProcessingStep.h:93
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
DataProcessingSoftware.h
OpenMS::IdentificationDataInternal::DataProcessingStep::primary_files
std::vector< String > primary_files
Definition: DataProcessingStep.h:52