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
GitInt Class Reference

A class which reads integer values from an SDS argument structure. More...

#include <Git.h>

Inheritance diagram for GitInt:
Git GitTpl::Int< MinVal, MaxVal, DefaultVal >

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

 GitInt (const long int def=0)
 Simple constructor with a default value specified.
 
 GitInt (const SdsId &Id, const char *const Name, const int Position, StatusType *const status, const long int Default=0, const int Flags=0)
 Constructor with the initial value set from an SDS structure.
 
virtual ~GitInt ()
 Destructor.
 
virtual void Get (const SdsId &Id, const char *const Name, const int Position, StatusType *const status, const long int Default=0, const int Flags=0)
 Get the value of the object from an SDS struture.
 
 operator long int () const
 Conversion operator - given GitInt, return a long int.
 

Protected Member Functions

virtual const long int * Range ()
 Function which returns sets the range.
 

Detailed Description

A class which reads integer values from an SDS argument structure.

A C++ class which provides an interface to GitArgGetI(). It Implements a int type which includes the operation Get, to fetch its value from an SDS structure. There is also a constructor which does the Get operation.

By overriding the function Range in a sub-class class, you can supply range limits for the value. (BUT THIS ONLY WORKS IF YOU DO AN EXPLICT Get(), not when using the constructor implicit Get(). This is because the constructor of the base class can't invoke a method in a sub-class even when virtual (C++ standard).

See also
GitArgGetI()

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