qgis_raiseexception: QGIS algorithm - Raise exception

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Raise exception

Description

QGIS Algorithm provided by QGIS (native c++) Raise exception (native:raiseexception). Raises an exception and cancels a model's execution. This algorithm raises an exception and cancels a model's execution. The exception message can be customized, and optionally an expression based condition can be specified. If an expression condition is used, then the exception will only be raised if the expression result is true. A false result indicates that no exception will be raised, and the model execution can continue uninterrupted.

Usage

qgis_raiseexception(
  MESSAGE = qgisprocess:::qgis_default_value(),
  CONDITION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

MESSAGE	string - Error message. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
CONDITION	expression - Condition. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.complete_output	logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.messages	logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

No output description provided.

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.