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

GitTpl::Int< MinVal, MaxVal, DefaultVal > Class Template Reference

#include <gittpl.h>

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

GitInt Git List of all members.

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.


Public Methods

 Int (const long def=DefaultVal)
 Simple constructor with a default value specified.

 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.


Constructor & Destructor Documentation

template<long int MinVal = LONG_MIN, long int MaxVal = LONG_MAX, long int DefaultVal = 0>
GitTpl::Int< MinVal, MaxVal, DefaultVal >::Int const long    def = DefaultVal [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>
GitTpl::Int< MinVal, MaxVal, DefaultVal >::Int const SdsId   Id,
const char *const    Name,
const int    Position,
StatusType *const    status,
const long    Default = DefaultVal,
const int    Flags = Git::KeepErr
[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.


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