vtkQtChartSeriesModelCollection Class Reference

#include <vtkQtChartSeriesModelCollection.h>

Inheritance diagram for vtkQtChartSeriesModelCollection:

[legend]

Collaboration diagram for vtkQtChartSeriesModelCollection:

[legend]

List of all members.

---

Detailed Description

The vtkQtChartSeriesModelCollection class is used to combine chart series models.

The collection maps the overall series index to the model specific series index.

Definition at line 38 of file vtkQtChartSeriesModelCollection.h.

Public Member Functions
	vtkQtChartSeriesModelCollection (QObject *parent=0)
	Creates a chart series model collection.
virtual	~vtkQtChartSeriesModelCollection ()
void	addSeriesModel (vtkQtChartSeriesModel *model)
	Adds a series model to the collection.
void	removeSeriesModel (vtkQtChartSeriesModel *model)
	Removes a series model from the collection.
int	getNumberOfSeriesModels () const
	Gets the number of series models in the collection.
vtkQtChartSeriesModel *	getSeriesModel (int index) const
	Gets the series model at the specified index.
int	mapSeriesIndexToCollectionIndex (vtkQtChartSeriesModel *model, int index) const
	Maps an index from a series model to an index in the collection.
vtkQtChartSeriesModel Methods
virtual int	getNumberOfSeries () const
	Gets the number of series in the model.
virtual int	getNumberOfSeriesValues (int series) const
	Gets the number of values in a series.
virtual QVariant	getSeriesName (int series) const
	Gets the name for the given series.
virtual QVariant	getSeriesValue (int series, int index, int component) const
	Gets the series value for the given index and component.
virtual QList< QVariant >	getSeriesRange (int series, int component) const
	Gets the value range for a series component.
Protected Slots
void	onSeriesAboutToBeInserted (int first, int last)
	Called when a series is about to be inserted into a model.
void	onSeriesInserted (int first, int last)
	Called when a series is inserted into a model.
void	onSeriesAboutToBeRemoved (int first, int last)
	Called when a series is about to be removed from a model.
void	onSeriesRemoved (int first, int last)
	Called when a series is removed from a model.

---

Constructor & Destructor Documentation

vtkQtChartSeriesModelCollection::vtkQtChartSeriesModelCollection

(

QObject *

parent = 0

)

Creates a chart series model collection.

Parameters:

parent

The parent object.

virtual vtkQtChartSeriesModelCollection::~vtkQtChartSeriesModelCollection

(

)

[inline, virtual]

Definition at line 48 of file vtkQtChartSeriesModelCollection.h.

---

Member Function Documentation

virtual int vtkQtChartSeriesModelCollection::getNumberOfSeries

(

)

const [virtual]

Gets the number of series in the model.

Returns:

The number of series in the model.

Implements vtkQtChartSeriesModel.

virtual int vtkQtChartSeriesModelCollection::getNumberOfSeriesValues

(

int

series

)

const [virtual]

Gets the number of values in a series.

Parameters:

series

The series index.

Returns:

The number of values in a series.

Implements vtkQtChartSeriesModel.

virtual QVariant vtkQtChartSeriesModelCollection::getSeriesName

(

int

series

)

const [virtual]

Gets the name for the given series.

Parameters:

series

The series index.

Returns:

The name for the given series.

Implements vtkQtChartSeriesModel.

virtual QVariant vtkQtChartSeriesModelCollection::getSeriesValue	(	int	series,
		int	index,
		int	component
	)			const [virtual]

Gets the series value for the given index and component.

Parameters:

	series	The series index.
	index	The index in the given series.
	component	The component index.

Returns:

The series value for the given index and component.

Implements vtkQtChartSeriesModel.

virtual QList<QVariant> vtkQtChartSeriesModelCollection::getSeriesRange	(	int	series,
		int	component
	)			const [virtual]

Gets the value range for a series component.

Parameters:

	series	The series index.
	component	The component index.

Returns:

The value range for a series component.

Implements vtkQtChartSeriesModel.

void vtkQtChartSeriesModelCollection::addSeriesModel

(

vtkQtChartSeriesModel *

model

)

Adds a series model to the collection.

Parameters:

model

The series model to add.

void vtkQtChartSeriesModelCollection::removeSeriesModel

(

vtkQtChartSeriesModel *

model

)

Removes a series model from the collection.

Parameters:

model

The series model to remove.

int vtkQtChartSeriesModelCollection::getNumberOfSeriesModels

(

)

const

Gets the number of series models in the collection.

Returns:

The number of series models in the collection.

vtkQtChartSeriesModel* vtkQtChartSeriesModelCollection::getSeriesModel

(

int

index

)

const

Gets the series model at the specified index.

Parameters:

index

The series model index.

Returns:

A pointer to the series model.

int vtkQtChartSeriesModelCollection::mapSeriesIndexToCollectionIndex	(	vtkQtChartSeriesModel *	model,
		int	index
	)			const

Maps an index from a series model to an index in the collection.

Parameters:

	model	The series model, must be a member of the model collection
	index	A series index from the given series model

Returns:

A series index in the series model collection. Returns 0 if model is not in collection.

void vtkQtChartSeriesModelCollection::onSeriesAboutToBeInserted	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is about to be inserted into a model.

This method uses the signal sender to determine which model has changed. It then maps the model series indexes to collection series indexes and re-emits the signal.

Parameters:

	first	The first model series index.
	last	The last model series index.

void vtkQtChartSeriesModelCollection::onSeriesInserted	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is inserted into a model.

Parameters:

	first	The first model series index.
	last	The last model series index.

void vtkQtChartSeriesModelCollection::onSeriesAboutToBeRemoved	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is about to be removed from a model.

Parameters:

	first	The first model series index.
	last	The last model series index.

void vtkQtChartSeriesModelCollection::onSeriesRemoved	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is removed from a model.

Parameters:

	first	The first model series index.
	last	The last model series index.

---

The documentation for this class was generated from the following file:

• dox/GUISupport/Qt/Chart/vtkQtChartSeriesModelCollection.h