ito::AutoInterval Class Reference

class for a interval type containing a min-max-range and an auto-flag. More...

#include <interval.h>

Public Member Functions
	AutoInterval ()
	default constructor: auto-mode: true, min=-Inf, max=+Inf
	AutoInterval (double min, double max, bool autoInterval=false)
	constructor
virtual	~AutoInterval ()
	destructor *‍/
double	minimum () const
	return the minimum value of the interval (included)
double	maximum () const
	return the maximum value of the interval (included)
double &	rmin ()
	return a reference to the minimum value of the interval. Assigning a float to this reference will change the minimum in the interval.
double &	rmax ()
	return a reference to the maximum value of the interval. Assigning a float to this reference will change the maximum in the interval.
bool	isAuto () const
	return the state of the auto-flag as boolean variable
bool &	rauto ()
	return the reference to the auto-flag. Assigning a boolean to this reference will change the auto-flag.
void	setRange (double min, double max)
	set the boundary values of the AutoInterval without changing the auto flag
void	setMinimum (double min)
	change the included minimum value
void	setMaximum (double max)
	change the included maximum value
void	setAuto (bool autoInterval)
	set the auto-flag to a given boolean value
bool	operator== (const AutoInterval &) const
	comparison operator between the AutoInterval and another AutoInterval.
bool	operator!= (const AutoInterval &) const
	comparison operator between the AutoInterval and another AutoInterval.

Private Attributes
double	m_min
double	m_max
bool	m_auto

Detailed Description

class for a interval type containing a min-max-range and an auto-flag.

This class can be used as datatype if you want to provide a range- or interval-object that contains of two float min and max boundaries as well as an auto-flag. If auto is set, the min and max boundaries can be calculated by an automatic mode within your code.

Constructor & Destructor Documentation

AutoInterval()

ito::AutoInterval::AutoInterval	(	double	min,
		double	max,
		bool	autoInterval = false )

constructor

Parameters

min	is the included minimum value
max	is the included maximum value
autoInterval	is the state of auto-flag.

Member Function Documentation

operator!=()

bool ito::AutoInterval::operator!=

(

const AutoInterval &

other

)

const

comparison operator between the AutoInterval and another AutoInterval.

Parameters

rhs	is the AutoInterval that is compared to this one.

Returns

false if both AutoInterval instances have the auto-flag set or if both boundaries are equal.

operator==()

bool ito::AutoInterval::operator==

(

const AutoInterval &

other

)

const

comparison operator between the AutoInterval and another AutoInterval.

Parameters

rhs	is the AutoInterval that is compared to this one.

Returns

true if both AutoInterval instances have the auto-flag set or if both boundaries are equal.

setAuto()

void ito::AutoInterval::setAuto

(

bool

autoInterval

)

set the auto-flag to a given boolean value

Parameters

autoInterval

is the new state of the auto-flag

setMaximum()

void ito::AutoInterval::setMaximum

(

double

max

)

change the included maximum value

Parameters

max	is the new included maximum value

setMinimum()

void ito::AutoInterval::setMinimum

(

double

min

)

change the included minimum value

Parameters

min	is the new included minimum value

setRange()

void ito::AutoInterval::setRange	(	double	min,
		double	max )

set the boundary values of the AutoInterval without changing the auto flag

Parameters

min	is the new included minimum value
max	is the new included maximum value

Member Data Documentation

m_auto

bool ito::AutoInterval::m_auto

private

true if the interval can be automatically be adjusted by the code using it or if m_min and m_max are fixed boundaries

m_max

double ito::AutoInterval::m_max

private

maximum value that is included in the interval

m_min

double ito::AutoInterval::m_min

private

minimum value that is included in the interval

---

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

• C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/common/interval.h
• C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/common/sources/interval.cpp