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

Represents a standard counter-based for loop. More...

#include <qgsesriarcadescript.h>

Inheritance diagram for QgsEsriArcadeForStatement:

Public Member Functions

 QgsEsriArcadeForStatement (QgsEsriArcadeStatement *initialization, QgsEsriArcadeExpression *condition, QgsEsriArcadeNode *step, QgsEsriArcadeBlockStatement *body)
 Constructor for QgsEsriArcadeForStatement.
void accept (QgsEsriArcadeVisitor &visitor) const override
 Accepts a visitor to traverse the node.
QgsEsriArcadeBlockStatement * body () const
 Returns the loop body block statement.
QgsEsriArcadeNode * clone () const override
 Creates a copy of the node.
QgsEsriArcadeExpression * condition () const
 Returns the loop condition expression, or nullptr if none.
QString dump () const override
 Returns the formatted script representation of the node.
QgsEsriArcadeStatement * initialization () const
 Returns the initialization statement, or nullptr if none.
QgsEsriArcadeNode::NodeType nodeType () const override
 Returns the node type.
QgsEsriArcadeNode * step () const
 Returns the step expression or statement, or nullptr if none.
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 standard counter-based for loop.

Since
QGIS 4.4

Definition at line 1129 of file qgsesriarcadescript.h.

Constructor & Destructor Documentation

◆ QgsEsriArcadeForStatement()

QgsEsriArcadeForStatement::QgsEsriArcadeForStatement ( QgsEsriArcadeStatement * initialization,
QgsEsriArcadeExpression * condition,
QgsEsriArcadeNode * step,
QgsEsriArcadeBlockStatement * body )

Constructor for QgsEsriArcadeForStatement.

Ownership of initialization, condition, step, and body is transferred to this statement.

Definition at line 677 of file qgsesriarcadescript.cpp.

Member Function Documentation

◆ accept()

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

Accepts a visitor to traverse the node.

Implements QgsEsriArcadeNode.

Definition at line 706 of file qgsesriarcadescript.cpp.

◆ body()

QgsEsriArcadeBlockStatement * QgsEsriArcadeForStatement::body ( ) const
inline

Returns the loop body block statement.

Definition at line 1164 of file qgsesriarcadescript.h.

◆ clone()

QgsEsriArcadeNode * QgsEsriArcadeForStatement::clone ( ) const
overridevirtual

Creates a copy of the node.

Caller takes ownership of the returned object.

Implements QgsEsriArcadeNode.

Definition at line 697 of file qgsesriarcadescript.cpp.

◆ condition()

QgsEsriArcadeExpression * QgsEsriArcadeForStatement::condition ( ) const
inline

Returns the loop condition expression, or nullptr if none.

Definition at line 1154 of file qgsesriarcadescript.h.

◆ dump()

QString QgsEsriArcadeForStatement::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 684 of file qgsesriarcadescript.cpp.

◆ initialization()

QgsEsriArcadeStatement * QgsEsriArcadeForStatement::initialization ( ) const
inline

Returns the initialization statement, or nullptr if none.

Definition at line 1149 of file qgsesriarcadescript.h.

◆ nodeType()

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

Returns the node type.

Implements QgsEsriArcadeNode.

Definition at line 1141 of file qgsesriarcadescript.h.

◆ step()

QgsEsriArcadeNode * QgsEsriArcadeForStatement::step ( ) const
inline

Returns the step expression or statement, or nullptr if none.

Definition at line 1159 of file qgsesriarcadescript.h.


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