Bayeux  3.4.1
Core Foundation library for SuperNEMO
version.h
Go to the documentation of this file.
1 //
7 // Copyright (c) 2013 by Ben Morgan <bmorgan.warwick@gmail.com>
8 // Copyright (c) 2013 by The University of Warwick
9 //
10 // This file is part of emfield.
11 //
12 // emfield is free software: you can redistribute it and/or modify
13 // it under the terms of the GNU General Public License as published by
14 // the Free Software Foundation, either version 3 of the License, or
15 // (at your option) any later version.
16 //
17 // emfield is distributed in the hope that it will be useful,
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU General Public License
23 // along with emfield. If not, see <http://www.gnu.org/licenses/>.
24 
25 #ifndef EMFIELD_VERSION_H
26 #define EMFIELD_VERSION_H
27 
28 // Standard Library:
29 #include <string>
30 
31 //----------------------------------------------------------------------
32 // - Compile Time API
34 #define EMFIELD_VERSION_MAJOR 2
35 
37 #define EMFIELD_VERSION_MINOR 2
38 
40 #define EMFIELD_VERSION_PATCH 0
41 
43 #define EMFIELD_ENCODE_VERSION(major, minor, patch) ( \
44  ((major) * 10000) \
45  + ((minor) * 100) \
46  + ((patch) * 1))
47 
49 #define EMFIELD_VERSION EMFIELD_ENCODE_VERSION( \
50  EMFIELD_VERSION_MAJOR, \
51  EMFIELD_VERSION_MINOR, \
52  EMFIELD_VERSION_PATCH)
53 
55 #define EMFIELD_LIB_VERSION "2.2.0"
56 
58 #define EMFIELD_IS_AT_LEAST(major,minor,patch) ( \
59  EMFIELD_VERSION >= \
60  EMFIELD_ENCODE_VERSION(major,minor,patch))
61 
62 //----------------------------------------------------------------------
63 // Runtime API
64 namespace emfield {
65 
67  struct version {
69  static int get_major();
70 
72  static int get_minor();
73 
75  static int get_patch();
76 
78  static std::string get_version();
79 
81  static bool is_at_least(int major, int minor, int patch);
82 
84  static bool has_feature(const std::string& feature);
85  };
86 
87 } // namespace emfield
88 
89 #endif // EMFIELD_VERSION_H
90 
91 // Local Variables: --
92 // mode: c++ --
93 // c-file-style: "gnu" --
94 // tab-width: 2 --
95 // End: --
static std::string get_version()
Return the full version number of emfield as a string, e.g., '1.2.3'.
static bool is_at_least(int major, int minor, int patch)
Return true if the current emfield version >= (major, minor, patch)
static bool has_feature(const std::string &feature)
Return true if the named feature is available in emfield.
static int get_major()
Return the major version number of emfield, e.g., 1 for '1.2.3'.
static int get_patch()
Return the patch version number of emfield, e.g., 3 for '1.2.3'.
Top-level namespace of the Bayeux/emfield module library.
Definition: base_electromagnetic_field.h:40
static int get_minor()
Return the minor version number of emfield, e.g., 2 for '1.2.3'.
Describe the emfield API version and features.
Definition: version.h:67