IlvCoordInterval Class Reference

Class representing a coordinate interval. More...

#include <ilviews/charts/common.h>

Public Member Functions
ILVEXPLICIT	IlvCoordInterval (IlDouble min=0.0, IlDouble max=0.0)
	Constructor. More...
IlDouble	getLength () const
	Returns the difference between the maximum and the minimum values. More...
IlDouble	getMax () const
	Returns the maximum value. More...
IlDouble	getMin () const
	Returns the minimum value. More...
IlvCoordInterval &	intersection (const IlvCoordInterval &itv)
	Sets the current interval to the intersection between the current interval and another one. More...
IlBoolean	intersects (const IlvCoordInterval &itv) const
	Indicates whether an interval intersects the considered interval. More...
IlBoolean	isAfter (IlDouble val) const
	Indicates whether a value is after or on the considered interval. More...
IlBoolean	isBefore (IlDouble val) const
	Indicates whether a value is before or on the considered interval. More...
IlBoolean	isInside (IlDouble val) const
	Indicates whether a value is on or within the considered interval. More...
IlBoolean	isOutside (IlDouble val) const
	Indicates whether a value is on or outside the considered interval. More...
IlBoolean	isStrictlyAfter (IlDouble val) const
	Indicates whether a value is after the considered interval. More...
IlBoolean	isStrictlyBefore (IlDouble val) const
	Indicates whether a value is before the considered interval. More...
IlBoolean	isStrictlyInside (IlDouble val) const
	Indicates whether a value is inside the considered interval. More...
IlBoolean	isStrictlyOutside (IlDouble val) const
	Indicates whether a value is outside the interval. More...
void	operator+= (IlDouble val)
	Extends the considered interval so that it contains a given value. More...
void	operator+= (const IlvCoordInterval &itv)
	Extends the considered interval so that it contains a given interval. More...
void	set (IlDouble min, IlDouble max)
	Sets the minimum and the maximum values. More...
void	setMax (IlDouble val)
	Sets the maximum value. More...
void	setMin (IlDouble val)
	Sets the minimum value. More...
IlDouble	stepToValue (IlDouble nSteps, IlDouble iStep) const
	Returns a value within the considered values interval. More...
void	translate (IlDouble delta)
	Translates the considered interval. More...

Detailed Description

Class representing a coordinate interval.

Library: ilvcharts

This class is used to represent a values interval that is characterized by its minimum and maximum values.

Constructor & Destructor Documentation

ILVEXPLICIT IlvCoordInterval::IlvCoordInterval	(	IlDouble	min = 0.0,
		IlDouble	max = 0.0
	)

Constructor.

Initializes a new IlvCoordInterval object.

Parameters

min	The value set as the minimum of the considered interval.
max	The value set as the maximum of the considered interval.

Member Function Documentation

IlDouble IlvCoordInterval::getLength

(

)

const

Returns the difference between the maximum and the minimum values.

Returns

The difference between the maximum and the minimum values of the interval.

IlDouble IlvCoordInterval::getMax

(

)

const

Returns the maximum value.

Returns

The maximum value of the considered values interval.

IlDouble IlvCoordInterval::getMin

(

)

const

Returns the minimum value.

Returns

The minimum value of the considered values interval.

IlvCoordInterval& IlvCoordInterval::intersection

(

const IlvCoordInterval &

itv

)

Sets the current interval to the intersection between the current interval and another one.

Computes the intersection between the considered interval and the interval itv. The considered interval is then modified to contain this intersection. If there is no intersection, the considered interval is modified so that the maximum value is equal to the minimum value, thus indicating that the intersection is null since the modified interval contains no value between its minimum and its maximum.

Parameters

itv	The interval with which we want to compute the intersection.

Returns

The current interval that has been modified to contain the intersection with the interval itv.

IlBoolean IlvCoordInterval::intersects

(

const IlvCoordInterval &

itv

)

const

Indicates whether an interval intersects the considered interval.

