QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A coordinate operation parameter for processing algorithms, for selection between available coordinate operations to use when projecting between a source and destination coordinate reference system. More...
#include <qgsprocessingparameters.h>
Public Member Functions | |
QgsProcessingParameterCoordinateOperation (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &sourceCrsParameterName=QString(), const QString &destinationCrsParameterName=QString(), const QVariant &staticSourceCrs=QVariant(), const QVariant &staticDestinationCrs=QVariant(), bool optional=false) | |
Constructor for QgsProcessingParameterCoordinateOperation. | |
QString | asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass) const override |
Returns the parameter definition as a Python command which can be used within a Python Processing script. | |
QString | asScriptCode () const override |
Returns the parameter definition encoded in a string which can be used within a Processing script. | |
QgsProcessingParameterDefinition * | clone () const override |
Creates a clone of the parameter definition. | |
QStringList | dependsOnOtherParameters () const override |
Returns a list of other parameter names on which this parameter is dependent (e.g. | |
QVariant | destinationCrs () const |
Returns the static destination CRS, or an invalid value if this is not set. | |
QString | destinationCrsParameterName () const |
Returns the name of the destination CRS parameter, or an empty string if this is not set. | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. | |
void | setDestinationCrs (const QVariant &crs) |
Sets the static destination crs. | |
void | setDestinationCrsParameterName (const QString &name) |
Sets the name of the destination CRS parameter. | |
void | setSourceCrs (const QVariant &crs) |
Sets the static source crs. | |
void | setSourceCrsParameterName (const QString &name) |
Sets the name of the source CRS parameter. | |
QVariant | sourceCrs () const |
Returns the static source CRS, or an invalid value if this is not set. | |
QString | sourceCrsParameterName () const |
Returns the name of the source CRS parameter, or an empty string if this is not set. | |
QVariantMap | toVariantMap () const override |
Saves this parameter to a QVariantMap. | |
QString | type () const override |
Unique parameter type name. | |
QString | valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const override |
Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command. | |
Public Member Functions inherited from QgsProcessingParameterDefinition | |
QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString()) | |
Constructor for QgsProcessingParameterDefinition. | |
virtual | ~QgsProcessingParameterDefinition ()=default |
QStringList | additionalExpressionContextVariables () const |
Returns a list of additional expression context variables which are available for use when evaluating this parameter. | |
QgsProcessingAlgorithm * | algorithm () const |
Returns a pointer to the algorithm which owns this parameter. | |
virtual bool | checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const |
Checks whether the specified input value is acceptable for the parameter. | |
QVariant | defaultValue () const |
Returns the default value for the parameter. | |
QVariant | defaultValueForGui () const |
Returns the default value to use for the parameter in a GUI. | |
QString | description () const |
Returns the description for the parameter. | |
QString | dynamicLayerParameterName () const |
Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. | |
QgsPropertyDefinition | dynamicPropertyDefinition () const |
Returns the property definition for dynamic properties. | |
Qgis::ProcessingParameterFlags | flags () const |
Returns any flags associated with the parameter. | |
QVariant | guiDefaultValueOverride () const |
Returns the default value to use in the GUI for the parameter. | |
QString | help () const |
Returns the help for the parameter. | |
virtual bool | isDestination () const |
Returns true if this parameter represents a file or layer destination, e.g. | |
bool | isDynamic () const |
Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. | |
QVariantMap & | metadata () |
Returns the parameter's freeform metadata. | |
QVariantMap | metadata () const |
Returns the parameter's freeform metadata. | |
QString | name () const |
Returns the name of the parameter. | |
QgsProcessingProvider * | provider () const |
Returns a pointer to the provider for the algorithm which owns this parameter. | |
void | setAdditionalExpressionContextVariables (const QStringList &variables) |
Sets a list of additional expression context variables which are available for use when evaluating this parameter. | |
void | setDefaultValue (const QVariant &value) |
Sets the default value for the parameter. | |
void | setDescription (const QString &description) |
Sets the description for the parameter. | |
void | setDynamicLayerParameterName (const QString &name) |
Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. | |
void | setDynamicPropertyDefinition (const QgsPropertyDefinition &definition) |
Sets the property definition for dynamic properties. | |
void | setFlags (Qgis::ProcessingParameterFlags flags) |
Sets the flags associated with the parameter. | |
void | setGuiDefaultValueOverride (const QVariant &value) |
Sets the default value to use for the parameter in GUI widgets. | |
void | setHelp (const QString &help) |
Sets the help for the parameter. | |
void | setIsDynamic (bool dynamic) |
Sets whether the parameter is dynamic, and can support data-defined values (i.e. | |
void | setMetadata (const QVariantMap &metadata) |
Sets the parameter's freeform metadata. | |
void | setName (const QString &name) |
Sets the name of the parameter. | |
virtual QString | toolTip () const |
Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type). | |
virtual QVariant | valueAsJsonObject (const QVariant &value, QgsProcessingContext &context) const |
Returns a version of the parameter input value, which is suitable for use in a JSON object. | |
virtual QString | valueAsPythonComment (const QVariant &value, QgsProcessingContext &context) const |
Returns a Python comment explaining a parameter value, or an empty string if no comment is required. | |
virtual QString | valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a string version of the parameter input value (if possible). | |
virtual QStringList | valueAsStringList (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a string list version of the parameter input value (if possible). | |
Static Public Member Functions | |
static QgsProcessingParameterCoordinateOperation * | fromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition) |
Creates a new parameter using the definition from a script code. | |
static QString | typeName () |
Returns the type name for the parameter class. | |
Additional Inherited Members | |
Public Types inherited from QgsProcessingParameterDefinition | |
enum class | ValueAsStringFlag : int { AllowMapLayerValues = 1 << 0 } |
Flags for passing to the valueAsStringPrivate() method. More... | |
typedef QFlags< ValueAsStringFlag > | ValueAsStringFlags |
Protected Member Functions inherited from QgsProcessingParameterDefinition | |
QVariant | defaultGuiValueFromSetting () const |
Default gui value for an algorithm parameter from settings. | |
QVariant | valueAsJsonObjectPrivate (const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const |
Internal method for evaluating values as JSON objects. | |
QString | valueAsStringPrivate (const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const |
Internal method for evaluating values as string. | |
Protected Attributes inherited from QgsProcessingParameterDefinition | |
QStringList | mAdditionalExpressionVariables |
Additional expression context variables exposed for use by this parameter. | |
QgsProcessingAlgorithm * | mAlgorithm = nullptr |
Pointer to algorithm which owns this parameter. | |
QVariant | mDefault |
Default value for parameter. | |
QString | mDescription |
Parameter description. | |
QString | mDynamicLayerParameterName |
Linked vector layer parameter name for dynamic properties. | |
Qgis::ProcessingParameterFlags | mFlags |
Parameter flags. | |
QVariant | mGuiDefault |
Default value for parameter in GUI. | |
QString | mHelp |
Parameter help. | |
bool | mIsDynamic = false |
True for dynamic parameters, which can have data-defined (QgsProperty) based values. | |
QVariantMap | mMetadata |
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior. | |
QString | mName |
Parameter name. | |
QgsPropertyDefinition | mPropertyDefinition |
Data defined property definition. | |
A coordinate operation parameter for processing algorithms, for selection between available coordinate operations to use when projecting between a source and destination coordinate reference system.
QgsProcessingParameterCoordinateOperation should be evaluated by calling QgsProcessingAlgorithm::parameterAsString().
Definition at line 4022 of file qgsprocessingparameters.h.
QgsProcessingParameterCoordinateOperation::QgsProcessingParameterCoordinateOperation | ( | const QString & | name, |
const QString & | description = QString() , |
||
const QVariant & | defaultValue = QVariant() , |
||
const QString & | sourceCrsParameterName = QString() , |
||
const QString & | destinationCrsParameterName = QString() , |
||
const QVariant & | staticSourceCrs = QVariant() , |
||
const QVariant & | staticDestinationCrs = QVariant() , |
||
bool | optional = false |
||
) |
Constructor for QgsProcessingParameterCoordinateOperation.
Definition at line 8338 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns the parameter definition as a Python command which can be used within a Python Processing script.
The outputType argument specifies the desired output format for the Python string, i.e. the intended end use of the generated Python code.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 8398 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns the parameter definition encoded in a string which can be used within a Processing script.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 8387 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 8348 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns a list of other parameter names on which this parameter is dependent (e.g.
field parameters which depend on a parent layer parameter).
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 8426 of file qgsprocessingparameters.cpp.
|
inline |
Returns the static destination CRS, or an invalid value if this is not set.
Definition at line 4100 of file qgsprocessingparameters.h.
|
inline |
Returns the name of the destination CRS parameter, or an empty string if this is not set.
Definition at line 4072 of file qgsprocessingparameters.h.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 8456 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 8446 of file qgsprocessingparameters.cpp.
|
inline |
Sets the static destination crs.
Definition at line 4107 of file qgsprocessingparameters.h.
|
inline |
Sets the name of the destination CRS parameter.
Use an empty string if this is not required.
Definition at line 4079 of file qgsprocessingparameters.h.
|
inline |
Sets the static source crs.
Definition at line 4093 of file qgsprocessingparameters.h.
|
inline |
Sets the name of the source CRS parameter.
Use an empty string if this is not required.
Definition at line 4065 of file qgsprocessingparameters.h.
|
inline |
Returns the static source CRS, or an invalid value if this is not set.
Definition at line 4086 of file qgsprocessingparameters.h.
|
inline |
Returns the name of the source CRS parameter, or an empty string if this is not set.
Definition at line 4058 of file qgsprocessingparameters.h.
|
overridevirtual |
Saves this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method and then extend the result with additional properties.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 8436 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 4039 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 4037 of file qgsprocessingparameters.h.
|
overridevirtual |
Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 8353 of file qgsprocessingparameters.cpp.