drama::gitarg::Real< MinVal, MaxVal, DefaultVal > Class Template Reference

Detailed Description

template<long int MinVal, long int MaxVal, long int DefaultVal = 0>
class drama::gitarg::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 method Get(), to fetch its value from an SDS structure. There is also a constructor which does the Get operation.

It should be noted that as templates don't allow double arguments, the template parameters which specify the range must be long ints, limiting the range you can use to that of long ints. If you need a greater range or non-integer range limits, there are overrides of the constructors and Get() methods which allow you to specify ranges at that point, and which are also useful if the ranges change.

See also

GitArgGetD()

Template Parameters

MinValue	The minimum value acceptable in a the Get() overload which does not have a range specification.
MaxValue	The maximum value acceptable in a the Get() overload which does not have a range specification.
DefaultVal	The default value for the item. This is NOT validated against the range and hence can be used to set it to a identifiable particular value, if desired. Defaults to zero.

#include "gitarg.hh"

Public Member Functions
	Real (const double def=(double) DefaultVal)
	Simple constructor with a default value specified.
	Real (const sds::Id &Id, const double Min, const double Max, const std::string &Name="Argument1", const int Position=1, const double Default=(double) DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which constructs the value from an item in an SDS structure.
	Real (const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const double Default=(double) DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which constructs the value from an item in an SDS structure.
	Real (drama::thread::TAction *taction, const sds::Id &Id, const double Min, const double Max, const std::string &Name="Argument1", const int Position=1, const double Default=(double) DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which constructs the value from an item in an SDS structure, for use in a threaded action.
	Real (drama::thread::TAction *taction, const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const double Default=(double) DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which constructs the value from an item in an SDS structure, for use in a threaded action.
virtual void	Get (const sds::Id &Id, const double Min, const double Max, const std::string &Name="Argument1", const int Position=1, const double Default=(double)(DefaultVal), const Flags flags=Flags::KeepErr)
	Get the value of the object from an SDS structure.
virtual void	Get (const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const double Default=(double)(DefaultVal), const Flags flags=Flags::KeepErr)
	Get the value of the object from an SDS structure.
	operator double () const
	Conversion operators - given git:Real, return a double.

---

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

• gitarg.hh