Parameters

itv	The interval for which we want to know if there is intersection with the considered interval.

Returns

IlTrue if some values of the interval itv are within the minimum and maximum values of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isAfter

(

IlDouble

val

)

const

Indicates whether a value is after or on the considered interval.

Parameters

val	The value for which we want to know whether it is after or on the considered interval.

Returns

IlTrue if the value val is after or on the maximum value of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isBefore

(

IlDouble

val

)

const

Indicates whether a value is before or on the considered interval.

Parameters

val	The value for which we want to know whether it is before or on the considered interval.

Returns

IlTrue if the value val is before or on the minimum value of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isInside

(

IlDouble

val

)

const

Indicates whether a value is on or within the considered interval.

Parameters

val	The value for which we want to know whether it is on or between the considered interval.

Returns

IlTrue if the value val is on or between the minimum and the maximum of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isOutside

(

IlDouble

val

)

const

Indicates whether a value is on or outside the considered interval.

Parameters

val	The value for which we want to know if it is on or outside the considered interval.

Returns

IlTrue if the value val is on or outside the minimum and the maximum of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isStrictlyAfter

(

IlDouble

val

)

const

Indicates whether a value is after the considered interval.

Parameters

val	The value for which we want to know whether it is after the considered interval.

Returns

IlTrue if the value val is after the maximum of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isStrictlyBefore

(

IlDouble

val

)

const

Indicates whether a value is before the considered interval.

Parameters

val	The value for which we want to know if it is before the considered interval.

Returns

IlTrue if the value val is before the minimum of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isStrictlyInside

(

IlDouble

val

)

const

Indicates whether a value is inside the considered interval.

Parameters

val	The value for which we want to know if it is inside the interval.

Returns

IlTrue if the value val is between the minimum and the maximum of the considered interval and IlFalse otherwise.

IlBoolean IlvCoordInterval::isStrictlyOutside

(

IlDouble

val

)

const

Indicates whether a value is outside the interval.

Parameters

val	The value for which we want to know if it is outside the considered interval.

Returns

IlTrue if the value val is outside of the minimum and the maximum of the considered interval and IlFalse otherwise.

void IlvCoordInterval::operator+=

(

IlDouble

val

)

Extends the considered interval so that it contains a given value.

If the value val does not belong to the considered interval, this method extends the considered interval so that it contains this value.

Parameters

val	The value to be added to the current interval.

void IlvCoordInterval::operator+=

(

const IlvCoordInterval &

itv

)

Extends the considered interval so that it contains a given interval.

If the interval itv is not inside the interval, this method extends the interval so that it contains this interval.

Parameters

itv	The interval to be added to the current interval.

void IlvCoordInterval::set	(	IlDouble	min,
		IlDouble	max
	)

Sets the minimum and the maximum values.

Sets the minimum and the maximum values of the considered interval to min and max respectively.

Parameters

min	The new minimum value of the considered interval.
max	The new maximum value of the considered interval.

void IlvCoordInterval::setMax

(

IlDouble

val

)

Sets the maximum value.

Parameters

val	The new maximum value of the considered interval.

void IlvCoordInterval::setMin

(

IlDouble

val

)

Sets the minimum value.

Parameters

val	The new minimum value of the considered interval.

IlDouble IlvCoordInterval::stepToValue	(	IlDouble	nSteps,
		IlDouble	iStep
	)		const

Returns a value within the considered values interval.

Given the number of values between the minimum and the maximum of the considered interval, this method returns the value at the index iStep inside the interval. The returned value is computed as follows:

value = length()/(nSteps-1)*iStep + getMin();

Parameters

nSteps	The number of values between the minimum and the maximum of the considered interval.
iStep	The index of the returned value of the interval.

Returns

The value of index iStep inside the considered interval.

void IlvCoordInterval::translate

(

IlDouble

delta

)

Translates the considered interval.

Translates the considered interval by delta.

Parameters

delta

The value by which the interval is translated.