IlvHourTimeScaleRow Class Reference

Time scale row class. More...

#include <ilviews/graphics/timescalerow.h>

Inheritance diagram for IlvHourTimeScaleRow:

List of all members.

Public Member Functions
	IlvHourTimeScaleRow (IlvTimeScale *parent)
	Constructor.
virtual IlvTimeScaleRow *	copy () const
	Returns a copy of the current time scale row.
IlInt	getHourStep ()
	Returns the number of hours in an interval.
virtual IlvTimeScaleRowFactory::rowtype	getType () const
	Returns the type of the IlvTimeScaleRow.
virtual IlDate	incrementTime (IlDate dateval)
	Increments the specified date by one hour multiplied by the hour step.
virtual IlDate	previousUnitTime (IlDate dateval)
	Returns the previous unit value of the hour relative to the specified date.
virtual void	read (IlvInputFile &)
	Reads the time scale row description from an input file.
void	setHourStep (IlInt value)
	Sets the number of hours for an interval.
virtual void	write (IlvOutputFile &) const
	Saves the time scale row in an output file.
Protected Member Functions
virtual IlvTimeScaleRow *	cloneType (IlvTimeScale *) const
	Returns an object of the same type.

---

Detailed Description

Time scale row class.

Library: views

This class implements methods from the parent class IlvTimeScaleRow to provide a complete scale displaying hour intervals.

---

Constructor & Destructor Documentation

IlvHourTimeScaleRow::IlvHourTimeScaleRow

(

IlvTimeScale *

parent

)

Constructor.

Creates and initializes an IlvHourTimeScaleRow object.

---

Member Function Documentation

virtual IlvTimeScaleRow* IlvHourTimeScaleRow::cloneType

(

IlvTimeScale *

scale

)

const [protected, virtual]

Returns an object of the same type.

This method should be implemented by subclasses. It must return an object of the same type as the object on which the method is called, attached to the given IlvTimeScale.

Parameters:

scale

The IlvTimeScale on which the row is attached.

Returns:

A newly allocated object of the same type as the object on which the method is called.

Implements IlvTimeScaleRow.

IlInt IlvHourTimeScaleRow::getHourStep

(

)

Returns the number of hours in an interval.

See also:

setHourStep

virtual IlvTimeScaleRowFactory::rowtype IlvHourTimeScaleRow::getType

(

)

const [virtual]

Returns the type of the IlvTimeScaleRow.

Returns:

The type of the IlvTimeScaleRow.

Implements IlvTimeScaleRow.

virtual IlDate IlvHourTimeScaleRow::incrementTime

(

IlDate

dateval

)

[virtual]

Increments the specified date by one hour multiplied by the hour step.

For example, the incremented date of January 14th, 2002, 8:12:34 is January 14th 2002 8:13:34 if the hour step is 1 or January 14th 2002 8:16:34 if the hour step is 3.

Parameters:

dateval

The date to increment.

Implements IlvTimeScaleRow.

virtual IlDate IlvHourTimeScaleRow::previousUnitTime

(

IlDate

dateval

)

[virtual]

Returns the previous unit value of the hour relative to the specified date.

For example, the previous unit time of January 14th, 2002, 8:12:34 is January 14th 2002 8:00:00 if the hour step in 1 or January 14th 2002 6:00:00 if the hour step is 3.

Parameters:

dateval

The date to floor.

Implements IlvTimeScaleRow.

virtual void IlvHourTimeScaleRow::read

(

IlvInputFile &

infile

)

[virtual]

Reads the time scale row description from an input file.

Parameters:

infile

The input file.

Reimplemented from IlvTimeScaleRow.

void IlvHourTimeScaleRow::setHourStep

(

IlInt

value

)

Sets the number of hours for an interval.

The default value is 1.

Parameters:

value

The number of hours. It should be a positive number and a divisor of 24.

virtual void IlvHourTimeScaleRow::write

(

IlvOutputFile &

outfile

)

const [virtual]

Saves the time scale row in an output file.

Parameters:

outfile

The output file.

Reimplemented from IlvTimeScaleRow.