coder.descriptor.types.Enum Class

Namespace: coder.descriptor.types
Superclasses: coder.descriptor.types.Scalar

Return information about variable of enum type

Since R2024b

Description

An object of the coder.descriptor.types.Enum class describes a variable in the generated code that is of an enumeration type.

Properties

Identifier — Identifier used in generated code

character vector

Identifier of the data type used in generated code for the corresponding modeling element, specified as a character vector.

Data Types: char

Name — Name of data type represented in Simulink^®

character vector

Name of the data type that is represented in Simulink for the corresponding modeling element, specified as a character vector.

Data Types: char

ReadOnly — Indication that type qualifier contains const

true or 1 | false or 0

Indication that the type qualifier contains const, specified as a numeric or logical 1 (true) or 0 (false). If you cannot change the value of the variable during execution, the variable is preceded by the const keyword as the type qualifier in the generated code.

• 1 — The type qualifier contains const.

• 0 — The type qualifier does not contain const.

Data Types: logical

Volatile — Indication that type qualifier contains volatile

true or 1 | false or 0

Indication that the type qualifier contains volatile, specified as a numeric or logical 1 (true) or 0 (false). If the compiler cannot apply optimizations to the variable because its value can change due to external sources, the variable is preceded by the volatile keyword as the type qualifier in the generated code.

• 1 — The type qualifier contains volatile.

• 0 — The type qualifier does not contain volatile.

Data Types: logical

IsCppScoped — Indication that enumeration is scoped

false or 0 (default) | true or 1

Indication that the enumeration variable is a C++ scoped enumeration (enum class), specified as a numeric or logical 1 (true) or 0 (false). The value of this property is 1 if the variable is a scoped enumeration, and 0 otherwise.

Data Types: logical

StorageType — Data type of integer values

coder.descriptor.types.Type object

Data type used to store the integer values of the enumeration in the generated code, specified as a coder.descriptor.types.Type object.

Data Types: coder.descriptor.types.Type

Strings — Enumeration identifiers

cell array of character vectors

Identifiers representing enumeration variants in the generated code, specified as a cell array of character vectors.

Data Types: cell

Values — Enumeration values

integer vector

Integer values for enumeration variants in the generated code, specified as an integer vector.

Data Types: int32

Version History

Introduced in R2024b