arc::gen4::CArcVersion Class Reference

#include <CArcVersion.h>

Static Public Member Functions
static const std::string	solutionVersion (void) noexcept
static constexpr auto	majorVersion (void) noexcept
static constexpr auto	minorVersion (void) noexcept
static const std::string	releaseNotes (const std::filesystem::path &tFile)
static versionUpdateData_t	checkForUpdate (void)
static versionUpdateData_t	checkForUpdate (const std::string &&sResourcePath)

Detailed Description

This class provides API and G4 version data, which include numbers and release notes.

Definition at line 42 of file CArcVersion.h.

Member Function Documentation

solutionVersion()

static const std::string arc::gen4::CArcVersion::solutionVersion ( void  )

staticnoexcept

API solution version string

Returns

API solution version as a string.

majorVersion()

static constexpr auto arc::gen4::CArcVersion::majorVersion ( void  )

inlinestaticconstexprnoexcept

API solution major version value

Returns

Major API solution version

Definition at line 54 of file CArcVersion.h.

minorVersion()

static constexpr auto arc::gen4::CArcVersion::minorVersion ( void  )

inlinestaticconstexprnoexcept

API solution minor version value

Returns

Minor API solution version

Definition at line 62 of file CArcVersion.h.

releaseNotes()

static const std::string arc::gen4::CArcVersion::releaseNotes ( const std::filesystem::path &  tFile )

static

API release notes

Parameters

tFile

- The full filename and path for the release notes file.

Returns

API release notes as a string.

Exceptions

std::ios_base::failure
std::runtime_error

checkForUpdate() [1/2]

static versionUpdateData_t arc::gen4::CArcVersion::checkForUpdate ( void  )

static

Checks if a new API version is available.

Returns

The update details (version and release notes) or an empty string if no update is available.

Exceptions

std::runtime_error
std::system_error

checkForUpdate() [2/2]

static versionUpdateData_t arc::gen4::CArcVersion::checkForUpdate ( const std::string &&  sResourcePath )

static

Checks if a new version of the specified resource is available.

Parameters

sResourcePath

- The resource path containing the update data.

Returns

The update details or an empty string if no update is available.

Exceptions

std::runtime_error
std::system_error