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

Represents a while loop statement. More...

#include <qgsesriarcadescript.h>

Inheritance diagram for QgsEsriArcadeWhileStatement:

Public Member Functions

 QgsEsriArcadeWhileStatement (QgsEsriArcadeExpression *condition, QgsEsriArcadeBlockStatement *body)
 Constructor for QgsEsriArcadeWhileStatement.
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.
QString dump () const override
 Returns the formatted script representation of the node.
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 while loop statement.

Since
QGIS 4.4

Definition at line 1258 of file qgsesriarcadescript.h.

Constructor & Destructor Documentation

◆ QgsEsriArcadeWhileStatement()

QgsEsriArcadeWhileStatement::QgsEsriArcadeWhileStatement ( QgsEsriArcadeExpression * condition,
QgsEsriArcadeBlockStatement * body )

Constructor for QgsEsriArcadeWhileStatement.

Ownership of condition and body is transferred to this statement.

Definition at line 747 of file qgsesriarcadescript.cpp.

Member Function Documentation

◆ accept()

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

Accepts a visitor to traverse the node.

Implements QgsEsriArcadeNode.

Definition at line 764 of file qgsesriarcadescript.cpp.

◆ body()

QgsEsriArcadeBlockStatement * QgsEsriArcadeWhileStatement::body ( ) const
inline

Returns the loop body block statement.

Definition at line 1281 of file qgsesriarcadescript.h.

◆ clone()

QgsEsriArcadeNode * QgsEsriArcadeWhileStatement::clone ( ) const
overridevirtual

Creates a copy of the node.

Caller takes ownership of the returned object.

Implements QgsEsriArcadeNode.

Definition at line 757 of file qgsesriarcadescript.cpp.

◆ condition()

QgsEsriArcadeExpression * QgsEsriArcadeWhileStatement::condition ( ) const
inline

Returns the loop condition expression.

Definition at line 1276 of file qgsesriarcadescript.h.

◆ dump()

QString QgsEsriArcadeWhileStatement::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 752 of file qgsesriarcadescript.cpp.

◆ nodeType()

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

Returns the node type.

Implements QgsEsriArcadeNode.

Definition at line 1268 of file qgsesriarcadescript.h.


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