QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingOutputVectorLayer Class Reference

A vector layer output for processing algorithms. More...

#include <qgsprocessingoutputs.h>

Inheritance diagram for QgsProcessingOutputVectorLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingOutputVectorLayer (const QString &name, const QString &description=QString(), QgsProcessing::SourceType type=QgsProcessing::TypeVectorAnyGeometry)
 Constructor for QgsProcessingOutputVectorLayer. More...
 
QgsProcessing::SourceType dataType () const
 Returns the layer type for the output layer. More...
 
void setDataType (QgsProcessing::SourceType type)
 Sets the layer type for the output layer. 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
 
QString description () const
 Returns the description for the output. More...
 
QString name () const
 Returns the name of the output. 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
QString mDescription
 Output description. More...
 
QString mName
 Output name. More...
 

Detailed Description

A vector layer output for processing algorithms.

Since
QGIS 3.0

Definition at line 158 of file qgsprocessingoutputs.h.

Constructor & Destructor Documentation

◆ QgsProcessingOutputVectorLayer()

QgsProcessingOutputVectorLayer::QgsProcessingOutputVectorLayer ( const QString &  name,
const QString &  description = QString(),
QgsProcessing::SourceType  type = QgsProcessing::TypeVectorAnyGeometry 
)

Constructor for QgsProcessingOutputVectorLayer.

Definition at line 27 of file qgsprocessingoutputs.cpp.

Member Function Documentation

◆ dataType()

QgsProcessing::SourceType QgsProcessingOutputVectorLayer::dataType ( ) const

Returns the layer type for the output layer.

See also
setDataType()

Definition at line 32 of file qgsprocessingoutputs.cpp.

◆ setDataType()

void QgsProcessingOutputVectorLayer::setDataType ( QgsProcessing::SourceType  type)

Sets the layer type for the output layer.

See also
dataType()

Definition at line 37 of file qgsprocessingoutputs.cpp.

◆ type()

QString QgsProcessingOutputVectorLayer::type ( ) const
inlineoverridevirtual

Unique output type name.

Implements QgsProcessingOutputDefinition.

Definition at line 171 of file qgsprocessingoutputs.h.

◆ typeName()

static QString QgsProcessingOutputVectorLayer::typeName ( )
inlinestatic

Returns the type name for the output class.

Definition at line 170 of file qgsprocessingoutputs.h.


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