IlvMinuteTimeScaleRow Class Reference

Time scale row class. More...

#include <ilviews/graphics/timescalerow.h>

Inheritance diagram for IlvMinuteTimeScaleRow:

List of all members.

Public Member Functions
	IlvMinuteTimeScaleRow (IlvTimeScale *parent)
	Constructor.
virtual IlvTimeScaleRow *	copy () const
	Returns a copy of the current time scale row.
IlInt	getMinuteStep ()
	Returns the number of minutes for an interval.
virtual IlvTimeScaleRowFactory::rowtype	getType () const
	Returns the type of the IlvTimeScaleRow.
virtual IlDate	incrementTime (IlDate dateval)
	Increments the time by one minute multiplied by the minute step.
virtual IlDate	previousUnitTime (IlDate dateval)
	Returns the previous unit value of the minute relative to the specified date.
virtual void	read (IlvInputFile &)
	Reads the time scale row description from an input file.
void	setMinuteStep (IlInt value)
	Sets the number of minutes 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 minute intervals.

---

Constructor & Destructor Documentation

IlvMinuteTimeScaleRow::IlvMinuteTimeScaleRow

(

IlvTimeScale *

parent

)

Constructor.

Creates and initializes an IlvMinuteTimeScaleRow object.

---

Member Function Documentation

virtual IlvTimeScaleRow* IlvMinuteTimeScaleRow::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 IlvMinuteTimeScaleRow::getMinuteStep

(

)

Returns the number of minutes for an interval.

See also:

setMinuteStep

virtual IlvTimeScaleRowFactory::rowtype IlvMinuteTimeScaleRow::getType

(

)

const [virtual]

Returns the type of the IlvTimeScaleRow.

Returns:

The type of the IlvTimeScaleRow.

Implements IlvTimeScaleRow.

virtual IlDate IlvMinuteTimeScaleRow::incrementTime

(

IlDate

dateval

)

[virtual]

Increments the time by one minute multiplied by the minute step.

For example, the incremented date of January 14th, 2002, 8:12:34 is January 14th, 2002, 8:13:34 if the minute step is 1 or 8:17:34 if the minute step is 5.

Parameters:

dateval

The date to increment.

Implements IlvTimeScaleRow.

virtual IlDate IlvMinuteTimeScaleRow::previousUnitTime

(

IlDate

dateval

)

[virtual]

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

For example, the previous unit time of January 14th, 2002, 8:12:34 is January 14th, 2002, 8:12:00 if the minute step is 1 or 8:10:00 if the minute step is 5.

Parameters:

dateval

The date to floor.

See also:

setMinuteStep

Implements IlvTimeScaleRow.

virtual void IlvMinuteTimeScaleRow::read

(

IlvInputFile &

infile

)

[virtual]

Reads the time scale row description from an input file.

Parameters:

infile

The input file.

Reimplemented from IlvTimeScaleRow.

void IlvMinuteTimeScaleRow::setMinuteStep

(

IlInt

value

)

Sets the number of minutes for an interval.

The default value is 1.

Parameters:

value

The number of minutes. It should be a positive number and a divisor of 60.

virtual void IlvMinuteTimeScaleRow::write

(

IlvOutputFile &

outfile

)

const [virtual]

Saves the time scale row in an output file.

Parameters:

outfile

The output file.

Reimplemented from IlvTimeScaleRow.