Class CogoExecutor

ClassList > CogoExecutor

A COGO operation exeuctor object allowing for property-driven access to COGO operations.

• #include <cogoexecutor.h>

Inherits the following classes: QObject

Public Properties

Type	Name
property bool	isReady
property QgsQuickMapSettings *	mapSettings
property QString	name
property QVariantMap	parameterValues
property QList< CogoParameter >	parameters
property RubberbandModel *	rubberbandModel
property QList< CogoVisualGuide >	visualGuides

Public Signals

Type	Name
signal void	isReadyChanged
signal void	mapSettingsChanged
signal void	nameChanged
signal void	parameterValuesChanged
signal void	parametersChanged
signal void	rubberbandModelChanged
signal void	visualGuidesChanged

Public Functions

Type	Name
	CogoExecutor (QObject * parent=nullptr)
Q_INVOKABLE bool	execute ()
bool	isReady () const
QgsQuickMapSettings *	mapSettings () const
QString	name () const
QVariantMap	parameterValues () const
QList< CogoParameter >	parameters () const
RubberbandModel *	rubberbandModel () const
void	setMapSettings (QgsQuickMapSettings * mapSettings)
void	setName (const QString & name)
void	setParameterValues (const QVariantMap & parameterValues)
void	setRubberbandModel (RubberbandModel * rubberbandModel)
QList< CogoVisualGuide >	visualGuides () const

Public Properties Documentation

property isReady [1/2]

bool CogoExecutor::isReady;

COGO operation paired with the parameters' readiness to be executed.

---

property mapSettings [1/2]

QgsQuickMapSettings * CogoExecutor::mapSettings;

The map settings used when generating visual guides.

---

property name [1/2]

QString CogoExecutor::name;

The name of the COGO operation to be executed.

---

property parameterValues [1/2]

QVariantMap CogoExecutor::parameterValues;

The map of parameter values to be used when executing the COGO operation.

---

property parameters [1/2]

QList<CogoParameter> CogoExecutor::parameters;

The list of parameters of the COGO operation to be executed.

---

property rubberbandModel [1/2]

RubberbandModel * CogoExecutor::rubberbandModel;

The rubberband model to be used when executing the COGO operation.

---

property visualGuides [1/2]

QList<CogoVisualGuide> CogoExecutor::visualGuides;

The visual guides returned by the COGO operation paired with the parameters.

---

Public Signals Documentation

signal isReadyChanged

void CogoExecutor::isReadyChanged;

COGO operation paired with the parameters' readiness to be executed.

---

signal mapSettingsChanged

void CogoExecutor::mapSettingsChanged;

The map settings used when generating visual guides.

---

signal nameChanged

void CogoExecutor::nameChanged;

The name of the COGO operation to be executed.

---

signal parameterValuesChanged

void CogoExecutor::parameterValuesChanged;

---

signal parametersChanged

void CogoExecutor::parametersChanged;

The list of parameters of the COGO operation to be executed.

---

signal rubberbandModelChanged

void CogoExecutor::rubberbandModelChanged;

The rubberband model to be used when executing the COGO operation.

---

signal visualGuidesChanged

void CogoExecutor::visualGuidesChanged;

The visual guides returned by the COGO operation paired with the parameters.

---

Public Functions Documentation

function CogoExecutor

explicit CogoExecutor::CogoExecutor (
    QObject * parent=nullptr
) 

---

function execute

Q_INVOKABLE bool CogoExecutor::execute () 

Executes the COGO operation.

---

function isReady [2/2]

inline bool CogoExecutor::isReady () const

COGO operation paired with the parameters' readiness to be executed.

---

function mapSettings [2/2]

inline QgsQuickMapSettings * CogoExecutor::mapSettings () const

The map settings used when generating visual guides.

---

function name [2/2]

inline QString CogoExecutor::name () const

The name of the COGO operation to be executed.

---

function parameterValues [2/2]

inline QVariantMap CogoExecutor::parameterValues () const

The map of parameter values to be used when executing the COGO operation.

---

function parameters [2/2]

inline QList< CogoParameter > CogoExecutor::parameters () const

The list of parameters of the COGO operation to be executed.

---

function rubberbandModel [2/2]

inline RubberbandModel * CogoExecutor::rubberbandModel () const

The rubberband model to be used when executing the COGO operation.

---

function setMapSettings

void CogoExecutor::setMapSettings (
    QgsQuickMapSettings * mapSettings
) 

The map settings used when generating visual guides.

---

function setName

void CogoExecutor::setName (
    const QString & name
) 

The name of the COGO operation to be executed.

---

function setParameterValues

void CogoExecutor::setParameterValues (
    const QVariantMap & parameterValues
) 

The map of parameter values to be used when executing the COGO operation.

---

function setRubberbandModel

void CogoExecutor::setRubberbandModel (
    RubberbandModel * rubberbandModel
) 

The rubberband model to be used when executing the COGO operation.

---

function visualGuides [2/2]

QList< CogoVisualGuide > CogoExecutor::visualGuides () const

The visual guides returned by the COGO operation paired with the parameters.

---

---

The documentation for this class was generated from the following file src/core/cogo/cogoexecutor.h