AEnum Class Reference

#include <AEnum.hpp>

Public Member Functions
const String &	getKey () const
	Return the enum key as a string (max 10 characters) More...
int	getValue () const
	Return enum value as an integer value (max 32 enum) More...
const String &	getDescr () const
	Return the enum description as a string. More...
bool	operator< (const AEnum &e) const
bool	operator<= (const AEnum &e) const
bool	operator> (const AEnum &e) const
bool	operator>= (const AEnum &e) const
bool	operator== (const AEnum &e) const
bool	operator!= (const AEnum &e) const
bool	isSmaller (const AEnum &e) const
bool	isSmallerOrEqual (const AEnum &e) const
bool	isGreater (const AEnum &e) const
bool	isGreaterOrEqual (const AEnum &e) const
bool	isEqual (const AEnum &e) const
bool	isDifferent (const AEnum &e) const
void	printEnum () const

Protected Member Functions
	AEnum (const String &key, int value, const String &descr)
	AEnum (const AEnum &)=default
	~AEnum ()=default
AEnum &	operator= (const AEnum &)=default

Static Protected Member Functions
template<typename ... Args>
static void	_printMsg (const char *format, Args... args)

Private Attributes
String	_key
int	_value
String	_descr

Constructor & Destructor Documentation

AEnum() [1/2]

AEnum::AEnum ( const String &  key, int  value, const String &  descr  )

inlineprotected

AEnum() [2/2]

AEnum::AEnum ( const AEnum &  )

protecteddefault

~AEnum()

AEnum::~AEnum ( )

protecteddefault

Member Function Documentation

_printMsg()

template<typename ... Args>

void AEnum::_printMsg ( const char *  format, Args...  args  )

staticprotected

This function is used to call standard 'message' function (in order to route the message to the relevant terminal)

Parameters

format	Printing format
args	Variable list of arguments

getDescr()

const String& AEnum::getDescr ( ) const

inline

Return the enum description as a string.

getKey()

const String& AEnum::getKey ( ) const

inline

Return the enum key as a string (max 10 characters)

getValue()

int AEnum::getValue ( ) const

inline

Return enum value as an integer value (max 32 enum)

isDifferent()

bool AEnum::isDifferent ( const AEnum &  e ) const

inline

isEqual()

bool AEnum::isEqual ( const AEnum &  e ) const

inline

isGreater()

bool AEnum::isGreater ( const AEnum &  e ) const

inline

isGreaterOrEqual()

bool AEnum::isGreaterOrEqual ( const AEnum &  e ) const

inline

isSmaller()

bool AEnum::isSmaller ( const AEnum &  e ) const

inline

isSmallerOrEqual()

bool AEnum::isSmallerOrEqual ( const AEnum &  e ) const

inline

operator!=()

bool AEnum::operator!= ( const AEnum &  e ) const

inline

operator<()

bool AEnum::operator< ( const AEnum &  e ) const

inline

operator<=()

bool AEnum::operator<= ( const AEnum &  e ) const

inline

operator=()

AEnum& AEnum::operator= ( const AEnum &  )

protecteddefault

operator==()

bool AEnum::operator== ( const AEnum &  e ) const

inline

operator>()

bool AEnum::operator> ( const AEnum &  e ) const

inline

operator>=()

bool AEnum::operator>= ( const AEnum &  e ) const

inline

printEnum()

void AEnum::printEnum

(

)

const

Member Data Documentation

_descr

String AEnum::_descr

private

_key

String AEnum::_key

private

_value

int AEnum::_value

private

---

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

• include/Enum/AEnum.hpp
• src/Enum/AEnum.cpp