AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code
Public Types | Public Member Functions | Protected Member Functions | List of all members
GitEnum Class Referenceabstract

A class which reads Enumerated values from a SDS argument structures. More...

#include <Git.h>

Inheritance diagram for GitEnum:
Git GitResetType

Public Types

enum  {
  Upper =GIT_M_ARG_UPPER , Lower =GIT_M_ARG_LOWER , KeepErr =GIT_M_ARG_KEEPERR , Abbrev = GIT_M_ARG_ABBREV ,
  LastBit =GIT_M_ARG_LASTBIT , KeepValErr =GIT_M_ARG_KEEPVALERR
}
 

Public Member Functions

virtual ~GitEnum ()
 Destructor.
 
void Get (const SdsId &Id, const char *const Name, const int Position, StatusType *status, const char *Default=0, const int Flags=Git::Upper|Git::Abbrev)
 Get the value of the object from an SDS struture.
 

Protected Member Functions

virtual const char *const * Lookup ()=0
 Return a pointer to an array of enum strings equivalents.
 
virtual void SetValue (const unsigned int)=0
 Set the value of the object.
 

Detailed Description

A class which reads Enumerated values from a SDS argument structures.

This is an abstract class used for cases where we want to fetch a STRING action argument which must then be converted to an enum type.

This is a virtual class - the user must provide a class which inherits this class and provides an implementation of the GitEnum::SetValue and GitEnum::Lookup functions.

See also
GitArgGetS()

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