Enum

Classes
class	Arp::Enum< T >
	Adapter class for enums to make them loggable and parsable from e.g. XML files. More...

Functions
template<class T >
Enum< T >	Arp::make_enum (T value)
	Global make function to adapt any enum class by class Enum. More...
template<class T >
std::ostream &	Arp::operator<< (std::ostream &os, Enum< T > value)
	Makes the Enum class loggable and streamable. More...
template<class T >
std::istream &	Arp::operator>> (std::istream &is, Enum< T > &value)
	Makes the Enum class parsable. More...
template<class T >
Enum< T >	Arp::operator| (Enum< T > lhs, Enum< T > rhs)
	Bitwise Or operator for class Enum. More...
template<class T >
Enum< T >	Arp::operator& (Enum< T > lhs, Enum< T > rhs)
	Bitwise And operator for class Enum. More...
template<class T >
bool	Arp::operator== (Enum< T > lhs, Enum< T > rhs)
	Equality operator of class Enum. More...
template<class T >
bool	Arp::operator< (Enum< T > lhs, Enum< T > rhs)
	Less operator for class Enum. More...
template<class T >
bool	Arp::operator> (Enum< T > lhs, Enum< T > rhs)
	Greater operator for class Enum. More...
template<class T >
bool	Arp::operator<= (Enum< T > lhs, Enum< T > rhs)
	Less or equal operator for class Enum. More...
template<class T >
bool	Arp::operator>= (Enum< T > lhs, Enum< T > rhs)
	Greater or equal operator for class Enum. More...
template<class T >
bool	Arp::operator== (Enum< T > lhs, T rhs)
	Equality operator of class Enum. More...
template<class T >
bool	Arp::operator< (Enum< T > lhs, T rhs)
	Less operator for class Enum. More...
template<class T >
bool	Arp::operator> (Enum< T > lhs, T rhs)
	Greater operator for class Enum. More...
template<class T >
bool	Arp::operator<= (Enum< T > lhs, T rhs)
	Less or equal operator for class Enum. More...
template<class T >
bool	Arp::operator>= (Enum< T > lhs, T rhs)
	Greater or equal operator for class Enum. More...
template<class T >
bool	Arp::operator== (T lhs, Enum< T > rhs)
	Equality operator of class Enum. More...
template<class T >
bool	Arp::operator< (T lhs, Enum< T > rhs)
	Less operator for class Enum. More...
template<class T >
bool	Arp::operator> (T lhs, Enum< T > rhs)
	Greater operator for class Enum. More...
template<class T >
bool	Arp::operator<= (T lhs, Enum< T > rhs)
	Less or equal operator for class Enum. More...
template<class T >
bool	Arp::operator>= (T lhs, Enum< T > rhs)
	Greater or equal operator for class Enum. More...
	Arp::Enum< T >::Enum (Value val=Zero)
	Constructs an instace of Enum with the given value. More...
Enum &	Arp::Enum< T >::operator= (Value rhs)
	The assignment operator for a value of the adapted type. More...
	Arp::Enum< T >::operator T (void) const
	Converts this instance implicitely to the value of its adapted type More...
Enum &	Arp::Enum< T >::operator&= (Enum rhs)
	The assignment AND operator. More...
Enum &	Arp::Enum< T >::operator|= (Enum rhs)
	The assignment OR operator. More...
T	Arp::Enum< T >::GetValue (void) const
U	Arp::Enum< T >::ToUnderlyingType (void) const
	Converts this instance to the underlying type of its adapted enum type More...
String	Arp::Enum< T >::ToString (bool throwIfInvalid=true) const
	Converts this instance to its string representation. More...
static bool	Arp::Enum< T >::TryParse (const String &input, T &result)
	Tries to parse the given input string. More...
static bool	Arp::Enum< T >::TryParse (const String &input, Enum &result)
	Tries to parse the given input string. More...
static bool	Arp::Enum< T >::TryParse (const char *input, T &result)
	Tries to parse the given input string. More...
static bool	Arp::Enum< T >::TryParse (const char *input, Enum &result)
	Tries to parse the given input string. More...
static Enum	Arp::Enum< T >::Parse (const String &input)
	Parses the given input string. More...
static Enum	Arp::Enum< T >::Parse (const char *input)
	Parses the given input string. More...

Detailed Description

Function Documentation

Enum()

template<class T >

Arp::Enum< T >::Enum ( Value  val = Zero )

inline

Constructs an instace of Enum with the given value.

Parameters

value

The enum value to initialize this instance with.

make_enum()

template<class T >

Enum<T> Arp::make_enum

(

T

value

)

Global make function to adapt any enum class by class Enum.

Parameters

value

The enum value to adapt by class Enum.

Template Parameters

T	The enum type to adapt by class Enum.

Returns

The new created enum adapter of type Enum.

operator T()

template<class T >

Arp::Enum< T >::operator T ( void  ) const

inline

Converts this instance implicitely to the value of its adapted type

operator&()

template<class T >

Enum<T> Arp::operator& ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Bitwise And operator for class Enum.

Parameters

lhs	The left argument to combine bitwise.
rhs	The right argument to combine bitwise.

Returns

The bitwise And combination of the arguments.

operator&=()

template<class T >

Enum< T > & Arp::Enum< T >::operator&= ( Enum< T >  rhs )

inline

The assignment AND operator.

Parameters

rhs	The value to AND to this instance.

Returns

This instance as reference.

operator<() [1/3]

template<class T >

bool Arp::operator< ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Less operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is less than the right argument, otherwise false.

operator<() [2/3]

template<class T >

bool Arp::operator< ( Enum< T >  lhs, T  rhs  )

inline

Less operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is less than the right argument, otherwise false.

operator<() [3/3]

template<class T >

bool Arp::operator< ( T  lhs, Enum< T >  rhs  )

inline

Less operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is less than the right argument, otherwise false.

operator<<()

template<class T >

std::ostream& Arp::operator<< ( std::ostream &  os, Enum< T >  value  )

inline

Makes the Enum class loggable and streamable.

Parameters

os	The stream to write the typename to.
value	The enum value to write.

Returns

The as argument passed stream.

operator<=() [1/3]

template<class T >

bool Arp::operator<= ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Less or equal operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is less or equal than the right argument, otherwise false.

operator<=() [2/3]

template<class T >

bool Arp::operator<= ( Enum< T >  lhs, T  rhs  )

inline

Less or equal operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is less or equal than the right argument, otherwise false.

operator<=() [3/3]

template<class T >

bool Arp::operator<= ( T  lhs, Enum< T >  rhs  )

inline

Less or equal operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is less or equal than the right argument, otherwise false.

operator=()

template<class T >

Enum< T > & Arp::Enum< T >::operator= ( Value  rhs )

inline

The assignment operator for a value of the adapted type.

Parameters

rhs	The value to assign to this instance.

Returns

This instance as reference.

operator==() [1/3]

template<class T >

bool Arp::operator== ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Equality operator of class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the arguments are equal, otherwise false.

operator==() [2/3]

template<class T >

bool Arp::operator== ( Enum< T >  lhs, T  rhs  )

inline

Equality operator of class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the arguments are equal, otherwise false.

operator==() [3/3]

template<class T >

bool Arp::operator== ( T  lhs, Enum< T >  rhs  )

inline

Equality operator of class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the arguments are equal, otherwise false.

operator>() [1/3]

template<class T >

bool Arp::operator> ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Greater operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is greater than the right argument, otherwise false.

operator>() [2/3]

template<class T >

bool Arp::operator> ( Enum< T >  lhs, T  rhs  )

inline

Greater operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is greater than the right argument, otherwise false.

operator>() [3/3]

template<class T >

bool Arp::operator> ( T  lhs, Enum< T >  rhs  )

inline

Greater operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is greater than the right argument, otherwise false.

operator>=() [1/3]

template<class T >

bool Arp::operator>= ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Greater or equal operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is greater or equal than the right argument, otherwise false.

operator>=() [2/3]

template<class T >

bool Arp::operator>= ( Enum< T >  lhs, T  rhs  )

inline

Greater or equal operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is greater or equal than the right argument, otherwise false.

operator>=() [3/3]

template<class T >

bool Arp::operator>= ( T  lhs, Enum< T >  rhs  )

inline

Greater or equal operator for class Enum.

Parameters

lhs	The left argument to compare.
rhs	The right argument to compare.

Returns

true if the left argument is greater or equal than the right argument, otherwise false.

operator>>()

template<class T >

std::istream& Arp::operator>> ( std::istream &  is, Enum< T > &  value  )

inline

Makes the Enum class parsable.

Parameters

os	The stream to read the value from.
value	The resulting enum value.

Returns

The as argument passed stream.

operator|()

template<class T >

Enum<T> Arp::operator| ( Enum< T >  lhs, Enum< T >  rhs  )

inline

Bitwise Or operator for class Enum.

Parameters

lhs	The left argument to combine bitwise.
rhs	The right argument to combine bitwise.

Returns

The bitwise Or combination of the arguments.

operator|=()

template<class T >

Enum< T > & Arp::Enum< T >::operator|= ( Enum< T >  rhs )

inline

The assignment OR operator.

Parameters

rhs	The value to OR to this instance.

Returns

This instance as reference.

Parse() [1/2]

template<class T >

Enum< T > Arp::Enum< T >::Parse ( const char *  input )

inlinestatic

Parses the given input string.

Parameters

input

The input string to parse.

Returns

The resulting Enum value.

Exceptions

Exception

If the input string is not a valid enum entry.

Parse() [2/2]

template<class T >

Enum< T > Arp::Enum< T >::Parse ( const String &  input )

inlinestatic

Parses the given input string.

Parameters

input

The input string to parse.

Returns

The resulting Enum value.

Exceptions

Exception

If the input string is not a valid enum entry.

ToString()

template<class T >

String Arp::Enum< T >::ToString ( bool  throwIfInvalid = true ) const

inline

Converts this instance to its string representation.

Parameters

throwIfInvalid

If true an exception is thrown if the enum value is invalid, otherwise the number is converted to string.

Returns

The string literal of this enum value.

ToUnderlyingType()

template<class T >

Enum< T >::U Arp::Enum< T >::ToUnderlyingType ( void  ) const

inline

Converts this instance to the underlying type of its adapted enum type

Returns

The enum value as integral type.

TryParse() [1/4]

template<class T >

bool Arp::Enum< T >::TryParse ( const char *  input, Enum< T > &  result  )

inlinestatic

Tries to parse the given input string.

Parameters

input	The input string to parse.
result	The resulting Enum.

Returns

true on success, otherwise false.

TryParse() [2/4]

template<class T >

bool Arp::Enum< T >::TryParse ( const char *  input, T &  result  )

inlinestatic

Tries to parse the given input string.

Parameters

input	The input string to parse.
result	The resulting enum value.

Returns

true on success, otherwise false.

TryParse() [3/4]

template<class T >

bool Arp::Enum< T >::TryParse ( const String &  input, Enum< T > &  result  )

inlinestatic

Tries to parse the given input string.

Parameters

input	The input string to parse.
result	The resulting Enum.

Returns

true on success, otherwise false.

TryParse() [4/4]

template<class T >

bool Arp::Enum< T >::TryParse ( const String &  input, T &  result  )

inlinestatic

Tries to parse the given input string.

Parameters

input	The input string to parse.
result	The resulting enum value.

Returns

true on success, otherwise false.