Electroneum
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. More...
 
static ConfigurationType castFromInt (base::type::EnumType c)
 Casts int(ushort) to configurationt type, useful for iterating through enum. More...
 
static const char * convertToString (ConfigurationType configurationType)
 Converts configuration type to associated const char*. More...
 
static ConfigurationType convertFromString (const char *configStr)
 Converts from configStr to ConfigurationType. More...
 
static void forEachConfigType (base::type::EnumType *startIndex, const std::function< bool(void)> &fn)
 Applies specified function to each configuration type starting from startIndex. More...
 

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. More...
 
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. More...
 

Detailed Description

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

Definition at line 681 of file easylogging++.h.

Member Function Documentation

◆ castFromInt()

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

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

Definition at line 692 of file easylogging++.h.

692  {
693  return static_cast<ConfigurationType>(c);
694  }
ConfigurationType
Represents enumeration of ConfigurationType used to configure or access certain aspect of logging...

◆ castToInt()

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

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

Definition at line 688 of file easylogging++.h.

688  {
689  return static_cast<base::type::EnumType>(configurationType);
690  }
unsigned int EnumType

◆ convertFromString()

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

Converts from configStr to ConfigurationType.

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

◆ convertToString()

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

Converts configuration type to associated const char*.

Returns
Upper case string based configuration type.

◆ forEachConfigType()

static 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
startIndexinitial 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.
fnfunction 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.

Definition at line 686 of file easylogging++.h.

◆ 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.

Definition at line 684 of file easylogging++.h.


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