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

GitReal Class Reference

#include <Git.h>

Inheritance diagram for GitReal:

Git GitTpl::Real< MinVal, MaxVal, DefaultVal > List of all members.

Detailed Description

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.

By overriding the function Range in an inheriting class, you can supply range limits for the value.

See also:
GitArgGetD()


Public Methods

 GitReal (const double def=0.0)
 Simple constructor with a default value specified.

 GitReal (const SdsId &Id, const char *const Name, const int Position, StatusType *const status, const double Default=0.0, const int Flags=0)
 Constructor with the initial value set from an SDS structure.

virtual ~GitReal ()
 Destructor.

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.


Protected Methods

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


Constructor & Destructor Documentation

GitReal::GitReal const double    def = 0.0 [inline]
 

Simple constructor with a default value specified.

Parameters:
def  The default value to use.

GitReal::GitReal const SdsId   Id,
const char *const    Name,
const int    Position,
StatusType *const    status,
const double    Default = 0.0,
const int    Flags = 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.
Flags  Which GIT Flags to apply

virtual GitReal::~GitReal   [inline, virtual]
 

Destructor.


Member Function Documentation

virtual void GitReal::Get const SdsId   Id,
const char *const    Name,
const int    Position,
StatusType *const    status,
const double    Default = 0.0,
const int    Flags = 0
[inline, virtual]
 

Get the value of the object from an SDS struture.

This is the function which is used to set the value of the object. It is passed an SDS structure and looks for the item within that 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.
Flags  Which GIT Flags to apply

GitReal::operator double   const [inline]
 

Conversion operators - given GitReal, return a double.

GitReal::operator float   const [inline]
 

Conversion operators - given GitReal, return a float.

virtual const double* GitReal::Range   [inline, protected, virtual]
 

Function which returns sets the range.

This method can be overriden by inherited to set the range. If not overriden, then any value is ok.

Returns:
The address of a two element array of double. The first element contains the minimum and the second the maximum.


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