Skip to content

Class CogoOperationPointAtXYZ

ClassList > CogoOperationPointAtXYZ

A COGO operation to generate a point at a given XY location.

  • #include <cogooperation.h>

Inherits the following classes: CogoOperation

Public Functions

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

Public Functions inherited from CogoOperation

See CogoOperation

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 CogoOperationPointAtXYZ

inline CogoOperationPointAtXYZ::CogoOperationPointAtXYZ ()

function checkReadiness

virtual bool CogoOperationPointAtXYZ::checkReadiness (
    const QVariantMap & parameters,
    Qgis::WkbType wkbType=Qgis::WkbType::Unknown
) override 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

Implements CogoOperation::checkReadiness

function displayName

inline virtual QString CogoOperationPointAtXYZ::displayName () override const

Returns a translatable display name.

Implements CogoOperation::displayName

function execute

virtual bool CogoOperationPointAtXYZ::execute (
    RubberbandModel * rubberbandModel,
    const QVariantMap & parameters,
    Qgis::WkbType wkbType
) override 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

Implements CogoOperation::execute

function icon

inline virtual QString CogoOperationPointAtXYZ::icon () override const

Returns the icon name.

Implements CogoOperation::icon

function name

inline virtual QString CogoOperationPointAtXYZ::name () override const

Returns the name string identifier.

Implements CogoOperation::name

function parameters

virtual QList< CogoParameter > CogoOperationPointAtXYZ::parameters (
    Qgis::WkbType wkbType
) override 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

Implements CogoOperation::parameters

function visualGuides

virtual QList< CogoVisualGuide > CogoOperationPointAtXYZ::visualGuides (
    const QVariantMap & parameters,
    QgsQuickMapSettings * mapSettings
) override 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

Implements CogoOperation::visualGuides

function ~CogoOperationPointAtXYZ

CogoOperationPointAtXYZ::~CogoOperationPointAtXYZ () = default

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