GeoTessCPP  2.2
Software to facilitate storage and retrieval of 3D information about the Earth.
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
geotess::GeoTessEnumType Class Reference

The base class for all "enum" types. More...

#include <GeoTessEnumType.h>

Inheritance diagram for geotess::GeoTessEnumType:
geotess::GeoTessDataType geotess::GeoTessInterpolatorType geotess::GeoTessOptimizationType geotess::GeoTessProfileType

Public Member Functions

virtual ~GeoTessEnumType ()
 Standard destructor. More...
 
string name () const
 Returns this Enums name. More...
 
int ordinal () const
 Returns this Enums ordinal. More...
 
string toString () const
 Returns this Enums name. More...
 

Protected Member Functions

 GeoTessEnumType ()
 Private default constructor. More...
 
 GeoTessEnumType (const GeoTessEnumType &et)
 Private copy constructor. More...
 
 GeoTessEnumType (const string &name, int ordinal)
 Standard constuctor. More...
 
GeoTessEnumTypeoperator= (const GeoTessEnumType &et)
 Private assignment operator. More...
 

Static Protected Member Functions

static const GeoTessEnumTypevalueOf (const string &s, GeoTessEnumType const *const *const array, int n)
 Returns the EnumType from the input array whose name matches the input string. More...
 

Protected Attributes

const string aName
 The string name of this enum. More...
 
const int aOrdinal
 The ordinal of this enum. More...
 

Friends

bool operator!= (const GeoTessEnumType &x, const GeoTessEnumType &y)
 Not equals operator. More...
 
bool operator== (const GeoTessEnumType &x, const GeoTessEnumType &y)
 Equals operator. More...
 

Detailed Description

The base class for all "enum" types.

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::GeoTessEnumType::GeoTessEnumType ( )
inlineprotected

Private default constructor.

Not used.

geotess::GeoTessEnumType::GeoTessEnumType ( const GeoTessEnumType et)
inlineprotected

Private copy constructor.

Not used.

geotess::GeoTessEnumType::GeoTessEnumType ( const string &  name,
int  ordinal 
)
inlineprotected

Standard constuctor.

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

virtual geotess::GeoTessEnumType::~GeoTessEnumType ( )
inlinevirtual

Standard destructor.

Member Function Documentation

string geotess::GeoTessEnumType::name ( ) const
inline

Returns this Enums name.

GeoTessEnumType& geotess::GeoTessEnumType::operator= ( const GeoTessEnumType et)
inlineprotected

Private assignment operator.

Not used.

int geotess::GeoTessEnumType::ordinal ( ) const
inline

Returns this Enums ordinal.

string geotess::GeoTessEnumType::toString ( ) const
inline

Returns this Enums name.

static const GeoTessEnumType* geotess::GeoTessEnumType::valueOf ( const string &  s,
GeoTessEnumType const *const *const  array,
int  n 
)
staticprotected

Returns the EnumType from the input array whose name matches the input string.

Null is returned if no match is found.

Parameters
sThe input string for which a match in array is returned (or null).
arrayThe array from which a match for s will be sought.
nThe 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 GeoTessEnumType x,
const GeoTessEnumType y 
)
friend

Not equals operator.

bool operator== ( const GeoTessEnumType x,
const GeoTessEnumType y 
)
friend

Equals operator.

Member Data Documentation

const string geotess::GeoTessEnumType::aName
protected

The string name of this enum.

const int geotess::GeoTessEnumType::aOrdinal
protected

The ordinal of this enum.


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