| OpenMS 2.5.0

VersionInfo.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: Chris Bielow $
32 // $Authors: Clemens Groepl, Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/CONCEPT/Types.h>
38 #include <OpenMS/DATASTRUCTURES/String.h>
39
40 namespace OpenMS
41 {
42 class String;
43
62 class OPENMS_DLLAPI VersionInfo
63 {
64 public:
65
66 struct OPENMS_DLLAPI VersionDetails
67 {
68 Int version_major;
69 Int version_minor;
70 Int version_patch;
71 String pre_release_identifier;
72
73 VersionDetails() :
74 version_major(0), version_minor(0), version_patch(0), pre_release_identifier("")
75 {
76 }
77
78
79 VersionDetails(const VersionDetails & other):
80 version_major(other.version_major),
81 version_minor(other.version_minor),
82 version_patch(other.version_patch),
83 pre_release_identifier(other.pre_release_identifier)
84 {
85 }
86
92 static VersionDetails create(const String & version);
93
94 bool operator<(const VersionDetails & rhs) const;
95 bool operator==(const VersionDetails & rhs) const;
96 bool operator!=(const VersionDetails & rhs) const;
97 bool operator>(const VersionDetails & rhs) const;
98
99 static const VersionDetails EMPTY; // 0.0.0 version for comparison
100 };
101
103 static String getTime();
104
106 static String getVersion();
107
109 static VersionDetails getVersionStruct();
110
122 static String getRevision();
123
135 static String getBranch();
136
137 };
138
139 }
140
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::operator<
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
OpenMS::VersionInfo::VersionDetails::version_patch
Int version_patch
Definition: VersionInfo.h:70
OpenMS::VersionInfo::VersionDetails::version_major
Int version_major
Definition: VersionInfo.h:68
OpenMS::VersionInfo
Version information class.
Definition: VersionInfo.h:62
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
Types.h
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::VersionInfo::VersionDetails::VersionDetails
VersionDetails()
Definition: VersionInfo.h:73
OpenMS::VersionInfo::VersionDetails
Definition: VersionInfo.h:66
OpenMS::VersionInfo::VersionDetails::EMPTY
static const VersionDetails EMPTY
Definition: VersionInfo.h:99
int
OpenMS::VersionInfo::VersionDetails::VersionDetails
VersionDetails(const VersionDetails &other)
Definition: VersionInfo.h:79
OpenMS::VersionInfo::VersionDetails::pre_release_identifier
String pre_release_identifier
Definition: VersionInfo.h:71
OpenMS::VersionInfo::VersionDetails::version_minor
Int version_minor
Definition: VersionInfo.h:69
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806