Class EnumConstant

A C/C++ enumerator [N4140 7.2], also known as an enumeration constant.

For example the enumeration constant green in:

enum {
  red,
  green,
  blue
}

Import path

import cpp

Direct supertypes

Indirect supertypes

Predicates

getADeclarationLocation	Gets the location of a declaration of this enumerator.
getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this element belongs.
getASpecifier	Gets a specifier of this enumerator.
getAnAccess	Gets an access of this enumerator.
getAnAttribute	An attribute of this enumerator.
getDeclaringEnum	Gets the enumeration of which this enumerator is a member.
getDeclaringType	Gets the class where this member is declared, if it is a member. For templates, both the template itself and all instantiations of the template are considered to have the same declaring class.
getDefinitionLocation	Gets the location of the definition of this enumerator.
getInitializer	Gets the initializer of this enumerator, if any.
getLocation	Gets the location of the definition of this enumerator.
getName	Gets the name of this enumerator.
getType	Gets the type of this enumerator.
getValue	Gets the value that this enumerator is initialized to, as a string. This can be a value explicitly given to the enumerator, or an automatically assigned value.

Inherited predicates

findRootCause	Gets the source of this element: either itself or a macro that expanded to this element.	from Element
fromSource	Holds if this element may be from source. This predicate holds for all elements, except for those in the dummy file, whose name is the empty string. The dummy file contains declarations that are built directly into the compiler.	from Element
getADeclarationEntry	Gets a declaration entry corresponding to this declaration. See the comment above this class for an explanation of the relationship between `Declaration` and `DeclarationEntry`.	from Declaration
getAFile	Gets a file where this element occurs.	from Declaration
getATemplateArgument	Gets a template argument used to instantiate this declaration from a template. When called on a template, this will return a template parameter type for both typed and non-typed parameters.	from Declaration
getATemplateArgumentKind	Gets a template argument used to instantiate this declaration from a template. When called on a template, this will return a non-typed template parameter value.	from Declaration
getDefinition	Gets the declaration entry corresponding to this declaration that is a definition, if any.	from Declaration
getDescription	Gets a description of this `Declaration` for display purposes.	from Declaration
getEnclosingElement	Gets the closest `Element` enclosing this one.	from Element
getFile	Gets the primary file where this element occurs.	from Element
getNamespace	Gets the innermost namespace which contains this declaration.	from Declaration
getNumberOfTemplateArguments	Gets the number of template arguments for this declaration.	from Declaration
getParentScope	Gets the parent scope of this `Element`, if any. A scope is a `Type` (`Class` / `Enum`), a `Namespace`, a `BlockStmt`, a `Function`, or certain kinds of `Statement`.	from Element
getPrimaryQlClasses	Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.	from ElementBase
getQualifiedName	Gets the name of the declaration, fully qualified with its namespace and declaring type.	from Declaration
getTemplateArgument	Gets the `i`th template argument used to instantiate this declaration from a template.	from Declaration
getTemplateArgumentKind	Gets the `i`th template argument value used to instantiate this declaration from a template. When called on a template, this will return the `i`th template parameter value if it exists.	from Declaration
hasDeclaringType	Holds if this declaration is a member of a class/struct/union.	from Declaration
hasDefinition	Holds if the declaration has a definition.	from Declaration
hasGlobalName	Holds if this declaration has the given name in the global namespace.	from Declaration
hasGlobalOrStdName	Holds if this declaration has the given name in the global namespace or the `std` namespace.	from Declaration
hasGlobalOrStdOrBslName	Holds if this declaration has the given name in the global namespace, the `std` namespace or the `bsl` namespace. We treat `std` and `bsl` as the same in some of our models.	from Declaration
hasName	Holds if this declaration has the given name.	from Declaration
hasQualifiedName	Holds if this declaration has a fully-qualified name with a name-space component of `namespaceQualifier`, no declaring type, and a base name of `baseName`.	from Declaration
hasQualifiedName	Holds if this declaration has a fully-qualified name with a name-space component of `namespaceQualifier`, a declaring type of `typeQualifier`, and a base name of `baseName`. Template parameters and arguments are stripped from all components. Missing components are `""`.	from Declaration
hasSpecifier	Holds if this declaration has a specifier with the given name.	from Declaration
isAffectedByMacro	Holds if this element is affected in any way by a macro. All elements that are totally or partially generated by a macro are included, so this is a super-set of `isInMacroExpansion`.	from Element
isFromTemplateInstantiation	Holds if this `Element` is a part of a template instantiation (but not the template itself).	from Element
isFromUninstantiatedTemplate	Holds if this `Element` is part of a template `template` (not if it is part of an instantiation of `template`). This means it is represented in the database purely as syntax and without guarantees on the presence or correctness of type-based operations such as implicit conversions.	from Element
isInMacroExpansion	Holds if this element comes from a macro expansion. Only elements that are entirely generated by a macro are included - for elements that partially come from a macro, see `isAffectedByMacro`.	from Element
isMember	Holds if this declaration is a member of a class/struct/union.	from Declaration
isStatic	Holds if this declaration is static.	from Declaration
isTopLevel	Holds if this declaration is a top-level declaration.	from Declaration
toString	Gets a textual representation of this element.	from Declaration