| IOFormat 1.8.0

Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
ioformat::Versioning Class Reference

`#include <ioformat/Versioning.h>`

## Static Public Member Functions
static VersionInfo | version ()
static std::string | versionString ()
static std::string | sha ()
| Return the SHA of the commit used to build this version of IOFormat.
static bool | checkCompatibility (const VersionInfo &version)
static bool | checkCompatibility ()

## Detailed Description

Versioning tool to check library infos.

## Member Function Documentation

## ◆ checkCompatibility() [1/2]

static bool ioformat::Versioning::checkCompatibility | ( |  | ) |
| inline static

Check if the loaded library is compatible with the one defined in the header.

## ◆ checkCompatibility() [2/2]

static bool ioformat::Versioning::checkCompatibility | ( | const VersionInfo & | version | ) |
| static

Checks if the version of the loaded library is compatible with the one given in argument.

A version is compatible if:

- The major version is the same
- The library minor version is greater than the given one.

Parameters

  version | The version to check compatibility for.

## ◆ version()

static VersionInfo ioformat::Versioning::version | ( |  | ) |
| static

Return the version of the currently loaded IOFormat library.

## ◆ versionString()

static std::string ioformat::Versioning::versionString | ( |  | ) |
| static

Return a description string of the currently loaded IOFormat library.

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

- ioformat/public/include/ioformat/Versioning.h