VersionInfo.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Clemens Groepl, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
namespace OpenMS
{
  class String;
 
  class OPENMS_DLLAPI VersionInfo
  {
public:
 
    struct OPENMS_DLLAPI VersionDetails
    {
      Int version_major = 0;
      Int version_minor = 0;
      Int version_patch = 0;
      String pre_release_identifier;
 
      VersionDetails() = default;
 
      VersionDetails(const VersionDetails & other) = default;
 
      VersionDetails& operator=(const VersionDetails& other) = default;
 
      static VersionDetails create(const String & version);
 
      bool operator<(const VersionDetails & rhs) const;
      bool operator==(const VersionDetails & rhs) const;
      bool operator!=(const VersionDetails & rhs) const;
      bool operator>(const VersionDetails & rhs) const;
 
      static const VersionDetails EMPTY; // 0.0.0 version for comparison
    };
 
    static String getTime();
 
    static String getVersion();
 
    static VersionDetails getVersionStruct();
 
    static String getRevision();
 
    static String getBranch();
 
  };
 
}