Version::FMTVersion Class Reference

Class exposing the version of FMT, its build date and the available features. More...

#include <FMTVersion.h>

Inheritance diagram for Version::FMTVersion:

Collaboration diagram for Version::FMTVersion:

Public Member Functions
	FMTVersion ()=default
	Default constructor for FMTVersion.
	~FMTVersion ()=default
	Default destructor for FMTVersion.
Public Member Functions inherited from Core::FMTObject
	FMTObject ()
	Default constructor for FMTObject.
virtual	~FMTObject ()
	Default virtual destructor for FMTObject.
	FMTObject (const std::unique_ptr< Exception::FMTExceptionHandler > exhandler)
	Construct a FMTObject passing in the exception handler of another FMTObject.
	FMTObject (const FMTObject &rhs)
	Copy constructor for FMTObject.
FMTObject &	operator= (const FMTObject &rhs)
	Copy assignment operator for FMTObject.
virtual void	passInLogger (const std::unique_ptr< Logging::FMTLogger > &logger)
	Pass in the logger of another FMTObject.
void	passInExceptionHandler (const std::unique_ptr< Exception::FMTExceptionHandler > &exhandler)
	Pass in the exception handler of another FMTObject.
void	redirectLogToFile (const std::string &location)
	Redirect the log to a specific file, appending to it.
virtual void	setDefaultLogger ()
	Create and set a default logger to the FMTObject.
virtual void	setQuietLogger ()
	Create and set a quiet logger to the FMTObject.
virtual void	setTaskLogger ()
	Create and set a task logger to the FMTObject.
virtual void	setDebugLogger ()
	Create and set a debug logger to the FMTObject.
void	setDefaultExceptionHandler ()
	Create and set a default exception handler to the FMTObject.
void	setQuietExceptionHandler ()
	Create and set a quiet exception handler to the FMTObject.
void	setDebugExceptionHandler ()
	Create and set a debug exception handler to the FMTObject.
void	setFreeExceptionHandler ()
	Create and set a free exception handler to the FMTObject.
void	disableNestedExceptions ()
	Disable the nested exception throw of the exception handler.
void	enableNestedExceptions ()
	Enable the nested exception throw of the exception handler.
void	setErrorsToWarnings (const std::vector< Exception::FMTexc > &errors)
	Set a list of errors to be cast to warnings on the exception handler.
void	setMaxWarningsBeforeSilenced (const size_t &maxwarningcount)
	Set the number of warnings raised before being silenced.
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Static Public Member Functions
static int	getMajor ()
	Return the major version of FMT.
static int	getMinor ()
	Return the minor version of FMT.
static int	getPatch ()
	Return the patch version of FMT.
static std::string	getVersion ()
	Return the version string of FMT (Major.Minor.Patch).
static std::string	getDateNow ()
	Return the actual date (Day Month date).
static std::string	getBuildDate ()
	Return the build date of FMT.
static bool	isAtLeast (int major, int minor, int patch)
	Test if the FMT version is at least the given major, minor and patch.
static bool	hasFeature (const std::string &name)
	Test if the FMT version has the named feature (GDAL, OSI, MOSEK, PYTHON, R).
static std::string	getLicense (bool french=false)
	Return the license as a string.
static std::string	getChangelog (bool french=false)
	Return the changelog as a string.
Static Public Member Functions inherited from Core::FMTObject
static Logging::FMTLogger *	getLogger ()
	get a pointer to the actual logger.
static Exception::FMTExceptionHandler *	getExceptionHandler ()
	get a pointer to the actual exception handler.
static std::string	getRuntimeLocation ()
	Return the location of the FMT shared library.
static unsigned long long	getAvailableMemory ()
	Return the available memory in bytes.
static void	setTerminateStack ()
	will write the stack in the log when terminate called and raise a function failed.
static void	setAbortStack ()
	will write the stack in the log when abort called with SIGABRT and raise a function failed.

Additional Inherited Members
Protected Member Functions inherited from Core::FMTObject
template<class Archive >
void	forceSave (Archive &ar, const unsigned int version) const
	Force the serialization to save useful information, which the default FMTObject serialization does not.
template<class Archive >
void	forceLoad (Archive &ar, const unsigned int version)
	Force the serialization to load useful information, which the default FMTObject serialization does not.
void	checkSignals () const
	Check if the user has sent a ctrl-c signal using boost::python to FMT.
void	setCplHandler ()
	Pass the FMT exception handler to the GDAL exception handler (GDAL only).
Static Protected Member Functions inherited from Core::FMTObject
static std::chrono::time_point< std::chrono::high_resolution_clock >	getClock ()
	Return a clock of the current time.
template<class chrono >
static double	getDuration (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock as a double.
static std::string	getDurationInSeconds (const std::chrono::time_point< std::chrono::high_resolution_clock > &startclock)
	Return the time elapsed since a start clock in seconds as a string.
static void	_logStack ()
	Log the stack trace...
static void	_terminate ()
	Raise an error with the boost stacktrace.
static void	_abort (int p_signal)
	Raise an error with the boost stacktrace on abort.
Static Protected Attributes inherited from Core::FMTObject
static std::unique_ptr< Exception::FMTExceptionHandler >	_exhandler
	A shared pointer to the exception handler.
static std::unique_ptr< Logging::FMTLogger >	_logger
	A shared pointer to the logger.

Detailed Description

Class exposing the version of FMT, its build date and the available features.

Constructor & Destructor Documentation

FMTVersion()

Version::FMTVersion::FMTVersion ( )

default

Default constructor for FMTVersion.

~FMTVersion()

Version::FMTVersion::~FMTVersion ( )

default

Default destructor for FMTVersion.

Member Function Documentation

getBuildDate()

static std::string Version::FMTVersion::getBuildDate ( )

static

Return the build date of FMT.

Returns

the build date.

getChangelog()

static std::string Version::FMTVersion::getChangelog ( bool  french = false )

static

Return the changelog as a string.

Parameters

[in]

french

if true returns the changelog in French.

Returns

the changelog string.

getDateNow()

static std::string Version::FMTVersion::getDateNow ( )

static

Return the actual date (Day Month date).

Returns

the actual date.

getLicense()

static std::string Version::FMTVersion::getLicense ( bool  french = false )

static

Return the license as a string.

Parameters

[in]

french

if true returns the license in French.

Returns

the license string.

getMajor()

static int Version::FMTVersion::getMajor ( )

static

Return the major version of FMT.

Returns

the major version of FMT.

getMinor()

static int Version::FMTVersion::getMinor ( )

static

Return the minor version of FMT.

Returns

the minor version of FMT.

getPatch()

static int Version::FMTVersion::getPatch ( )

static

Return the patch version of FMT.

Returns

the patch version of FMT.

getVersion()

static std::string Version::FMTVersion::getVersion ( )

static

Return the version string of FMT (Major.Minor.Patch).

Returns

the version string.

hasFeature()

static bool Version::FMTVersion::hasFeature ( const std::string &  name )

static

Test if the FMT version has the named feature (GDAL, OSI, MOSEK, PYTHON, R).

Parameters

[in]

name

the feature name.

Returns

true if the feature is available else false.

isAtLeast()

static bool Version::FMTVersion::isAtLeast ( int  major, int  minor, int  patch  )

static

Test if the FMT version is at least the given major, minor and patch.

Parameters

[in]	major	the major version.
[in]	minor	the minor version.
[in]	patch	the patch version.

Returns

true if the version is at least the given one else false.

---

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

• D:/FMT/Include/FMTVersion.h