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

Detailed Description

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

Note that 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. In these cases, the template range arguments are ignored.

See also

GitArgGetI()

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
	Int (const long def=DefaultVal)
	Simple constructor with a default value specified.
	Int (const sds::Id &Id, const long Min, const long Max, const std::string &Name="Argument1", const int Position=1, const long Default=DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which contructs the value from an item in an SDS structure.
	Int (const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const long Default=DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which contructs the value from an item in an SDS structure.
	Int (drama::thread::TAction *taction, const sds::Id &Id, const long Min, const long Max, const std::string &Name="Argument1", const int Position=1, const long Default=DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which contructs the value from an item in an SDS structure.
	Int (drama::thread::TAction *taction, const sds::Id &Id, const std::string &Name="Argument1", const int Position=1, const long Default=DefaultVal, const Flags flags=Flags::KeepErr)
	Constructor which contructs the value from an item in an SDS structure.
virtual void	Get (const sds::Id &Id, const long Min, const long Max, const std::string &Name="Argument1", const int Position=1, const long int Default=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 long int Default=DefaultVal, const Flags flags=Flags::KeepErr)
	Get the value of the object from an SDS structure.
	operator long int () const
	Conversion operator - given git::Int, return a long int.

---

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

• gitarg.hh