Class to be used as a enum variable with text representations. More...

#include <FFaEnum.H>

Public Member Functions
	FFaEnum (EnumType val=EnumType(0))
	Default constructor. More...

	FFaEnum (const char *val)
	Constructor obtaining its value from a string. More...

FFaEnum< EnumType, ETMapping > &	operator= (const FFaEnum< EnumType, ETMapping > &val)
	Assignment operator. More...

FFaEnum< EnumType, ETMapping > &	operator= (const EnumType &val)
	Overloaded assignment operator. More...

FFaEnum< EnumType, ETMapping > &	operator= (const int &val)
	Overloaded assignment operator. More...

FFaEnum< EnumType, ETMapping > &	operator= (const char *text)
	Overloaded assignment operator. More...

	operator EnumType () const
	Returns the actual enum value. More...

const char *	getText () const
	Returns the text representation of the enum value. More...

bool	operator== (const FFaEnum< EnumType, ETMapping > &e) const
	Equality operator. More...

bool	operator== (const EnumType &e) const
	Overloaded equality operator. More...

bool	operator!= (const FFaEnum< EnumType, ETMapping > &e) const
	Unequality operator. More...

bool	operator!= (const EnumType &e) const
	Overloaded unequality operator. More...

Private Attributes
EnumType	myValue
	The actual enum value. More...

Detailed Description

template<class EnumType, class ETMapping>
class FFaEnum< EnumType, ETMapping >

Class to be used as a enum variable with text representations.

The class contains stream operators for input and output as text, and overloaded assignment operators such that its value can be assigned also from the text representation.

Usage:

class ClassWithEnum
{
public:
  ClassWithEnum() {}
 
  enum SomeEnumType {
    AONE,
    ATWO,
    ATHREE
  };
 
  FFaEnumMapping(SomeEnumType) {
    FFaEnumEntry(AONE,  "AONE");
    FFaEnumEntry(ATWO,  "ATWO");
    FFaEnumEntry(ATHREE,"ATHREE");
    FFaEnumEntryEnd;
  };
 
  // Use either as a normal enum:
  FFaEnum<SomeEnumType,SomeEnumTypeMapping> myEnum;
  // Or within a field:
  FFaField<SomeEnumTypeEnum> myEnumField;
};

As you can see, the initialization of the text to enum mappings are to be set up using the macros FFaEnumMapping(), FFaEnumEntry() and FFaEnumEntryEnd(). The FFaEnum class supports all kinds of assigning, so it can be used as a normal enum variable.

...
ClassWithEnum::ClassWithEnum()
{
  ...
  FFA_FIELD_INIT(myEnumField, AONE, "ENUM_FIELD_NAME");
  ...
}
...
ClassWithEnum a;
a.myEnum = ClassWithEnum::ATHREE;
ClassWithEnum b;
b.myEnum = a.myEnum;
a.myEnum = "ATWO";
ClassWithEnum::SomeEnumType en = a.myEnum;
int v = a.myEnum;
std::cout << a.myEnum << std::endl;
std::cin >> a.myEnum;
 
if (b.myEnum == a.myEnum) std::cout <<"a and b are equal\n";
if (b.myEnum != a.myEnum) std::cout <<"a and b are not equal\n";