A class which reads real values from an SDS argument structure. More...
#include <gittpl.h>
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 | |
| Real (const double def=(double) DefaultVal) | |
| Simple constructor with a default value specified. | |
| Real (const SdsId &Id, const char *const Name, const int Position, StatusType *const status, const double Default=(double) DefaultVal, const int Flags=Git::KeepErr) | |
| Constructor with the initial value set from an SDS structure. | |
| virtual void | Get (const SdsId &Id, const char *const Name, const int Position, StatusType *const status, const double Default=0.0, const int Flags=0) |
| Get the value of the object from an SDS struture. | |
| operator double () const | |
| Conversion operators - given GitReal, return a double. | |
| operator float () const | |
| Conversion operators - given GitReal, return a float. | |
Detailed Description
class GitTpl::Real< MinVal, MaxVal, DefaultVal >
A class which reads real values from an SDS argument structure.
A C++ class which provides an interface to GitArgGetD() . It Implements a double type which includes the operation Get, to fetch its value from an SDS structure. There is also a constructor which does the Get operation.
This class inherits GitReal and uses template arguments to specify the range.
It should be noted that as templates don't access double arguments, the template parameters which specify the range must be long ints, limiting the range you can use. If you need a greater range or non-integer range limits, you must use GitReal directly, but in many cases this verison will probably suffice.
- See also
- GitArgGetD()
- Parameters
-
MinValue The minimum value acceptable in a Get operation. MaxValue The maximum value acceptable in a Get operation. DefaultVal The default value for the item. This is NOT validated against the range and hence can be used to set it to a identifible particular value, if desired. Defaults to zero.
The documentation for this class was generated from the following file:
