VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkQtChartSeriesDomainGroup Class Reference

The vtkQtChartSeriesDomainGroup class is used to group together series with similar domains. More...

#include <vtkQtChartSeriesDomainGroup.h>

Public Member Functions

 vtkQtChartSeriesDomainGroup (bool sortSeries=false)
 Creates a chart series domain group. More...
 
virtual ~vtkQtChartSeriesDomainGroup ()
 
int getNumberOfGroups () const
 Gets the number of groups. More...
 
int getNumberOfSeries (int group) const
 Gets the number of series in the given group. More...
 
QList< int > getGroup (int group) const
 Gets the list of series in the given group. More...
 
int findGroup (int series) const
 Finds the group index for the given series. More...
 
virtual void prepareInsert (int seriesFirst, int seriesLast)
 Updates the series indexes prior to an insert. More...
 
virtual void insertSeries (int series, int group)
 Inserts a new series in the specified group. More...
 
void finishInsert ()
 Sorts the newly inserted series if sorting is enabled. More...
 
virtual int removeSeries (int series)
 Removes a series from its group. More...
 
virtual void finishRemoval (int seriesFirst=-1, int seriesLast=-1)
 Updates the series indexes after a removal. More...
 
virtual void clear ()
 Removes all the series groups. More...
 

Static Public Member Functions

static void mergeSeriesLists (QList< int > &target, const QList< int > &source)
 Merges two sorted lists of series indexes. More...
 

Protected Member Functions

virtual void insertGroup (int group)
 Inserts a new group in the list. More...
 
virtual void removeGroup (int group)
 Removes a group from the list. More...
 

Detailed Description

The vtkQtChartSeriesDomainGroup class is used to group together series with similar domains.

Definition at line 35 of file vtkQtChartSeriesDomainGroup.h.

Constructor & Destructor Documentation

vtkQtChartSeriesDomainGroup::vtkQtChartSeriesDomainGroup ( bool  sortSeries = false)

Creates a chart series domain group.

Parameters
sortSeriesTrue if the series should be sorted when added to a group.
virtual vtkQtChartSeriesDomainGroup::~vtkQtChartSeriesDomainGroup ( )
inlinevirtual

Definition at line 43 of file vtkQtChartSeriesDomainGroup.h.

Member Function Documentation

int vtkQtChartSeriesDomainGroup::getNumberOfGroups ( ) const

Gets the number of groups.

Returns
The number of groups.
int vtkQtChartSeriesDomainGroup::getNumberOfSeries ( int  group) const

Gets the number of series in the given group.

Parameters
groupThe group index.
Returns
The number of series in the group.
QList<int> vtkQtChartSeriesDomainGroup::getGroup ( int  group) const

Gets the list of series in the given group.

Parameters
groupThe group index.
Returns
The list of series in the given group.
int vtkQtChartSeriesDomainGroup::findGroup ( int  series) const

Finds the group index for the given series.

Parameters
seriesThe series to look up.
Returns
The group index of the series or -1 on failure.
virtual void vtkQtChartSeriesDomainGroup::prepareInsert ( int  seriesFirst,
int  seriesLast 
)
virtual

Updates the series indexes prior to an insert.

Parameters
seriesFirstThe first index to be inserted.
seriesLastThe last index to be inserted.
virtual void vtkQtChartSeriesDomainGroup::insertSeries ( int  series,
int  group 
)
virtual

Inserts a new series in the specified group.

Parameters
seriesThe new series.
groupThe group index.
void vtkQtChartSeriesDomainGroup::finishInsert ( )

Sorts the newly inserted series if sorting is enabled.

virtual int vtkQtChartSeriesDomainGroup::removeSeries ( int  series)
virtual

Removes a series from its group.

Parameters
seriesThe series to remove.
Returns
The series group index.
virtual void vtkQtChartSeriesDomainGroup::finishRemoval ( int  seriesFirst = -1,
int  seriesLast = -1 
)
virtual

Updates the series indexes after a removal.

Parameters
seriesFirstThe first index removed.
seriesLastThe last index removed.
virtual void vtkQtChartSeriesDomainGroup::clear ( )
virtual

Removes all the series groups.

static void vtkQtChartSeriesDomainGroup::mergeSeriesLists ( QList< int > &  target,
const QList< int > &  source 
)
static

Merges two sorted lists of series indexes.

Parameters
targetThe list where the result will be stored.
sourceThe list of seires to merge.
virtual void vtkQtChartSeriesDomainGroup::insertGroup ( int  group)
protectedvirtual

Inserts a new group in the list.

Subclasses can override this method to set up data structures associated with the series group.

Parameters
groupThe group index.
virtual void vtkQtChartSeriesDomainGroup::removeGroup ( int  group)
protectedvirtual

Removes a group from the list.

Subclasses should override this method to clean up any data structures associated with the series group.

Parameters
groupThe group index.

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