VTK
Public Member Functions | Protected Slots | List of all members
vtkQtChartSeriesModelCollection Class Reference

The vtkQtChartSeriesModelCollection class is used to combine chart series models. More...

#include <vtkQtChartSeriesModelCollection.h>

Inheritance diagram for vtkQtChartSeriesModelCollection:
[legend]
Collaboration diagram for vtkQtChartSeriesModelCollection:
[legend]

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.
vtkQtChartSeriesModelgetSeriesModel (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.
- Public Member Functions inherited from vtkQtChartSeriesModel
 vtkQtChartSeriesModel (QObject *parent=0)
 Creates a chart series model.
virtual ~vtkQtChartSeriesModel ()

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.

Additional Inherited Members

- Signals inherited from vtkQtChartSeriesModel
void modelAboutToBeReset ()
 Emitted when the model is about to be reset.
void modelReset ()
 Emitted when the model has been reset.
void seriesAboutToBeInserted (int first, int last)
 Emitted when series will be inserted into the model.
void seriesInserted (int first, int last)
 Emitted when series have been inserted into the model.
void seriesAboutToBeRemoved (int first, int last)
 Emitted when series will be removed from the model.
void seriesRemoved (int first, int last)
 Emitted when series have been removed from the model.

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.

Constructor & Destructor Documentation

vtkQtChartSeriesModelCollection::vtkQtChartSeriesModelCollection ( QObject *  parent = 0)

Creates a chart series model collection.

Parameters
parentThe parent object.
virtual vtkQtChartSeriesModelCollection::~vtkQtChartSeriesModelCollection ( )
inlinevirtual

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
seriesThe 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
seriesThe 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
seriesThe series index.
indexThe index in the given series.
componentThe 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
seriesThe series index.
componentThe 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
modelThe series model to add.
void vtkQtChartSeriesModelCollection::removeSeriesModel ( vtkQtChartSeriesModel model)

Removes a series model from the collection.

Parameters
modelThe 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
indexThe 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
modelThe series model, must be a member of the model collection
indexA 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 
)
protectedslot

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
firstThe first model series index.
lastThe last model series index.
void vtkQtChartSeriesModelCollection::onSeriesInserted ( int  first,
int  last 
)
protectedslot

Called when a series is inserted into a model.

Parameters
firstThe first model series index.
lastThe last model series index.
void vtkQtChartSeriesModelCollection::onSeriesAboutToBeRemoved ( int  first,
int  last 
)
protectedslot

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

Parameters
firstThe first model series index.
lastThe last model series index.
void vtkQtChartSeriesModelCollection::onSeriesRemoved ( int  first,
int  last 
)
protectedslot

Called when a series is removed from a model.

Parameters
firstThe first model series index.
lastThe last model series index.

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