IlvYearTimeScaleRow Class Reference

Time scale row class. More...

#include <ilviews/graphics/timescalerow.h>

Inheritance diagram for IlvYearTimeScaleRow:

List of all members.

Public Member Functions
	IlvYearTimeScaleRow (IlvTimeScale *parent)
	Constructor.
virtual IlvTimeScaleRow *	copy () const
	Returns a copy of the current time scale row.
virtual IlvTimeScaleRowFactory::rowtype	getType () const
	Returns the type of the IlvTimeScaleRow.
virtual IlDate	incrementTime (IlDate dateval)
	Increments the specified date by one year.
virtual IlDate	previousUnitTime (IlDate dateval)
	Returns the previous unit value of the year relative to the specified date.
virtual void	read (IlvInputFile &)
	Reads the time scale row description from an input file.
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 class IlvTimeScaleRow to provide a complete scale displaying yearly intervals. By default, each yearly interval is displayed with a text formatted using java.text.SimpleDateFormat created with the "yyy" string. The exact result depends on the system Locale, in English "2002" for January 18th, 2002.

---

Constructor & Destructor Documentation

IlvYearTimeScaleRow::IlvYearTimeScaleRow

(

IlvTimeScale *

parent

)

Constructor.

Creates and initializes an IlvYearTimeScaleRow object.

---

Member Function Documentation

virtual IlvTimeScaleRow* IlvYearTimeScaleRow::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.

virtual IlvTimeScaleRowFactory::rowtype IlvYearTimeScaleRow::getType

(

)

const [virtual]

Returns the type of the IlvTimeScaleRow.

Returns:

The type of the IlvTimeScaleRow.

Implements IlvTimeScaleRow.

virtual IlDate IlvYearTimeScaleRow::incrementTime

(

IlDate

dateval

)

[virtual]

Increments the specified date by one year.

For example, the incremented date of January 14th, 2002 is January 14th, 2003.

Parameters:

dateval

The date to increment.

Implements IlvTimeScaleRow.

virtual IlDate IlvYearTimeScaleRow::previousUnitTime

(

IlDate

dateval

)

[virtual]

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

For example, the previous unit time of January 14th, 2002 is January 1st, 2002.

Parameters:

dateval

The date to floor.

Implements IlvTimeScaleRow.

virtual void IlvYearTimeScaleRow::read

(

IlvInputFile &

infile

)

[virtual]

Reads the time scale row description from an input file.

Parameters:

infile

The input file.

Reimplemented from IlvTimeScaleRow.

virtual void IlvYearTimeScaleRow::write

(

IlvOutputFile &

outfile

)

const [virtual]

Saves the time scale row in an output file.

Parameters:

outfile

The output file.

Reimplemented from IlvTimeScaleRow.