Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_CONCEPT_VERSIONINFO_H
36 #define OPENMS_CONCEPT_VERSIONINFO_H
37 
38 #include <OpenMS/CONCEPT/Types.h>
39 
40 namespace OpenMS
41 {
42  class String;
43 
59  class OPENMS_DLLAPI VersionInfo
60  {
61 public:
62 
63  struct OPENMS_DLLAPI VersionDetails
64  {
68 
70  version_major(0), version_minor(0), version_patch(0)
71  {
72  }
73 
74 
76  version_major(other.version_major),
77  version_minor(other.version_minor),
78  version_patch(other.version_patch)
79  {
80  }
81 
87  static VersionDetails create(const String & version);
88 
89  bool operator<(const VersionDetails & rhs) const;
90  bool operator==(const VersionDetails & rhs) const;
91  bool operator!=(const VersionDetails & rhs) const;
92  bool operator>(const VersionDetails & rhs) const;
93 
94  static const VersionDetails EMPTY; // 0.0.0 version for comparison
95  };
96 
98  static String getTime();
99 
101  static String getVersion();
102 
104  static VersionDetails getVersionStruct();
105 
117  static String getRevision();
118 
130  static String getBranch();
131 
132  };
133 
134 }
135 
136 #endif // OPENMS_CONCEPT_VERSIONINFO_H
static const VersionDetails EMPTY
Definition: VersionInfo.h:94
A more convenient string class.
Definition: String.h:57
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Int version_major
Definition: VersionInfo.h:65
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
VersionDetails(const VersionDetails &other)
Definition: VersionInfo.h:75
Definition: VersionInfo.h:63
VersionDetails()
Definition: VersionInfo.h:69
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
Int version_patch
Definition: VersionInfo.h:67
int Int
Signed integer type.
Definition: Types.h:103
Version information class.
Definition: VersionInfo.h:59
Int version_minor
Definition: VersionInfo.h:66

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:04 using doxygen 1.8.13