QGIS API Documentation 4.3.0-Master (bd2f5e21fd1)
Loading...
Searching...
No Matches
QgsEsriArcadeReturnStatement Class Reference

Represents a return statement. More...

#include <qgsesriarcadescript.h>

Inheritance diagram for QgsEsriArcadeReturnStatement:

Public Member Functions

 QgsEsriArcadeReturnStatement (QgsEsriArcadeExpression *expression=nullptr)
 Constructor for QgsEsriArcadeReturnStatement.
void accept (QgsEsriArcadeVisitor &visitor) const override
 Accepts a visitor to traverse the node.
QgsEsriArcadeNode * clone () const override
 Creates a copy of the node.
QString dump () const override
 Returns the formatted script representation of the node.
QgsEsriArcadeExpression * expression () const
 Returns the expression returned by the statement, or nullptr if void return.
QgsEsriArcadeNode::NodeType nodeType () const override
 Returns the node type.
Public Member Functions inherited from QgsEsriArcadeStatement
 ~QgsEsriArcadeStatement () override=default
Public Member Functions inherited from QgsEsriArcadeNode
virtual ~QgsEsriArcadeNode ()=default

Additional Inherited Members

Public Types inherited from QgsEsriArcadeNode
enum class  NodeType {
  BlockStatement , VariableDeclarationStatement , ReturnStatement , AssignmentStatement ,
  FunctionDeclarationStatement , ExpressionStatement , LiteralExpression , VariableReferenceExpression ,
  ProfileVariableReferenceExpression , MemberAccessExpression , BinaryOperatorExpression , UnaryOperatorExpression ,
  FunctionCallExpression , IndexExpression , ArrayLiteralExpression , DictionaryLiteralExpression ,
  IfStatement , ForStatement , ForInStatement , WhileStatement ,
  BreakStatement , ContinueStatement
}
 Node type identifier. More...

Detailed Description

Represents a return statement.

For example return x + y;.

Since
QGIS 4.4

Definition at line 405 of file qgsesriarcadescript.h.

Constructor & Destructor Documentation

◆ QgsEsriArcadeReturnStatement()

QgsEsriArcadeReturnStatement::QgsEsriArcadeReturnStatement ( QgsEsriArcadeExpression * expression = nullptr)
explicit

Constructor for QgsEsriArcadeReturnStatement.

Ownership of expression is transferred to this statement.

Definition at line 140 of file qgsesriarcadescript.cpp.

Member Function Documentation

◆ accept()

void QgsEsriArcadeReturnStatement::accept ( QgsEsriArcadeVisitor & visitor) const
overridevirtual

Accepts a visitor to traverse the node.

Implements QgsEsriArcadeNode.

Definition at line 157 of file qgsesriarcadescript.cpp.

◆ clone()

QgsEsriArcadeNode * QgsEsriArcadeReturnStatement::clone ( ) const
overridevirtual

Creates a copy of the node.

Caller takes ownership of the returned object.

Implements QgsEsriArcadeNode.

Definition at line 152 of file qgsesriarcadescript.cpp.

◆ dump()

QString QgsEsriArcadeReturnStatement::dump ( ) const
overridevirtual

Returns the formatted script representation of the node.

This can be used to export a script node back to a valid Esri arcade script string.

Implements QgsEsriArcadeNode.

Definition at line 144 of file qgsesriarcadescript.cpp.

◆ expression()

QgsEsriArcadeExpression * QgsEsriArcadeReturnStatement::expression ( ) const
inline

Returns the expression returned by the statement, or nullptr if void return.

Definition at line 423 of file qgsesriarcadescript.h.

◆ nodeType()

QgsEsriArcadeNode::NodeType QgsEsriArcadeReturnStatement::nodeType ( ) const
inlineoverridevirtual

Returns the node type.

Implements QgsEsriArcadeNode.

Definition at line 415 of file qgsesriarcadescript.h.


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