QGIS/python/core/processing/models/qgsprocessingmodeloutput.sip.in

97 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodeloutput.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProcessingModelOutput : QgsProcessingModelComponent
{
%Docstring
Represents a final output created by the model.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsprocessingmodeloutput.h"
%End
public:
QgsProcessingModelOutput( const QString &name = QString(), const QString &description = QString() );
%Docstring
Constructor for QgsProcessingModelOutput with the specified ``name`` and ``description``.
%End
QString name() const;
%Docstring
Returns the model output name.
.. seealso:: :py:func:`setName`
%End
void setName( const QString &name );
%Docstring
Sets the model output ``name``.
.. seealso:: :py:func:`name`
%End
QString childId() const;
%Docstring
Returns the child algorithm ID from which this output is generated.
.. seealso:: :py:func:`setChildId`
%End
void setChildId( const QString &id );
%Docstring
Sets the child algorithm ``id`` from which this output is generated.
.. seealso:: :py:func:`childId`
%End
QString childOutputName() const;
%Docstring
Returns the child algorithm output name from which this output is generated.
.. seealso:: :py:func:`setOutputName`
%End
void setChildOutputName( const QString &name );
%Docstring
Sets the child algorithm output ``name`` from which this output is generated.
.. seealso:: :py:func:`outputName`
%End
QVariant toVariant() const;
%Docstring
Saves this output to a QVariant.
.. seealso:: :py:func:`loadVariant`
%End
bool loadVariant( const QVariantMap &map );
%Docstring
Loads this output from a QVariantMap.
.. seealso:: :py:func:`toVariant`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodeloutput.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/