Loading...
Searching...
No Matches
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion Class Reference

ignition/math/SemanticVersion.hh More...

#include <SemanticVersion.hh>

Public Member Functions

 SemanticVersion ()
 Default constructor.
 
 SemanticVersion (const SemanticVersion &_copy)
 Copy constructor.
 
 SemanticVersion (const std::string &_v)
 Constructor.
 
 SemanticVersion (const unsigned int _major, const unsigned int _minor=0, const unsigned int _patch=0, const std::string &_prerelease="", const std::string &_build="")
 Constructor.
 
 ~SemanticVersion ()
 Destructor.
 
std::string Build () const
 Get the build metadata string.
 
unsigned int Major () const
 Get the major number.
 
unsigned int Minor () const
 Get the minor number.
 
bool operator!= (const SemanticVersion &_other) const
 Inequality comparison operator.
 
bool operator< (const SemanticVersion &_other) const
 Less than comparison operator.
 
bool operator<= (const SemanticVersion &_other) const
 Less than or equal comparison operator.
 
SemanticVersionoperator= (const SemanticVersion &_other)
 Assignment operator.
 
bool operator== (const SemanticVersion &_other) const
 Equality comparison operator.
 
bool operator> (const SemanticVersion &_other) const
 Greater than comparison operator.
 
bool operator>= (const SemanticVersion &_other) const
 Greater than or equal comparison operator.
 
bool Parse (const std::string &_versionStr)
 Parse a version string and set the major, minor, patch numbers, and prerelease and build strings.
 
unsigned int Patch () const
 Get the patch number.
 
std::string Prerelease () const
 Get the prerelease string.
 
std::string Version () const
 Returns the version as a string.
 

Detailed Description

ignition/math/SemanticVersion.hh

Version comparison class based on Semantic Versioning 2.0.0 http://semver.org/ Compares versions and converts versions from string.

Constructor & Destructor Documentation

◆ SemanticVersion() [1/4]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::SemanticVersion ( )

Default constructor.

Use the Parse function to populate an instance with version information.

◆ SemanticVersion() [2/4]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::SemanticVersion ( const std::string & _v)
explicit

Constructor.

Parameters
[in]_vthe string version. ex: "0.3.2"

◆ SemanticVersion() [3/4]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::SemanticVersion ( const SemanticVersion & _copy)

Copy constructor.

Parameters
[in]_copythe other version

◆ SemanticVersion() [4/4]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::SemanticVersion ( const unsigned int _major,
const unsigned int _minor = 0,
const unsigned int _patch = 0,
const std::string & _prerelease = "",
const std::string & _build = "" )

Constructor.

Parameters
[in]_majorThe major number
[in]_minorThe minor number
[in]_patchThe patch number
[in]_prereleaseThe prerelease string
[in]_buildThe build metadata string

◆ ~SemanticVersion()

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::~SemanticVersion ( )

Destructor.

Member Function Documentation

◆ Build()

std::string ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Build ( ) const

Get the build metadata string.

Build meta data is not used when determining precedence.

Returns
Build metadata string, empty if a build metadata string was not specified.

◆ Major()

unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Major ( ) const

Get the major number.

Returns
The major number

◆ Minor()

unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Minor ( ) const

Get the minor number.

Returns
The minor number

◆ operator!=()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator!= ( const SemanticVersion & _other) const

Inequality comparison operator.

Parameters
[in]_otherThe other version to compare to
Returns
True if _other version is different

◆ operator<()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator< ( const SemanticVersion & _other) const

Less than comparison operator.

Parameters
[in]_otherThe other version to compare to
Returns
True if _other version is newer

◆ operator<=()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator<= ( const SemanticVersion & _other) const

Less than or equal comparison operator.

Parameters
[in]_otherThe other version to compare to
Returns
True if _other version is newer or equal

◆ operator=()

SemanticVersion & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator= ( const SemanticVersion & _other)

Assignment operator.

Parameters
[in]_otherThe version to assign from.
Returns
The reference to this instance

◆ operator==()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator== ( const SemanticVersion & _other) const

Equality comparison operator.

Parameters
[in]_otherThe other version to compare to
Returns
True if _other version is the same

◆ operator>()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator> ( const SemanticVersion & _other) const

Greater than comparison operator.

Parameters
[in]_otherThe other version to compare to
Returns
True if _other version is older

◆ operator>=()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::operator>= ( const SemanticVersion & _other) const

Greater than or equal comparison operator.

Parameters
[in]_otherThe other version to compare to
Returns
True if _other version is older or the same

◆ Parse()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Parse ( const std::string & _versionStr)

Parse a version string and set the major, minor, patch numbers, and prerelease and build strings.

Parameters
[in]_versionStrThe version string, such as "1.2.3-pr+123" \retur True on success.

◆ Patch()

unsigned int ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Patch ( ) const

Get the patch number.

Returns
The patch number

◆ Prerelease()

std::string ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Prerelease ( ) const

Get the prerelease string.

Returns
Prelrease string, empty if a prerelease string was not specified.

◆ Version()

std::string ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SemanticVersion::Version ( ) const

Returns the version as a string.

Returns
The semantic version string

The documentation for this class was generated from the following file: