Class CogoOperation

ClassList > CogoOperation

A COGO operation.

• #include <cogooperation.h>

Inherited by the following classes: CogoOperationPointAtDistanceAngle, CogoOperationPointAtIntersectionCircles, CogoOperationPointAtXYZ

Public Functions

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

Public Functions Documentation

function CogoOperation

inline CogoOperation::CogoOperation () 

The COGO operation constructor.

---

function checkReadiness

inline virtual bool CogoOperation::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 CogoOperation::displayName () const

Returns a translatable display name.

---

function execute

inline virtual bool CogoOperation::execute (
    RubberbandModel * 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 CogoOperation::icon () const

Returns the icon name.

---

function name

inline virtual QString CogoOperation::name () const

Returns the name string identifier.

---

function parameters

inline virtual QList< CogoParameter > CogoOperation::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< CogoVisualGuide > CogoOperation::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 ~CogoOperation

virtual CogoOperation::~CogoOperation () = default

---

---

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