An abstract vector layer plot data gatherer base class. More...

#include <qgsvectorlayerplotdatagatherer.h>

Inheritance diagram for QgsVectorLayerAbstractPlotDataGatherer:

[legend]

Public Member Functions
	QgsVectorLayerAbstractPlotDataGatherer ()=default
	~QgsVectorLayerAbstractPlotDataGatherer () override=default
virtual QgsPlotData	data () const =0
	Returns the plot data.
void	setExpressionContext (const QgsExpressionContext &context)
	Sets the expression context used when evaluating values being gathered.
void	setFeatureIterator (QgsFeatureIterator &iterator)
	Sets the feature iterator used to gather data from.
Public Member Functions inherited from QgsTask
	QgsTask (const QString &description=QString(), QgsTask::Flags flags=AllFlags)
	Constructor for QgsTask.
	~QgsTask () override
void	addSubTask (QgsTask *subTask, const QgsTaskList &dependencies=QgsTaskList(), SubTaskDependency subTaskDependency=SubTaskIndependent)
	Adds a subtask to this task.
bool	canCancel () const
	Returns `true` if the task can be canceled.
virtual void	cancel ()
	Notifies the task that it should terminate.
QList< QgsMapLayer * >	dependentLayers () const
	Returns the list of layers on which the task depends.
QString	description () const
	Returns the task's description.
qint64	elapsedTime () const
	Returns the elapsed time since the task commenced, in milliseconds.
Flags	flags () const
	Returns the flags associated with the task.
void	hold ()
	Places the task on hold.
bool	isActive () const
	Returns `true` if the task is active, ie it is not complete and has not been canceled.
double	progress () const
	Returns the task's progress (between 0.0 and 100.0).
void	setDependentLayers (const QList< QgsMapLayer * > &dependentLayers)
	Sets a list of layers on which the task depends.
void	setDescription (const QString &description)
	Sets the task's description.
TaskStatus	status () const
	Returns the current task status.
void	unhold ()
	Releases the task from being held.
bool	waitForFinished (int timeout=30000)
	Blocks the current thread until the task finishes or a maximum of timeout milliseconds.

Protected Attributes
QgsExpressionContext	mExpressionContext
QgsFeatureIterator	mIterator

Additional Inherited Members
Public Types inherited from QgsTask
enum	Flag { CanCancel = 1 << 1 , CancelWithoutPrompt = 1 << 2 , Hidden = 1 << 3 , Silent = 1 << 4 , AllFlags = CanCancel }
	Task flags. More...
typedef QFlags< Flag >	Flags
enum	SubTaskDependency { SubTaskIndependent = 0 , ParentDependsOnSubTask }
	Controls how subtasks relate to their parent task. More...
enum	TaskStatus { Queued , OnHold , Running , Complete , Terminated }
	Status of tasks. More...
Signals inherited from QgsTask
void	begun ()
	Will be emitted by task to indicate its commencement.
void	progressChanged (double progress)
	Will be emitted by task when its progress changes.
void	statusChanged (int status)
	Will be emitted by task when its status changes.
void	taskCompleted ()
	Will be emitted by task to indicate its successful completion.
void	taskTerminated ()
	Will be emitted by task if it has terminated for any reason other then completion (e.g., when a task has been canceled or encountered an internal error).
Protected Slots inherited from QgsTask
void	setProgress (double progress)
	Sets the task's current progress.
Protected Member Functions inherited from QgsTask
virtual void	finished (bool result)
	If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether through successful completion or via early termination).
bool	isCanceled () const
	Will return `true` if task should terminate ASAP.
virtual bool	run ()=0
	Performs the task's operation.

Detailed Description

An abstract vector layer plot data gatherer base class.

Since: QGIS 4.0

Definition at line 35 of file qgsvectorlayerplotdatagatherer.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerAbstractPlotDataGatherer()

QgsVectorLayerAbstractPlotDataGatherer::QgsVectorLayerAbstractPlotDataGatherer ( )

default

◆ ~QgsVectorLayerAbstractPlotDataGatherer()

QgsVectorLayerAbstractPlotDataGatherer::~QgsVectorLayerAbstractPlotDataGatherer ( )

overridedefault

Member Function Documentation

◆ data()

virtual QgsPlotData QgsVectorLayerAbstractPlotDataGatherer::data ( ) const

pure virtual

Returns the plot data.

Implemented in QgsVectorLayerXyPlotDataGatherer.

◆ setExpressionContext()

void QgsVectorLayerAbstractPlotDataGatherer::setExpressionContext ( const QgsExpressionContext & context )

inline

Sets the expression context used when evaluating values being gathered.

Definition at line 71 of file qgsvectorlayerplotdatagatherer.h.

◆ setFeatureIterator()

void QgsVectorLayerAbstractPlotDataGatherer::setFeatureIterator ( QgsFeatureIterator & iterator )

inline

Sets the feature iterator used to gather data from.

Definition at line 68 of file qgsvectorlayerplotdatagatherer.h.

Member Data Documentation

◆ mExpressionContext

QgsExpressionContext QgsVectorLayerAbstractPlotDataGatherer::mExpressionContext

protected

Definition at line 76 of file qgsvectorlayerplotdatagatherer.h.

◆ mIterator

QgsFeatureIterator QgsVectorLayerAbstractPlotDataGatherer::mIterator