DRAMA C++ Intro   Class Hierarchy   Alphabetical List of types   List of Classes   File List   Class Member Index   File Members Index   Related Pages  

GitTpl::EnumLookupClass Class Reference

#include <gittpl.h>

List of all members.


Detailed Description

A virtual base class for the lookup class template arguments to GitTpl::Enum.

The use should implement a class based on this class to provide information required by GitTpl::Enum.


Public Methods

virtual unsigned int GetMaxValue () const=0
 This function should return the maximum normal value of the enumerated value.

virtual const char ** GetStringArray () const=0
 Return a pointer to an array of enum strings equivalents.

virtual ~EnumLookupClass ()
 Destructor.


Constructor & Destructor Documentation

virtual GitTpl::EnumLookupClass::~EnumLookupClass   [inline, virtual]
 

Destructor.


Member Function Documentation

virtual unsigned int GitTpl::EnumLookupClass::GetMaxValue   [pure virtual]
 

This function should return the maximum normal value of the enumerated value.

The enumerated value should have the range 0 through to the value returned by this function.

Returns:
The maximum normal value of the enum.

virtual const char** GitTpl::EnumLookupClass::GetStringArray   [pure virtual]
 

Return a pointer to an array of enum strings equivalents.

The integer index of the string in this array is passed to GitEnum::SetValue when the value is set

Returns:
a pointer to a array of pointer to char, which is a character array to be passed to GitArgGetS(). This array contains the list of strings to be accepted with a terminating null.


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

Click here for the DRAMA home page and here for the AAO home page.

For more information, contact tjf@aaoepp.aao.gov.au 

Generated on Tue Nov 3 09:09:56 2009 for AAO DRAMA C++ Interfaces by doxygen 1.2.18