IlvLinearTimeConverter Class Reference

Linear time converter class. More...

#include <ilviews/graphics/timeconverter.h>

Inheritance diagram for IlvLinearTimeConverter:

List of all members.

Public Member Functions
	IlvLinearTimeConverter (const IlvLinearTimeConverter &)
	Copy Constructor.
	IlvLinearTimeConverter ()
	Constructor.
	IlvLinearTimeConverter (IlDate refTime, IlvDuration unit)
	Constructor.
virtual IlDate	getTime (IlDouble units)
	Converts a double value to a IlDate.
IlvDuration	getUnitDuration ()
	Returns the unit duration.
virtual IlDouble	getUnits (IlDate time)
	Converts a IlDate to a double.
void	setUnitDuration (IlvDuration d)
	Sets the unit duration.

---

Detailed Description

Linear time converter class.

Library: views

An IlvLinearTimeConverter is capable of converting a IlDate to a double value, and a double value to a IlDate in a linear way.

The converter is defined by a reference time and a unit duration. The reference time represents the time where the double value is 0, and the unit duration is the duration of a double value of 1.

Here is the conversion formula:

double value = ( time value - reference time ) / unit duration

---

Constructor & Destructor Documentation

IlvLinearTimeConverter::IlvLinearTimeConverter	(	IlDate	refTime,
		IlvDuration	unit
	)

Constructor.

Creates a linear time converter.

Parameters:

	refTime	Gives the reference time for the new converter.
	unit	Defines the unit time used for the conversion. The value provided should not be 0.

IlvLinearTimeConverter::IlvLinearTimeConverter

(

)

Constructor.

Creates an IlvLinearTimeConverter with a reference time set to the current time, and a unit duration set to one hour.

---

Member Function Documentation

virtual IlDate IlvLinearTimeConverter::getTime

(

IlDouble

units

)

[virtual]

Converts a double value to a IlDate.

Parameters:

units

The double value to be converted.

Implements IlvTimeConverter.

IlvDuration IlvLinearTimeConverter::getUnitDuration

(

)

Returns the unit duration.

See also:

setUnitDuration

virtual IlDouble IlvLinearTimeConverter::getUnits

(

IlDate

time

)

[virtual]

Converts a IlDate to a double.

Parameters:

time

The IlDate to be converted.

Implements IlvTimeConverter.

void IlvLinearTimeConverter::setUnitDuration

(

IlvDuration

d

)

Sets the unit duration.

Parameters:

d

The new unit duration. The value provided should not be 0.

See also:

getUnitDuration