OpenMS  3.0.0
ProcessingStep.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-2022.
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 
40 
41 namespace OpenMS
42 {
43  namespace IdentificationDataInternal
44  {
48  {
50 
51  std::vector<InputFileRef> input_file_refs;
52 
54 
55  // @TODO: add processing actions that are relevant for ID data
56  std::set<DataProcessing::ProcessingAction> actions;
57 
58  explicit ProcessingStep(
60  const std::vector<InputFileRef>& input_file_refs =
61  std::vector<InputFileRef>(), const DateTime& date_time =
62  DateTime::now(), std::set<DataProcessing::ProcessingAction> actions =
63  std::set<DataProcessing::ProcessingAction>()):
66  {
67  }
68 
69  ProcessingStep(const ProcessingStep& other) = default;
70 
71  // order by date/time first, don't compare meta data (?):
72  bool operator<(const ProcessingStep& other) const
73  {
74  return (std::tie(date_time, software_ref, input_file_refs, actions) <
75  std::tie(other.date_time, other.software_ref,
76  other.input_file_refs, other.actions));
77  }
78 
79  // don't compare meta data (?):
80  bool operator==(const ProcessingStep& other) const
81  {
82  return (std::tie(software_ref, input_file_refs, date_time, actions) ==
83  std::tie(other.software_ref, other.input_file_refs,
84  other.date_time, other.actions));
85  }
86  };
87 
88  typedef std::set<ProcessingStep> ProcessingSteps;
90 
91  }
92 }
OpenMS::IdentificationDataInternal::ProcessingStep::date_time
DateTime date_time
Definition: ProcessingStep.h:53
OpenMS::IdentificationDataInternal::ProcessingStep::operator<
bool operator<(const ProcessingStep &other) const
Definition: ProcessingStep.h:72
OpenMS::IdentificationDataInternal::ProcessingStep::input_file_refs
std::vector< InputFileRef > input_file_refs
Definition: ProcessingStep.h:51
OpenMS::IdentificationDataInternal::ProcessingSteps
std::set< ProcessingStep > ProcessingSteps
Definition: ProcessingStep.h:88
OpenMS::DateTime::now
static DateTime now()
Returns the current date and time.
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::IdentificationDataInternal::ProcessingStep::ProcessingStep
ProcessingStep(ProcessingSoftwareRef software_ref, const std::vector< InputFileRef > &input_file_refs=std::vector< InputFileRef >(), const DateTime &date_time=DateTime::now(), std::set< DataProcessing::ProcessingAction > actions=std::set< DataProcessing::ProcessingAction >())
Definition: ProcessingStep.h:58
DataProcessing.h
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::IdentificationDataInternal::IteratorWrapper< ProcessingSoftwares::iterator >
ProcessingSoftware.h
OpenMS::IdentificationDataInternal::ProcessingStep::actions
std::set< DataProcessing::ProcessingAction > actions
Definition: ProcessingStep.h:56
OpenMS::IdentificationDataInternal::ProcessingStepRef
IteratorWrapper< ProcessingSteps::iterator > ProcessingStepRef
Definition: ProcessingStep.h:89
OpenMS::IdentificationDataInternal::ProcessingStep::operator==
bool operator==(const ProcessingStep &other) const
Definition: ProcessingStep.h:80
OpenMS::IdentificationDataInternal::ProcessingStep
Data processing step that is applied to the data (e.g. database search, PEP calculation,...
Definition: ProcessingStep.h:47
InputFile.h
OpenMS::IdentificationDataInternal::ProcessingStep::software_ref
ProcessingSoftwareRef software_ref
Definition: ProcessingStep.h:49
OpenMS::DateTime
DateTime Class.
Definition: DateTime.h:58