Cpp.WhileStatement Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the while_statement nodes in the syntax tree of your code

Since R2026a

Description

The PQL class WhileStatement represents the node while_statement in the syntax tree of your code.

while (condition) {
    // body
}

In this code, the while_statement node corresponds to the loop construct with a condition and a body in the C++ source.

Predicates

expand all

Type

Type	Raisable	Printable
`WhileStatement`	Yes	No

Syntaxes

This class defines these predicates that act on the objects of this class. In addition, objects of this class can access the predicates defined by the base class AstNodeProperties. An object of this class is an object of AstNodeProperties class.

Predicates	Description
`is(required WhileStatement &whileStatement)`	Retrieves syntax nodes of the type `WhileStatement` for your C/C++ code and stores it in `whileStatement`.
`isa(Cpp.Node.Node node)`	Checks if `node` is a `while_statement`.
`cast(Cpp.Node.Node node, required WhileStatement &cast)`	Retrieves syntax nodes of the type `WhileStatement` from the nodes in `node`. Retrieval occurs if `node` is compatible with `WhileStatement` type.
`body(WhileStatement self, Cpp.Node.Node &child)`	Matches the body of the `while` statement.
`condition(WhileStatement self, Cpp.Node.Node &child)`	Matches the condition expression of the `while` statement.
`isEnclosedInWhileStatement (Cpp.Node.Node child)`	Checks if `node` is inside a `while` statement.
`getEnclosingWhileStatement (Cpp.Node.Node child, required WhileStatement &parent)`	Finds the nearest `WhileStatement` ancestor of `node` and returns it as `parent`.

Version History

Introduced in R2026a