sese::system::Environment Class Reference

Environment Information Class. More...

#include <Environment.h>

Inheritance diagram for sese::system::Environment:

Public Member Functions
	Environment ()=delete
Public Member Functions inherited from sese::NotInstantiable
	NotInstantiable ()=delete
virtual	~NotInstantiable ()=default
	NotInstantiable (const NotInstantiable &)=delete
NotInstantiable &	operator= (const NotInstantiable &)=delete

Static Public Member Functions
static const char *	getRepoHash () noexcept
static const char *	getRepoBranch () noexcept
static const char *	getMajorVersion () noexcept
static const char *	getMinorVersion () noexcept
static const char *	getPatchVersion () noexcept
static const char *	getBuildDate () noexcept
static const char *	getBuildTime () noexcept
static const char *	getBuildDateTime () noexcept
static const char *	getOperateSystemType () noexcept
static bool	isLittleEndian () noexcept
static bool	setEnv (const std::string &key, const std::string &value) noexcept
static bool	unsetEnv (const std::string &key) noexcept
static std::string	getEnv (const std::string &key) noexcept

Detailed Description

Environment Information Class.

Constructor & Destructor Documentation

Environment()

sese::system::Environment::Environment ( )

delete

Member Function Documentation

getBuildDate()

const char * sese::system::Environment::getBuildDate ( )

staticnoexcept

Returns

Returns the build date string

getBuildDateTime()

const char * sese::system::Environment::getBuildDateTime ( )

staticnoexcept

Returns

Returns a timestamp of the build time

getBuildTime()

const char * sese::system::Environment::getBuildTime ( )

staticnoexcept

Returns

Returns the build time string

getEnv()

std::string sese::system::Environment::getEnv ( const std::string & key )

staticnoexcept

Get the current context environment variable

Parameters

key

Key

Returns

The retrieved value, which needs to be checked with std::string::empty() for emptiness

getMajorVersion()

const char * sese::system::Environment::getMajorVersion ( )

staticnoexcept

Returns

Returns the major version number

getMinorVersion()

const char * sese::system::Environment::getMinorVersion ( )

staticnoexcept

Returns

Returns the minor version number

getOperateSystemType()

const char * sese::system::Environment::getOperateSystemType ( )

staticnoexcept

Returns

Returns the type of operating system that was built

getPatchVersion()

const char * sese::system::Environment::getPatchVersion ( )

staticnoexcept

Returns

Returns the patch version number

getRepoBranch()

const char * sese::system::Environment::getRepoBranch ( )

staticnoexcept

Returns

Return to the branch where the repository is located

getRepoHash()

const char * sese::system::Environment::getRepoHash ( )

staticnoexcept

Returns

Returns the first 6 bytes of the repository hash

isLittleEndian()

bool sese::system::Environment::isLittleEndian ( )

staticnoexcept

Returns

Returns the CPU's big-and-small mode

setEnv()

bool sese::system::Environment::setEnv ( const std::string & key, const std::string & value )

staticnoexcept

Set the current context environment variable

Parameters

key	Key
value	Value

Returns

Whether the setting was successful

unsetEnv()

bool sese::system::Environment::unsetEnv ( const std::string & key )

staticnoexcept

Unset the current context environment variable

Parameters

key

Key

Returns

Whether the unset operation was successful

---

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

• sese/system/Environment.h
• sese/system/Environment.cpp