hdf5::Version Class Reference

a 3 number version class More...

#include <version.hpp>

Public Types
using	NumberType = unsigned long
	the number type used to represent version numbers More...

Public Member Functions
	Version () noexcept
	default constructor More...
	Version (NumberType major_number, NumberType minor_number, NumberType patch) noexcept
	constructor More...
NumberType	major_number () const noexcept
	return the major version number More...
NumberType	minor_number () const noexcept
	return the minor version number More...
NumberType	patch_number () const noexcept
	return the patch version number More...

Static Public Member Functions
static std::string	to_string (const Version &version)
	convert a Version to a string More...

Detailed Description

Describes a version number.

Member Typedef Documentation

NumberType

using hdf5::Version::NumberType = unsigned long

Constructor & Destructor Documentation

Version() [1/2]

hdf5::Version::Version ( )

noexcept

Set all three version numbers to 0

Version() [2/2]

hdf5::Version::Version ( NumberType  major_number, NumberType  minor_number, NumberType  patch  )

noexcept

Parameters

major_number	the major version number
minor_number	the minor version number
patch	the patch version number

Member Function Documentation

major_number()

NumberType hdf5::Version::major_number ( ) const

noexcept

minor_number()

NumberType hdf5::Version::minor_number ( ) const

noexcept

patch_number()

NumberType hdf5::Version::patch_number ( ) const

noexcept

to_string()

static std::string hdf5::Version::to_string ( const Version &  version )

static

The result is a string with the format MAJOR.MINOR.PATCH.

Parameters

version

reference to a instance of Version

Returns

a new instance of std::string

---

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

• /home/jenkins/h5cpp/src/h5cpp/core/version.hpp