Cpp.Enumerator Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the enumerator nodes in the syntax tree of your code

Since R2026a

Description

The PQL class Enumerator represents the node enumerator in the syntax tree of your code.

Predicates

Type

Type	Raisable	Printable
Enumerator	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 Enumerator &enumerator)	Finds syntax nodes of the type Enumerator in your C++ code and returns them as enumerator. For example, in enum Color { Red = 1, Green, Blue };, this predicate matches each enumerator node such as Red, Green, and Blue.
isa(Cpp.Node.Node node)	Checks if node is an Enumerator. Use this relation if you want to negate the condition (for example: not Cpp.Enumerator.isa(n)).
cast(Cpp.Node.Node node, required Enumerator &cast)	Finds syntax nodes of the type Enumerator from the nodes in node. Retrieval occurs if node is compatible with the Enumerator type. Use this relation if you need further Enumerator properties.
name(Enumerator self, Cpp.Node.Node &child)	Matches the enumerator name. For example, in Red = 1, this predicate matches Red.
value(Enumerator self, Cpp.Node.Node &child)	Matches the enumerator value when present. For example, in Red = 1, this predicate matches 1.
isEnclosedInEnumerator(Cpp.Node.Node child)	Checks if child appears inside an Enumerator.
getEnclosingEnumerator(Cpp.Node.Node child, required Enumerator &parent)	Finds the nearest enclosing Enumerator ancestor of child and returns it as parent.

Version History

Introduced in R2026a