QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingOutputFile Class Reference

A file output for processing algorithms. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputFile:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingOutputFile (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputFile. More...
 
QString type () const override
 Unique output type name. More...
 
- Public Member Functions inherited from QgsProcessingOutputDefinition
 QgsProcessingOutputDefinition (const QString &name, const QString &description=QString())
 Constructor for QgsProcessingOutputDefinition. More...
 
virtual ~QgsProcessingOutputDefinition ()=default
 
bool autoCreated () const
 Returns true if the output was automatically created when adding a parameter. More...
 
QString description () const
 Returns the description for the output. More...
 
QString name () const
 Returns the name of the output. More...
 
void setAutoCreated (bool autoCreated)
 Sets whether an output was automatically created when adding a parameter. More...
 
void setDescription (const QString &description)
 Sets the description for the output. More...
 
void setName (const QString &name)
 Sets the name of the output. More...
 

Static Public Member Functions

static QString typeName ()
 Returns the type name for the output class. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsProcessingOutputDefinition
bool mAutoCreated = false
 
QString mDescription
 Output description. More...
 
QString mName
 Output name. More...
 

Detailed Description

A file output for processing algorithms.

Since
QGIS 3.0

Definition at line 401 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputFile()

QgsProcessingOutputFile::QgsProcessingOutputFile ( const QString &  name,
const QString &  description = QString() 
)

Constructor for QgsProcessingOutputFile.

Definition at line 68 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ type()

QString QgsProcessingOutputFile::type ( ) const
inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 414 of file qgsprocessingoutputs.h.

◆ typeName()

static QString QgsProcessingOutputFile::typeName ( )
inlinestatic

Returns the type name for the output class.

Definition at line 413 of file qgsprocessingoutputs.h.


The documentation for this class was generated from the following files: