Range2D Class Reference

2D range. More...

#include <base/Range2D.h>

Inherits Object.

Public Member Functions
	Range2D () noexcept
	Range2D (const Range2D &copy) noexcept
	Range2D (double _minimum, double _maximum) noexcept
Range2D &	operator= (const Range2D &assign) noexcept
bool	isAbove (double value) const noexcept
bool	isBelow (double value) const noexcept
bool	isOutside (double value) const noexcept
bool	isWithin (double value) const noexcept
double	getMinimum () const noexcept
double	getMaximum () const noexcept
void	setMinimum (double minimum) noexcept
void	setMaximum (double maximum) noexcept

Protected Attributes
double	minimum = 0
double	maximum = 0

Detailed Description

2D range.

A 2D range object is a span from a minimum to a maximum.

Version

1.0

Constructor & Destructor Documentation

Range2D() [1/3]

Range2D::Range2D ( )

inlinenoexcept

Initializes a Range2D object with the minimum and maximum values set to zero.

Range2D() [2/3]

Range2D::Range2D ( const Range2D &  copy )

inlinenoexcept

Initializes a Range2D object. The range is copied from the specified range.

Parameters

range

The desired range.

Range2D() [3/3]

Range2D::Range2D ( double  _minimum, double  _maximum  )

inlinenoexcept

Initializes a Range2D object with the specified minimum and maximum values.

Parameters

minimum	The desired minimum value.
maximum	The desired maximum value.

Member Function Documentation

getMaximum()

double Range2D::getMaximum ( ) const

inlinenoexcept

Returns the maximum value.

getMinimum()

double Range2D::getMinimum ( ) const

inlinenoexcept

Returns the minimum value.

isAbove()

bool Range2D::isAbove ( double  value ) const

inlinenoexcept

Returns true if the value is above the range specified by minimum and maximum.

Parameters

value

The value to be checked.

isBelow()

bool Range2D::isBelow ( double  value ) const

inlinenoexcept

Returns true if the value is below the range specified by minimum and maximum.

Parameters

value

The value to be checked.

isOutside()

bool Range2D::isOutside ( double  value ) const

inlinenoexcept

Returns true if the value is outside the range specified by minimum and maximum.

Parameters

value

The value to be checked.

isWithin()

bool Range2D::isWithin ( double  value ) const

inlinenoexcept

Returns true if the value is within the range specified by minimum and maximum.

Parameters

value

The value to be checked.

operator=()

Range2D& Range2D::operator= ( const Range2D &  assign )

inlinenoexcept

Sets the range.

Parameters

range

The desired range.

setMaximum()

void Range2D::setMaximum ( double  maximum )

inlinenoexcept

Sets the maximum value.

Parameters

maximum

The desired maximum value.

setMinimum()

void Range2D::setMinimum ( double  minimum )

inlinenoexcept

Sets the minimum value.

Parameters

minimum

The desired minimum value.

Member Data Documentation

maximum

double Range2D::maximum = 0

protected

The maximum value.

minimum

double Range2D::minimum = 0

protected

The minimum value.