A class which reads integer values from an SDS argument structure. More...
#include <gittpl.h>
Inheritance diagram for GitTpl::Int< MinVal, MaxVal, DefaultVal >:
Public Member Functions | |
| Int (const long def=DefaultVal) | |
| Simple constructor with a default value specified. More... | |
| Int (const SdsId &Id, const char *const Name, const int Position, StatusType *const status, const long Default=DefaultVal, const int Flags=Git::KeepErr) | |
| Constructor with the initial value set from an SDS structure. More... | |
 Public Member Functions inherited from GitInt | |
| GitInt (const long int def=0) | |
| Simple constructor with a default value specified. More... | |
| 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. More... | |
| virtual | ~GitInt () |
| Destructor. More... | |
| 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. More... | |
| operator long int () const | |
| Conversion operator - given GitInt, return a long int. More... | |
Additional Inherited Members | |
| Public Types inherited from Git | |
| enum | { Upper =GIT_M_ARG_UPPER, Lower =GIT_M_ARG_UPPER, KeepErr =GIT_M_ARG_KEEPERR, Abbrev = GIT_M_ARG_ABBREV, LastBit =GIT_M_ARG_LASTBIT } |
Detailed Description
template<long int MinVal = LONG_MIN, long int MaxVal = LONG_MAX, long int DefaultVal = 0>
class GitTpl::Int< MinVal, MaxVal, DefaultVal >
A class which reads integer values from an SDS argument structure.
A C++ class which provides an interface to GitArgGetI() . It Implements an integer 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 GitInt and uses template arguments to specify the range.
- See also
- GitArgGetI()
- Parameters
-
MinValue The minimum value acceptable in a Get operation. Default is LONG_MIN (from limits.h) MaxValue The maximum value acceptable in a Get operation. Default is LONG_MAX (from limits.h) 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.
Constructor & Destructor Documentation
template<long int MinVal = LONG_MIN, long int MaxVal = LONG_MAX, long int DefaultVal = 0>
|
inline |
Simple constructor with a default value specified.
- Parameters
-
def The default value to use. If not specified, uses "DefaultVal".
template<long int MinVal = LONG_MIN, long int MaxVal = LONG_MAX, long int DefaultVal = 0>
|
inline |
Constructor with the initial value set from an SDS structure.
- Parameters
-
Id The SDS structure. Name The name of the item within the structure. Position If the item does not exist by the name, then presume this position. status Inherited status Default The default value. If not specified, uses "DefaultVal". Flags Which GIT Flags to apply. If not specified, uses Git::KeepErr.
References GitInt::Get().
The documentation for this class was generated from the following file:
