A model class. More...

#include <ilviews/dataccess/gadgets/chartmodel.h>

Inheritance diagram for IliChartDataModel:

Public Member Functions
	IliChartDataModel ()
	Constructor of the `IliChartDataModel` class. More...

virtual void	addXYValue (const IliDataSetIdentifier &id, IlDouble x, IlDouble y) const
	Called to add a point in a data source. More...

virtual void	allRowsDeleted (const IliModelHookInfo &info)
	Called when the `IliTable::clearRows` member function is called. More...

virtual void	cellChanged (const IliModelHookInfo &info)
	Called just after a cell has changed. More...

virtual void	columnChanged (const IliModelHookInfo &info)
	Called when a column has changed. More...

virtual void	columnDeleted (const IliModelHookInfo &info)
	Called just after a column deletion. More...

virtual void	columnInserted (const IliModelHookInfo &info)
	Called when a new column is inserted. More...

virtual void	columnMoved (const IliModelHookInfo &info)
	Called just after a column has moved. More...

virtual void	columnToBeDeleted (const IliModelHookInfo &info)
	Called just before a column deletion. More...

virtual IlInt	computeSeriesCount (IlInt dsi, IlInt row, IliTableBuffer *buff) const
	Called to compute the series count in a table buffer. More...

virtual void	computeSeriesName (IlInt dsi, IlInt row, IlInt index, IliTableBuffer *buff, IliString &series) const
	Called to compute a series name. More...

virtual IlDouble	computeXValue (IlInt dsi, IlInt row, const IliString &series, IliTableBuffer *buff) const
	Called to compute the x-axis value for a series. More...

virtual void	currentRowChanged (const IliModelHookInfo &info)
	Called when the data source current row has been changed. More...

virtual void	deleteAllXYValues (const IliDataSetIdentifier &id) const
	Called to delete all points in a data source. More...

virtual void	deleteXYValue (const IliDataSetIdentifier &id, IlInt rowno) const
	Called to delete a point in a data source. More...

IliChartGraphic *	getChartGraphic () const
	Returns the `IliChartDataModel` object which is connected to this model. More...

virtual IlBoolean	isPointsDataSource (IlInt dsi) const
	Called to determine if the data source contains some points. More...

virtual IlDouble	readXValue (const IliDataSetIdentifier &id, IlInt rowno) const
	Called to read an x-axis value from the data source. More...

virtual IlDouble	readYValue (const IliDataSetIdentifier &id, IlInt rowno) const
	Called to read a y-axis value from the data source. More...

virtual IlBoolean	refreshAll ()
	Called when a refresh of all the gadget is necessary.

virtual void	rowChanged (const IliModelHookInfo &info)
	Called just after a row has changed. More...

virtual void	rowDeleted (const IliModelHookInfo &info)
	Called just after a row has been deleted. More...

virtual void	rowFetched (const IliModelHookInfo &info)
	Called just after a new row has been fetched from a remote database and inserted. More...

virtual void	rowInserted (const IliModelHookInfo &info)
	Called just after a new row has been inserted. More...

virtual void	rowMoved (const IliModelHookInfo &info)
	Called just after a row has moved. More...

virtual void	rowsExchanged (const IliModelHookInfo &info)
	Called just after a row is exchanged with another row. More...

virtual void	rowsFetched (const IliModelHookInfo &info)
	Called when many consecutive rows are fetched at once. More...

virtual void	rowsInserted (const IliModelHookInfo &info)
	Called when many consecutive rows are inserted at once. More...

virtual void	rowToBeChanged (const IliModelHookInfo &info)
	Called just before a row is changed. More...

virtual void	rowToBeDeleted (const IliModelHookInfo &info)
	Called just before a row deletion. More...

virtual void	tableChanged (const IliModelHookInfo &info)
	Called when the object has undergone a significant number of changes. More...

virtual void	tableDeleted (const IliModelHookInfo &info)
	Called when the `IliSchema` or `IliTable` object is deleted. More...

virtual void	writeXYValue (const IliDataSetIdentifier &id, IlInt rowno, IlDouble x, IlDouble y) const
	Called to update a point in a data source. More...

Public Member Functions inherited from IliGadgetModel
	IliGadgetModel ()
	The constructor initializes a new `IliGadgetModel` instance.

virtual void	endOfBatch ()
	Called to terminate a series of updates to the `IliSchema` or `IliTable` objects. More...

virtual const char *	getName () const
	Returns the model name. More...

virtual void	startOfBatch ()
	Called at the start of a series of updates to the `IliSchema` or `IliTable` object. More...

Public Member Functions inherited from IliModel
	IliModel ()
	The constructor initializes a new `IliModel` instance.

IlInt	declareProperty (const IliDatatype typ, const char name, const char *title, IlBoolean pub)
	Declares a new property. More...

virtual void	defineProperties ()
	Called to define the list of properties. More...

virtual const char *	getLabel () const =0
	Returns the model label, it is used by the gadget inspector. More...

virtual const char *	getMappingInspectorModelName () const
	Returns the mapping inspector model name. More...

IlInt	getPropertyCount () const
	Returns the property count. More...

IlInt	getPropertyIndex (const char *name) const
	Returns a property index. More...

const char *	getPropertyName (IlInt index) const
	Returns a property name. More...

const IliValue &	getPropertyValue (const char *name) const
	Returns a property value. More...

const IliValue &	getPropertyValue (IlInt index) const
	Returns a property value. More...

virtual IlBoolean	isPublic () const
	Returns the model visibility. More...

void	setPropertyValue (const char *name, const IliValue &val)
	Sets a property value. More...

void	setPropertyValue (IlInt index, const IliValue &val)
	Sets a property value. More...

Detailed Description

A model class.

Library: dbchart

The class defines a chart data model. A chart data model is used by the IliChartGraphic class to handle the data of one or several data sources. All chart data models inherit of this class. There are three predefined data model:

By row: Each row corresponds to a point for a series. This model uses a data source with three columns:
- Series, at position 0 when you use the column functions of the chart.
- x axis, at position 1 when you use the column functions of the chart.
- value, at position 2 when you use the column functions of the chart.
By Column: Each row corresponds to a point for each series for one x-axis value. This model uses a data source with one column for x-axis and one column for each series:
- x axis, at position 0 when you use the column functions of the chart.
- series 1, at position 1 when you use the column functions of the chart.
- series n, at position n when you use the column functions of the chart.
By data source: For each series there is a data source which contains all points of the series. Each data source has got two columns:
x axis, at position 0 when you use the column functions of the chart.
value, at position 1 when you use the column functions of the chart.

See also: IliChartGraphic, IliChartSeriesModel, IliModel, IliGadgetModel.

Constructor & Destructor Documentation

§ IliChartDataModel()

IliChartDataModel::IliChartDataModel ( )

Constructor of the IliChartDataModel class.

Initializes an IliChartDataModel object.

Member Function Documentation

§ addXYValue()

virtual void IliChartDataModel::addXYValue	(	const IliDataSetIdentifier &	id,
		IlDouble	x,
		IlDouble	y
	)		const

virtual

Called to add a point in a data source.

Parameters

id	The data set identifier.
x	The x-axis value.
y	The y-axis value.

§ allRowsDeleted()

virtual void IliChartDataModel::allRowsDeleted ( const IliModelHookInfo & info )

virtual

Called when the IliTable::clearRows member function is called.

Parameters

info	It contains the data source index.

Reimplemented from IliGadgetModel.

§ cellChanged()

virtual void IliChartDataModel::cellChanged ( const IliModelHookInfo & info )

virtual

Called just after a cell has changed.

If more than one value has changed in a row, it is likely that the rowChanged member function will be called, instead of this member function.

Parameters

info	It contains the cell position (row and column).

Reimplemented from IliGadgetModel.

§ columnChanged()

virtual void IliChartDataModel::columnChanged ( const IliModelHookInfo & info )

virtual

Called when a column has changed.

Parameters

info	It contains the column position.

Reimplemented from IliGadgetModel.

§ columnDeleted()

virtual void IliChartDataModel::columnDeleted ( const IliModelHookInfo & info )

virtual

Called just after a column deletion.

Parameters

info	It contains the column position.

Reimplemented from IliGadgetModel.

§ columnInserted()

virtual void IliChartDataModel::columnInserted ( const IliModelHookInfo & info )

virtual

Called when a new column is inserted.

Parameters

info	It contains the column position.

Reimplemented from IliGadgetModel.

§ columnMoved()

virtual void IliChartDataModel::columnMoved ( const IliModelHookInfo & info )

virtual

Called just after a column has moved.

Parameters

info	It contains the `from` and `to` position.

Reimplemented from IliGadgetModel.

§ columnToBeDeleted()

virtual void IliChartDataModel::columnToBeDeleted ( const IliModelHookInfo & info )

virtual

Called just before a column deletion.

Parameters

info	It contains the column position.

Reimplemented from IliGadgetModel.

§ computeSeriesCount()

virtual IlInt IliChartDataModel::computeSeriesCount	(	IlInt	dsi,
		IlInt	row,
		IliTableBuffer *	buff
	)		const

virtual

Called to compute the series count in a table buffer.

Parameters

dsi	The data source index.
row	The row number.
buff	The table buffer.

Returns: The series count.

§ computeSeriesName()

virtual void IliChartDataModel::computeSeriesName	(	IlInt	dsi,
		IlInt	row,
		IlInt	index,
		IliTableBuffer *	buff,
		IliString &	series
	)		const

virtual

Called to compute a series name.

Parameters

dsi	The data source index.
row	The row number.
index	The series index.
buff	The table buffer.
series	The series name.

§ computeXValue()

virtual IlDouble IliChartDataModel::computeXValue	(	IlInt	dsi,
		IlInt	row,
		const IliString &	series,
		IliTableBuffer *	buff
	)		const

virtual

Called to compute the x-axis value for a series.

Parameters

dsi	The data source index.
row	The row number.
series	The series name.
buff	The table buffer.

Returns: The x-axis value.

§ currentRowChanged()

virtual void IliChartDataModel::currentRowChanged ( const IliModelHookInfo & info )

virtual

Called when the data source current row has been changed.

This event is notified if the gadget supports the current row notifications (for example, IliXML).

Parameters

info	It contains the row position.

Reimplemented from IliGadgetModel.

§ deleteAllXYValues()

virtual void IliChartDataModel::deleteAllXYValues ( const IliDataSetIdentifier & id ) const

virtual

Called to delete all points in a data source.

Parameters

id	The data set identifier.

§ deleteXYValue()

virtual void IliChartDataModel::deleteXYValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno
	)		const

virtual

Called to delete a point in a data source.

Parameters

id	The data set identifier.
rowno	The row number in the data source.

§ getChartGraphic()

IliChartGraphic* IliChartDataModel::getChartGraphic ( ) const

Returns the IliChartDataModel object which is connected to this model.

Returns: The IliChartGraphic object which is connected to this model.

§ isPointsDataSource()

virtual IlBoolean IliChartDataModel::isPointsDataSource ( IlInt dsi ) const

virtual

Called to determine if the data source contains some points.

Parameters

dsi	The data source index.

Returns: IlTrue if the data source contains some points.

§ readXValue()

virtual IlDouble IliChartDataModel::readXValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno
	)		const

virtual

Called to read an x-axis value from the data source.

Parameters

id	The data set identifier.
rowno	The row number in the data source.

Returns: The x-axis value.

§ readYValue()

virtual IlDouble IliChartDataModel::readYValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno
	)		const

virtual

Called to read a y-axis value from the data source.

Parameters

id	The data set identifier.
rowno	The row number in the data source.

Returns: The y-axis value.

§ rowChanged()

virtual void IliChartDataModel::rowChanged ( const IliModelHookInfo & info )

virtual

Called just after a row has changed.

Parameters

info	It contains the row position.

Reimplemented from IliGadgetModel.

§ rowDeleted()

virtual void IliChartDataModel::rowDeleted ( const IliModelHookInfo & info )

virtual

Called just after a row has been deleted.

Parameters

info	It contains the row position.

Reimplemented from IliGadgetModel.

§ rowFetched()

virtual void IliChartDataModel::rowFetched ( const IliModelHookInfo & info )

virtual

Called just after a new row has been fetched from a remote database and inserted.

The rowInserted member function will also be called.

Parameters

info	It contains the `from` and `to` position.

Reimplemented from IliGadgetModel.

§ rowInserted()

virtual void IliChartDataModel::rowInserted ( const IliModelHookInfo & info )

virtual

Called just after a new row has been inserted.

Parameters

info	It contains the row position.

Reimplemented from IliGadgetModel.

§ rowMoved()

virtual void IliChartDataModel::rowMoved ( const IliModelHookInfo & info )

virtual

Called just after a row has moved.

Parameters

info	It contains the `from` and `to` position.

Reimplemented from IliGadgetModel.

§ rowsExchanged()

virtual void IliChartDataModel::rowsExchanged ( const IliModelHookInfo & info )

virtual

Called just after a row is exchanged with another row.

Parameters

info	It contains the first row position (from) and the second row position (to).

Reimplemented from IliGadgetModel.

§ rowsFetched()

virtual void IliChartDataModel::rowsFetched ( const IliModelHookInfo & info )

virtual

Called when many consecutive rows are fetched at once.

The fetched rows appear between the from position and the to position, inclusive. By default, this virtual member function repeatedly calls rowsFetched with each index between from and to.

Parameters

info	It contains the first row position (from) and the second row position (to).

Reimplemented from IliGadgetModel.

§ rowsInserted()

virtual void IliChartDataModel::rowsInserted ( const IliModelHookInfo & info )

virtual

Called when many consecutive rows are inserted at once.

The inserted rows appear between the from position and the to position, inclusive. By default, this virtual member function repeatedly calls rowInserted with each index between from and to.

Parameters

info	It contains the `from` and `to` position.

Reimplemented from IliGadgetModel.

§ rowToBeChanged()

virtual void IliChartDataModel::rowToBeChanged ( const IliModelHookInfo & info )

virtual

Called just before a row is changed.

Parameters

info	It contains the row position.

Reimplemented from IliGadgetModel.

§ rowToBeDeleted()

virtual void IliChartDataModel::rowToBeDeleted ( const IliModelHookInfo & info )

virtual

Called just before a row deletion.

Parameters

info	It contains the row position.

Reimplemented from IliGadgetModel.

§ tableChanged()

virtual void IliChartDataModel::tableChanged ( const IliModelHookInfo & info )

virtual

Called when the object has undergone a significant number of changes.

Parameters

info	It contains the data source index.

Reimplemented from IliGadgetModel.

§ tableDeleted()

virtual void IliChartDataModel::tableDeleted ( const IliModelHookInfo & info )

virtual

Called when the IliSchema or IliTable object is deleted.

Parameters

info	It contains the data source index.

Reimplemented from IliGadgetModel.

§ writeXYValue()

virtual void IliChartDataModel::writeXYValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno,
		IlDouble	x,
		IlDouble	y
	)		const

virtual

Called to update a point in a data source.

Parameters

id	The data set identifier.
rowno	The row number in the data source.
x	The new x-axis value.
y	The new y-axis value.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

§ IliChartDataModel()

Member Function Documentation

§ addXYValue()

§ allRowsDeleted()

§ cellChanged()

§ columnChanged()

§ columnDeleted()

§ columnInserted()

§ columnMoved()

§ columnToBeDeleted()

§ computeSeriesCount()

§ computeSeriesName()

§ computeXValue()

§ currentRowChanged()

§ deleteAllXYValues()

§ deleteXYValue()

§ getChartGraphic()

§ isPointsDataSource()

§ readXValue()

§ readYValue()

§ rowChanged()

§ rowDeleted()

§ rowFetched()

§ rowInserted()

§ rowMoved()

§ rowsExchanged()

§ rowsFetched()

§ rowsInserted()

§ rowToBeChanged()

§ rowToBeDeleted()

§ tableChanged()

§ tableDeleted()

§ writeXYValue()