el::ConfigurationTypeHelper Class Reference

Static class that contains helper functions for el::ConfigurationType. More...

#include <easylogging++.h>

Inheritance diagram for el::ConfigurationTypeHelper:

Collaboration diagram for el::ConfigurationTypeHelper:

Static Public Member Functions
static base::type::EnumType	castToInt (ConfigurationType configurationType)
	Casts configuration type to int, useful for iterating through enum.
static ConfigurationType	castFromInt (base::type::EnumType c)
	Casts int(ushort) to configurationt type, useful for iterating through enum.
static const char *	convertToString (ConfigurationType configurationType)
	Converts configuration type to associated const char*.
static ConfigurationType	convertFromString (const char *configStr)
	Converts from configStr to ConfigurationType.
static void	forEachConfigType (base::type::EnumType *startIndex, const std::function< bool(void)> &fn)
	Applies specified function to each configuration type starting from startIndex.

Static Public Attributes
static const base::type::EnumType	kMinValid = static_cast<base::type::EnumType>(ConfigurationType::Enabled)
	Represents minimum valid configuration type. Useful when iterating through enum.
static const base::type::EnumType	kMaxValid = static_cast<base::type::EnumType>(ConfigurationType::MaxLogFileSize)
	Represents maximum valid configuration type. This is used internally and you should not need it.

Detailed Description

Static class that contains helper functions for el::ConfigurationType.

Member Function Documentation

castFromInt()

ConfigurationType el::ConfigurationTypeHelper::castFromInt ( base::type::EnumType c )

inlinestatic

Casts int(ushort) to configurationt type, useful for iterating through enum.

castToInt()

base::type::EnumType el::ConfigurationTypeHelper::castToInt ( ConfigurationType configurationType )

inlinestatic

Casts configuration type to int, useful for iterating through enum.

convertFromString()

ConfigurationType el::ConfigurationTypeHelper::convertFromString ( const char * configStr )

static

Converts from configStr to ConfigurationType.

Parameters

configStr

Upper case string based configuration type. Lower case is also valid but providing upper case is recommended.

convertToString()

const char * el::ConfigurationTypeHelper::convertToString ( ConfigurationType configurationType )

static

Converts configuration type to associated const char*.

Returns

Upper case string based configuration type.

forEachConfigType()

void el::ConfigurationTypeHelper::forEachConfigType ( base::type::EnumType * startIndex, const std::function< bool(void)> & fn )

inlinestatic

Applies specified function to each configuration type starting from startIndex.

Parameters

startIndex	initial value to start the iteration from. This is passed by pointer and is left-shifted so this can be used inside function (fn) to represent current configuration type.
fn	function to apply with each configuration type. This bool represent whether or not to stop iterating through configurations.

Member Data Documentation

kMaxValid

const base::type::EnumType el::ConfigurationTypeHelper::kMaxValid = static_cast<base::type::EnumType>(ConfigurationType::MaxLogFileSize)

static

Represents maximum valid configuration type. This is used internally and you should not need it.

kMinValid

const base::type::EnumType el::ConfigurationTypeHelper::kMinValid = static_cast<base::type::EnumType>(ConfigurationType::Enabled)

static

Represents minimum valid configuration type. Useful when iterating through enum.

---

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

• external/easylogging++/easylogging++.h
• external/easylogging++/easylogging++.cc