slifis::INPUT_RANGE Class Reference

A range of numerical values, used to iterate from minimum to maximum value using a number of steps. More...

#include <input_range.hpp>

Collaboration diagram for slifis::INPUT_RANGE:

List of all members.

Public Member Functions
	INPUT_RANGE (std::string name, double vmin, double vmax, size_t nb_steps)
	constructor
double	GetCurrentValue ()
	returns current value and increments it with the step
void	Init ()
	Initialises the struct, so it can be re-used.
size_t	GetNbSteps () const
const std::string &	GetName () const
Private Attributes
std::string	_name
double	_vmax
double	_vmin
size_t	_NbSteps
double	_current_value
size_t	_Count
double	_Step

---

Detailed Description

A range of numerical values, used to iterate from minimum to maximum value using a number of steps.

Used in SLIFIS::Generate3DPlot()

---

Constructor & Destructor Documentation

slifis::INPUT_RANGE::INPUT_RANGE	(	std::string	name,
		double	vmin,
		double	vmax,
		size_t	nb_steps
	)		[inline]

constructor

References __IN__, __OUT__, slifis::ERR_BAD_VALUES, Init(), and SLIFIS_ERROR_2.

---

Member Function Documentation

double slifis::INPUT_RANGE::GetCurrentValue

(

)

[inline]

returns current value and increments it with the step

References __IN__, __OUT__, _Count, _current_value, _NbSteps, _Step, slifis::ERR_UNKNOWN, SLIFIS_ERROR_2, and SLIFIS_ERROR_LOG.

Referenced by slifis::SLIFIS::Generate3DPlot().

void slifis::INPUT_RANGE::Init

(

)

[inline]

Initialises the struct, so it can be re-used.

References _Count, _current_value, _NbSteps, _Step, _vmax, and _vmin.

Referenced by slifis::SLIFIS::Generate3DPlot(), and INPUT_RANGE().

size_t slifis::INPUT_RANGE::GetNbSteps

(

)

const [inline]

References _NbSteps.

Referenced by slifis::SLIFIS::Generate3DPlot().

const std::string & slifis::INPUT_RANGE::GetName

(

)

const [inline]

References _name.

Referenced by slifis::SLIFIS::Generate3DPlot().

---

Member Data Documentation

std::string slifis::INPUT_RANGE::_name [private]

Referenced by GetName().

double slifis::INPUT_RANGE::_vmax [private]

Referenced by Init().

double slifis::INPUT_RANGE::_vmin [private]

Referenced by Init().

size_t slifis::INPUT_RANGE::_NbSteps [private]

Referenced by GetCurrentValue(), GetNbSteps(), and Init().

double slifis::INPUT_RANGE::_current_value [private]

Referenced by GetCurrentValue(), and Init().

size_t slifis::INPUT_RANGE::_Count [private]

Referenced by GetCurrentValue(), and Init().

double slifis::INPUT_RANGE::_Step [private]

Referenced by GetCurrentValue(), and Init().