rogue::Version Class Reference

Rogue version query and comparison helpers. More...

#include <Version.h>

Public Member Functions
	Version ()
	Default constructor.

Static Public Member Functions
static std::string	current ()
	Returns current Rogue version string.
static bool	greaterThanEqual (const std::string &compare)
	Returns whether current version is greater than or equal to compare.
static bool	greaterThan (const std::string &compare)
	Returns whether current version is greater than compare.
static bool	lessThanEqual (const std::string &compare)
	Returns whether current version is less than or equal to compare.
static bool	lessThan (const std::string &compare)
	Returns whether current version is less than compare.
static void	minVersion (const std::string &compare)
	Throws if current version is below required minimum.
static void	maxVersion (const std::string &compare)
	Throws if current version is above allowed maximum.
static void	exactVersion (const std::string &compare)
	Throws unless current version exactly matches compare.
static void	setup_python ()
	Registers Python bindings for version helpers.
static uint32_t	getMajor ()
	Returns major version component.
static uint32_t	getMinor ()
	Returns minor version component.
static uint32_t	getMaint ()
	Returns maintenance/patch version component.
static uint32_t	getDevel ()
	Returns development/build component.
static void	sleep (uint32_t seconds)
	Sleep helper for testing/debug timing.
static void	usleep (uint32_t useconds)
	Microsecond sleep helper for testing/debug timing.
static std::string	pythonVersion ()
	Returns Python runtime version string.

Detailed Description

Rogue version query and comparison helpers.

Provides access to the runtime Rogue version string/components and utilities to compare against a requested version expression. Comparison helpers parse the passed version string into major/minor/maintenance components.

Definition at line 35 of file Version.h.

Constructor & Destructor Documentation

Version()

rogue::Version::Version ( )

inline

Default constructor.

Definition at line 48 of file Version.h.

Member Function Documentation

current()

std::string rogue::Version::current ( )

static

Returns current Rogue version string.

Returns

Version string.

Definition at line 66 of file Version.cpp.

exactVersion()

void rogue::Version::exactVersion ( const std::string &  compare )

static

Throws unless current version exactly matches compare.

Parameters

compare

Required exact version string.

Definition at line 121 of file Version.cpp.

getDevel()

uint32_t rogue::Version::getDevel ( )

static

Returns development/build component.

Definition at line 141 of file Version.cpp.

getMaint()

uint32_t rogue::Version::getMaint ( )

static

Returns maintenance/patch version component.

Definition at line 136 of file Version.cpp.

getMajor()

uint32_t rogue::Version::getMajor ( )

static

Returns major version component.

Definition at line 126 of file Version.cpp.

getMinor()

uint32_t rogue::Version::getMinor ( )

static

Returns minor version component.

Definition at line 131 of file Version.cpp.

greaterThan()

bool rogue::Version::greaterThan ( const std::string &  compare )

static

Returns whether current version is greater than compare.

Parameters

compare

Version string to compare against.

Returns

true when current version is > compare.

Definition at line 81 of file Version.cpp.

greaterThanEqual()

bool rogue::Version::greaterThanEqual ( const std::string &  compare )

static

Returns whether current version is greater than or equal to compare.

Parameters

compare

Version string to compare against.

Returns

true when current version is >= compare.

Definition at line 71 of file Version.cpp.

lessThan()

bool rogue::Version::lessThan ( const std::string &  compare )

static

Returns whether current version is less than compare.

Parameters

compare

Version string to compare against.

Returns

true when current version is < compare.

Definition at line 101 of file Version.cpp.

lessThanEqual()

bool rogue::Version::lessThanEqual ( const std::string &  compare )

static

Returns whether current version is less than or equal to compare.

Parameters

compare

Version string to compare against.

Returns

true when current version is <= compare.

Definition at line 91 of file Version.cpp.

maxVersion()

void rogue::Version::maxVersion ( const std::string &  compare )

static

Throws if current version is above allowed maximum.

Parameters

compare

Maximum allowed version string.

Definition at line 116 of file Version.cpp.

minVersion()

void rogue::Version::minVersion ( const std::string &  compare )

static

Throws if current version is below required minimum.

Parameters

compare

Minimum required version string.

Definition at line 111 of file Version.cpp.

pythonVersion()

std::string rogue::Version::pythonVersion ( )

static

Returns Python runtime version string.

Definition at line 146 of file Version.cpp.

setup_python()

void rogue::Version::setup_python ( )

static

Registers Python bindings for version helpers.

Definition at line 168 of file Version.cpp.

sleep()

void rogue::Version::sleep ( uint32_t  seconds )

static

Sleep helper for testing/debug timing.

Definition at line 158 of file Version.cpp.

usleep()

void rogue::Version::usleep ( uint32_t  useconds )

static

Microsecond sleep helper for testing/debug timing.

Definition at line 163 of file Version.cpp.

---

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

• /home/runner/work/rogue/rogue/include/rogue/Version.h
• /home/runner/work/rogue/rogue/src/rogue/Version.cpp