OpenMS  3.0.0
ParentGroup.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 
38 
39 #include <boost/multi_index_container.hpp>
40 #include <boost/multi_index/ordered_index.hpp>
41 #include <boost/multi_index/member.hpp>
42 
43 namespace OpenMS
44 {
45  namespace IdentificationDataInternal
46  {
49  // @TODO: derive from MetaInfoInterface?
50  struct ParentGroup
51  {
52  std::map<ScoreTypeRef, double> scores;
53  // @TODO: does this need a "leader" or some such?
54  std::set<ParentSequenceRef> parent_refs;
55  };
56 
57  typedef boost::multi_index_container<
59  boost::multi_index::indexed_by<
60  boost::multi_index::ordered_unique<
61  boost::multi_index::member<
62  ParentGroup, std::set<ParentSequenceRef>,
66 
70  {
71  String label; // @TODO: use "label" as a uniqueness constraint?
73 
74  explicit ParentGroupSet(
75  const String& label = "",
76  const ParentGroups& groups = ParentGroups()):
78  {
79  }
80  };
81 
82  typedef std::vector<ParentGroupSet> ParentGroupSets;
83 
84  }
85 }
OpenMS::IdentificationDataInternal::ParentGroupSet::label
String label
Definition: ParentGroup.h:71
OpenMS::IdentificationDataInternal::ParentGroup::scores
std::map< ScoreTypeRef, double > scores
Definition: ParentGroup.h:52
OpenMS::IdentificationDataInternal::ParentGroup::parent_refs
std::set< ParentSequenceRef > parent_refs
Definition: ParentGroup.h:54
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::IdentificationDataInternal::ParentGroupSet
Set of groups of ambiguously identified parent sequences (e.g. results of running a protein inference...
Definition: ParentGroup.h:69
ParentSequence.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::IdentificationDataInternal::ParentGroups
boost::multi_index_container< ParentGroup, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::member< ParentGroup, std::set< ParentSequenceRef >, &ParentGroup::parent_refs > > > > ParentGroups
Definition: ParentGroup.h:64
OpenMS::IdentificationDataInternal::ParentGroupRef
IteratorWrapper< ParentGroups::iterator > ParentGroupRef
Definition: ParentGroup.h:65
OpenMS::IdentificationDataInternal::IteratorWrapper
Wrapper that adds operator< to iterators, so they can be used as (part of) keys in maps/sets or multi...
Definition: MetaData.h:45
OpenMS::IdentificationDataInternal::ParentGroupSets
std::vector< ParentGroupSet > ParentGroupSets
Definition: ParentGroup.h:82
OpenMS::IdentificationDataInternal::ParentGroupSet::ParentGroupSet
ParentGroupSet(const String &label="", const ParentGroups &groups=ParentGroups())
Definition: ParentGroup.h:74
OpenMS::IdentificationDataInternal::ScoredProcessingResult
Base class for ID data with scores and processing steps (and meta info)
Definition: ScoredProcessingResult.h:44
OpenMS::IdentificationDataInternal::ParentGroupSet::groups
ParentGroups groups
Definition: ParentGroup.h:72
OpenMS::IdentificationDataInternal::ParentGroup
: Group of ambiguously identified parent sequences (e.g. protein group)
Definition: ParentGroup.h:50