geotess::EnumType Class Reference

#include <EnumType.h>

Inheritance diagram for geotess::EnumType:

List of all members.

Public Member Functions
virtual	~EnumType ()
string	name () const
int	ordinal () const
string	toString () const
Protected Member Functions
	EnumType ()
	EnumType (const EnumType &et)
	EnumType (const string &name, int ordinal)
EnumType &	operator= (const EnumType &et)
Static Protected Member Functions
static const EnumType *	valueOf (const string &s, EnumType const *const *const array, int n)
Protected Attributes
const string	aName
const int	aOrdinal
Friends
bool	operator!= (const EnumType &x, const EnumType &y)
bool	operator== (const EnumType &x, const EnumType &y)

---

Detailed Description

The base class for all "enum" types. Contains the name string and ordinal of the enum and functions to return those attributes. Also defines operator overloads for equality (==) and non-equality (!=).

---

Constructor & Destructor Documentation

geotess::EnumType::EnumType

(

)

[inline, protected]

Private default constructor. Not used.

geotess::EnumType::EnumType

(

const EnumType &

et

)

[inline, protected]

Private copy constructor. Not used.

geotess::EnumType::EnumType	(	const string &	name,
		int	ordinal
	)		[inline, protected]

Standard constuctor. Protected so that only derived types (public enums) which inherit this object can actually create one.

virtual geotess::EnumType::~EnumType

(

)

[inline, virtual]

Standard destructor.

---

Member Function Documentation

string geotess::EnumType::name

(

)

const [inline]

Returns this Enums name.

EnumType& geotess::EnumType::operator=

(

const EnumType &

et

)

[inline, protected]

Private assignment operator. Not used.

int geotess::EnumType::ordinal

(

)

const [inline]

Returns this Enums ordinal.

string geotess::EnumType::toString

(

)

const [inline]

Returns this Enums name.

static const EnumType* geotess::EnumType::valueOf	(	const string &	s,
		EnumType const *const *const	array,
		int	n
	)		[static, protected]

Returns the EnumType from the input array whose name matches the input string. Null is returned if no match is found.

Parameters:

s	The input string for which a match in array is returned (or null).
array	The array from which a match for s will be sought.
n	The size of the input array.

Returns:

The match of s in the names of array or null if one was not found.

---

Friends And Related Function Documentation

bool operator!=	(	const EnumType &	x,
		const EnumType &	y
	)		[friend]

Not equals operator.

bool operator==	(	const EnumType &	x,
		const EnumType &	y
	)		[friend]

Equals operator.

---

Member Data Documentation

const string geotess::EnumType::aName [protected]

The string name of this enum.

const int geotess::EnumType::aOrdinal [protected]

The ordinal of this enum.

---

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

• include/EnumType.h