| OpenMS 2.5.0

ScoreType.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/ID/MetaData.h>
38
39 namespace OpenMS
40 {
41 namespace IdentificationDataInternal
42 {
45 struct ScoreType: public MetaInfoInterface
46 {
47 CVTerm cv_term; // @TODO: derive from CVTerm instead?
48
49 bool higher_better;
50
51 ScoreType():
52 higher_better(true)
53 {
54 }
55
56 explicit ScoreType(const CVTerm& cv_term, bool higher_better):
57 cv_term(cv_term), higher_better(higher_better)
58 {
59 }
60
61 explicit ScoreType(const String& name, bool higher_better):
62 cv_term(), higher_better(higher_better)
63 {
64 cv_term.setName(name);
65 }
66
67 ScoreType(const ScoreType& other) = default;
68
69 // don't include "higher_better" in the comparison:
70 bool operator<(const ScoreType& other) const
71 {
72 // @TODO: implement/use "CVTerm::operator<"?
73 return (std::tie(cv_term.getAccession(), cv_term.getName()) <
74 std::tie(other.cv_term.getAccession(),
75 other.cv_term.getName()));
76 }
77
78 // don't include "higher_better" in the comparison:
79 bool operator==(const ScoreType& other) const
80 {
81 return cv_term == other.cv_term;
82 }
83 };
84
85 typedef std::set<ScoreType> ScoreTypes;
86 typedef IteratorWrapper<ScoreTypes::iterator> ScoreTypeRef;
87 }
88 }
OpenMS::IdentificationDataInternal::ScoreTypes
std::set< ScoreType > ScoreTypes
Definition: ScoreType.h:85
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::CVTerm::getName
const String & getName() const
returns the name of the term
OpenMS::CVTerm::getAccession
const String & getAccession() const
returns the accession string of the term
OpenMS::CVTerm::setName
void setName(const String &name)
sets the name of the term
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:43
MetaData.h
OpenMS::CVTerm
Representation of controlled vocabulary term.
Definition: CVTerm.h:52
OpenMS::IdentificationDataInternal::ScoreType::ScoreType
ScoreType()
Definition: ScoreType.h:51
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::IdentificationDataInternal::ScoreType::operator<
bool operator<(const ScoreType &other) const
Definition: ScoreType.h:70
OpenMS::IdentificationDataInternal::ScoreType::operator==
bool operator==(const ScoreType &other) const
Definition: ScoreType.h:79
OpenMS::IdentificationDataInternal::ScoreType
Information about a score type.
Definition: ScoreType.h:45
OpenMS::IdentificationDataInternal::ScoreType::ScoreType
ScoreType(const CVTerm &cv_term, bool higher_better)
Definition: ScoreType.h:56
OpenMS::IdentificationDataInternal::ScoreType::higher_better
bool higher_better
Definition: ScoreType.h:49
OpenMS::IdentificationDataInternal::ScoreTypeRef
IteratorWrapper< ScoreTypes::iterator > ScoreTypeRef
Definition: ScoreType.h:86
OpenMS::IdentificationDataInternal::ScoreType::ScoreType
ScoreType(const String &name, bool higher_better)
Definition: ScoreType.h:61
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::IdentificationDataInternal::ScoreType::cv_term
CVTerm cv_term
Definition: ScoreType.h:47