gz/math/SemanticVersion.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
 
#ifndef GZ_MATH_SEMANTICVERSION_HH_
#define GZ_MATH_SEMANTICVERSION_HH_
 
#include <iosfwd>
#include <string>
#include <gz/math/Helpers.hh>
#include <gz/math/config.hh>
#include <gz/utils/ImplPtr.hh>
 
namespace gz::math
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MATH_VERSION_NAMESPACE {
  class GZ_MATH_VISIBLE SemanticVersion
  {
    public: SemanticVersion();
 
    public: explicit SemanticVersion(const std::string &_v);
 
    public: explicit SemanticVersion(const unsigned int _major,
                                     const unsigned int _minor = 0,
                                     const unsigned int _patch = 0,
                                     const std::string &_prerelease = "",
                                     const std::string &_build = "");
 
    public: bool Parse(const std::string &_versionStr);
 
    public: std::string Version() const;
 
    public: unsigned int Major() const;
 
    public: unsigned int Minor() const;
 
    public: unsigned int Patch() const;
 
    public: std::string Prerelease() const;
 
    public: std::string Build() const;
 
    public: bool operator<(const SemanticVersion &_other) const;
 
    public: bool operator<=(const SemanticVersion &_other) const;
 
    public: bool operator>(const SemanticVersion &_other) const;
 
    public: bool operator>=(const SemanticVersion &_other) const;
 
    public: bool operator==(const SemanticVersion &_other) const;
 
    public: bool operator!=(const SemanticVersion &_other) const;
 
    public: friend std::ostream &operator<<(std::ostream &_out,
                                            const SemanticVersion &_v)
    {
      _out << _v.Version();
      return _out;
    }
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
  }  // namespace GZ_MATH_VERSION_NAMESPACE
}  // namespace gz::math
#endif  // GZ_MATH_SEMANTICVERSION_HH_