Class QfCogoOperation

A COGO operation.

#include <qfcogooperation.h>

Inherited by the following classes: QfCogoOperationPointAtDistanceAngle, QfCogoOperationPointAtIntersectionCircles, QfCogoOperationPointAtXYZ

Public Functions

Type	Name
	QfCogoOperation ()
virtual bool	checkReadiness (const QVariantMap & parameters, Qgis::WkbType wkbType=Qgis::WkbType::Unknown) const
virtual QString	displayName () const
virtual bool	execute (QfRubberbandModel * rubberbandModel, const QVariantMap & parameters, Qgis::WkbType wkbType=Qgis::WkbType::Unknown) const
virtual QString	icon () const
virtual QString	name () const
virtual QList< QfCogoParameter >	parameters (Qgis::WkbType wkbType=Qgis::WkbType::Unknown) const
virtual QList< QfCogoVisualGuide >	visualGuides (const QVariantMap & parameters, QgsQuickMapSettings * mapSettings) const
virtual	~QfCogoOperation () = default

Public Functions Documentation

function QfCogoOperation

inline QfCogoOperation::QfCogoOperation ()

The COGO operation constructor.

function checkReadiness

inline virtual bool QfCogoOperation::checkReadiness (
    const QVariantMap & parameters,
    Qgis::WkbType wkbType=Qgis::WkbType::Unknown
) const

Returns TRUE is the provided parameters allow for the operation to be executed.

Parameters:

parameters the parameters to be validated for readiness
wkbType An optional WKB type to reflect ability of the geometry being digitized

function displayName

inline virtual QString QfCogoOperation::displayName () const

Returns a translatable display name.

function execute

inline virtual bool QfCogoOperation::execute (
    QfRubberbandModel * rubberbandModel,
    const QVariantMap & parameters,
    Qgis::WkbType wkbType=Qgis::WkbType::Unknown
) const

Executes the operation and add generated vertex or vertices into the rubberband model.

Parameters:

rubberbandModel the rubberband model within which one or more vertices will be added
parameters the parameters used to execute the operation
wkbType An optional WKB type to reflect ability of the geometry being digitized

function icon

inline virtual QString QfCogoOperation::icon () const

Returns the icon name.

function name

inline virtual QString QfCogoOperation::name () const

Returns the name string identifier.

function parameters

inline virtual QList< QfCogoParameter > QfCogoOperation::parameters (
    Qgis::WkbType wkbType=Qgis::WkbType::Unknown
) const

Returns the list of available parameters to configure the operation.

Parameters:

wkbType An optional WKB type to reflect ability of the geometry being digitized

function visualGuides

inline virtual QList< QfCogoVisualGuide > QfCogoOperation::visualGuides (
    const QVariantMap & parameters,
    QgsQuickMapSettings * mapSettings
) const

Returns a list of visual guides based on provided parameters.

Parameters:

parameters the parameters used to generate the visual guides
mapSettings the map settings object used to georeference the visual guides

function ~QfCogoOperation

virtual QfCogoOperation::~QfCogoOperation () = default

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