api/gmxapi/cpp/version.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 #include "gmxpre.h"
  37
  38 #include "gmxapi/version.h"
  39
  40 namespace gmxapi
  41 {
  42
  43 version_t Version::majorVersion()
  44 {
  45     return c_majorVersion;
  46 }
  47
  48 version_t Version::minorVersion()
  49 {
  50     return c_minorVersion;
  51 }
  52
  53 version_t Version::patchVersion()
  54 {
  55     return c_patchVersion;
  56 }
  57
  58 std::string Version::release()
  59 {
  60     return c_release;
  61 }
  62
  63 bool Version::hasFeature(const std::string& featurename)
  64 {
  65     // For features introduced without an incompatible API change or where
  66     // semantic versioning is otherwise insufficient, we can consult a map, TBD.
  67     (void)featurename;
  68     return false;
  69 }
  70
  71 bool Version::isAtLeast(version_t major, version_t minor, version_t patch)
  72 {
  73     if (Version::majorVersion() < major)
  74     {
  75         return false;
  76     }
  77     if (Version::majorVersion() > major)
  78     {
  79         return true;
  80     }
  81     if (Version::minorVersion() < minor)
  82     {
  83         return false;
  84     }
  85     if (Version::minorVersion() > minor)
  86     {
  87         return true;
  88     }
  89     return Version::patchVersion() >= patch;
  90 }
  91
  92
  93 } // end namespace gmxapi