hgps::core::Version Class Reference

Application Programming Interface (API) version data type. More...

#include <version.h>

Public Member Functions
	Version ()=delete
	Version (const Version &)=delete
Version &	operator= (const Version &)=delete
	Version (const Version &&)=delete
Version &	operator= (const Version &&)=delete

Static Public Member Functions
static int	GetMajor ()
	Gets the API major version. More...
static int	GetMinor ()
	Gets the API minor version. More...
static int	GetPatch ()
	Gets the API patch version. More...
static std::string	GetVersion ()
	Creates a string representation of API version. More...
static bool	IsAtLeast (int major, int minor, int patch)
	Validates the API version compatibility. More...
static bool	HasFeature (const std::string &name)
	Checks whether the API version has specific features. More...

Detailed Description

Application Programming Interface (API) version data type.

Constructor & Destructor Documentation

Version() [1/3]

hgps::core::Version::Version ( )

delete

Version() [2/3]

hgps::core::Version::Version ( const Version &  )

delete

Version() [3/3]

hgps::core::Version::Version ( const Version &&  )

delete

Member Function Documentation

GetMajor()

int hgps::core::Version::GetMajor ( )

static

Gets the API major version.

Returns

The major version value

GetMinor()

int hgps::core::Version::GetMinor ( )

static

Gets the API minor version.

Returns

The minor version value

GetPatch()

int hgps::core::Version::GetPatch ( )

static

Gets the API patch version.

Returns

The patch version value

GetVersion()

std::string hgps::core::Version::GetVersion ( )

static

Creates a string representation of API version.

Returns

The version string

HasFeature()

bool hgps::core::Version::HasFeature ( const std::string &  name )

static

Checks whether the API version has specific features.

Parameters

name	The required feature name

Returns

true if the feature is available, otherwise false

IsAtLeast()

bool hgps::core::Version::IsAtLeast ( int  major, int  minor, int  patch  )

static

Validates the API version compatibility.

Parameters

major	Minimum required major version
minor	Minimum required minor version
patch	Minimum required patch version

Returns

true if the versions are compatible, otherwise false

operator=() [1/2]

Version& hgps::core::Version::operator= ( const Version &&  )

delete

operator=() [2/2]

Version& hgps::core::Version::operator= ( const Version &  )

delete

---

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

• HealthGPS.Core/version.h
• HealthGPS.Core/version.cpp