Utilities

General Kanzi utility classes and functions. More...

Collaboration diagram for Utilities:

Topics
	File utilities
	File handling utility classes.

Classes
struct	kanzi::enable_bitmask_operators< Enum >
	Enabler template for bitmask operators over an Enum class. More...
class	kanzi::FixedString
	String that points to a string literal. More...
class	kanzi::FlagScopeGuard< FlagValue >
	Scope guard for boolean value. More...
class	kanzi::FrameTimeQueue
	Helper class for calculating the frame rate. More...
struct	kanzi::from_chars_result
	Holds the status result of a call to from_chars. More...

Functions
from_chars_result	kanzi::from_chars (const char *first, const char *last, int &value, int base=10)
	Converts a character sequence to an integer value.
from_chars_result	kanzi::from_chars (const char *first, const char *last, unsigned int &value, int base=10)
	Converts a character sequence to an unsigned integer value.
from_chars_result	kanzi::from_chars (const char *first, const char *last, unsigned long &value, int base=10)
	Converts a character sequence to an unsigned long value.
from_chars_result	kanzi::from_chars (const char *first, const char *last, unsigned long long &value, int base=10)
	Converts a character sequence to an unsigned long long value.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator& (Enum lhs, Enum rhs)
	Bitwise AND operator between two enum class values.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type	kanzi::operator&= (Enum &lhs, Enum rhs)
	Bitwise AND assignment operator between two enum class values.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator^ (Enum lhs, Enum rhs)
	Bitwise XOR operator between two enum class values.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type	kanzi::operator^= (Enum &lhs, Enum rhs)
	Bitwise XOR assignment operator between two enum class values.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator| (Enum lhs, Enum rhs)
	Bitwise OR operator between two enum class values.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type	kanzi::operator|= (Enum &lhs, Enum rhs)
	Bitwise OR assignment operator between two enum class values.
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator~ (Enum lhs)
	Bitwise NOT operator over an enum class value.

Detailed Description

General Kanzi utility classes and functions.

Function Documentation

from_chars() [1/4]

from_chars_result kanzi::from_chars ( const char * first, const char * last, int & value, int base = 10 )

inline

Converts a character sequence to an integer value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters

first	Pointer to the first character in the range to be converted.
last	Pointer to the first character beyond the last in range to be converted.
value	Reference to the storage where the converted value is stored.
base	Integer base of the character string.

Returns

Status result of the value conversion.

from_chars() [2/4]

from_chars_result kanzi::from_chars ( const char * first, const char * last, unsigned int & value, int base = 10 )

inline

Converts a character sequence to an unsigned integer value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters

first	Pointer to the first character in the range to be converted.
last	Pointer to the first character beyond the last in range to be converted.
value	Reference to the storage where the converted value is stored.
base	Integer base of the character string.

Returns

Status result of the value conversion.

from_chars() [3/4]

from_chars_result kanzi::from_chars ( const char * first, const char * last, unsigned long & value, int base = 10 )

inline

Converts a character sequence to an unsigned long value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters

first	Pointer to the first character in the range to be converted.
last	Pointer to the first character beyond the last in range to be converted.
value	Reference to the storage where the converted value is stored.
base	Integer base of the character string.

Returns

Status result of the value conversion.

from_chars() [4/4]

from_chars_result kanzi::from_chars ( const char * first, const char * last, unsigned long long & value, int base = 10 )

inline

Converts a character sequence to an unsigned long long value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters

first	Pointer to the first character in the range to be converted.
last	Pointer to the first character beyond the last in range to be converted.
value	Reference to the storage where the converted value is stored.
base	Integer base of the character string.

Returns

Status result of the value conversion.

operator|()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator|	(	Enum	lhs,
		Enum	rhs )

Bitwise OR operator between two enum class values.

operator&()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator&	(	Enum	lhs,
		Enum	rhs )

Bitwise AND operator between two enum class values.

operator^()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator^	(	Enum	lhs,
		Enum	rhs )

Bitwise XOR operator between two enum class values.

operator~()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator~

(

Enum

lhs

)

Bitwise NOT operator over an enum class value.

operator|=()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type kanzi::operator|=	(	Enum &	lhs,
		Enum	rhs )

Bitwise OR assignment operator between two enum class values.

operator&=()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type kanzi::operator&=	(	Enum &	lhs,
		Enum	rhs )

Bitwise AND assignment operator between two enum class values.

operator^=()

template<typename Enum >

enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type kanzi::operator^=	(	Enum &	lhs,
		Enum	rhs )

Bitwise XOR assignment operator between two enum class values.