Simulink.defineIntEnumType

Define enumerated data type

Syntax

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1},...,{EnumNameN,EnumIntValueN}})

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1,"Description",EnumDescription1},...,{EnumNameN, EnumIntValueN,"Description",EnumDescriptionN}})

Simulink.defineIntEnumType(___,Name=Value)

Description

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1},...,{EnumNameN,EnumIntValueN}}) defines an enumeration named ClassName where each member has a name and numeric value specified by EnumName and EnumIntValue respectively.

Simulink.defineIntEnumType(ClassName,"Members",{{EnumName1,EnumIntValue1,"Description",EnumDescription1},...,{EnumNameN, EnumIntValueN,"Description",EnumDescriptionN}}) defines an enumeration named ClassName where each member has a name, numeric value, as in the previous syntax, and optionally includes a description specified by EnumDescription.

Simulink.defineIntEnumType(___,Name=Value) specifies options using one or more name-value arguments in addition to the input arguments in the previous syntax. For example, to import a data type definition from an external header file, set DataScope to Imported.

Examples

Import Enumeration Class Definition into Workspace

Assume an external data dictionary includes the following enumeration:

TrafficColors.Red(0),TrafficColors.Yellow(1),TrafficColors.Green(2)

Import the enumeration class definition into the MATLAB^® workspace from header file mytrafficcolors.h while specifying that the enumeration values in generated code are tunable and have the underlying integer data type int16.

Simulink.defineIntEnumType("TrafficColors", ... 
	"Members",{{"Red",0,"Description","Stop!"}, ...
       {"Yellow",1,"Description","Prepare to stop!"}, ...
       {"Green",2,"Description","Go!"}}, ... 
	Description="Traffic light colors", ...
	DefaultValue="Green", ...
	HeaderFile="mytrafficcolors.h", ...
	DataScope="Imported", ...
	AddClassNameToEnumNames=true, ...
	StorageType="int16", ...
      IsTunableInCode=true);

Input Arguments

ClassName — Name of enumerated data type

character vector | string scalar

The name of the enumerated data type, specified as a character vector or string scalar.

Example: BasicColors

Data Types: char | string

EnumName — Enumeration member name

character vector | string scalar

Enumeration member name, specified as a character vector or string scalar.

Example: "Yellow"

Data Types: char | string

EnumIntValue — Numeric enumeration member value

numeric value

Numeric enumeration member value, specified as a numeric value. For uint32-based enumerations, enumeration value must be less than or equal to intmax("int32").

Example: 1

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

EnumDescription — Enumeration member description

character vector | string scalar

Since R2026a

Enumeration member description, specified as a character vector or string scalar.

Example: "Prepare to stop!"

Data Types: char | string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Simulink.defineIntEnumType("TrafficColors","Members",{{"Red",0,"Description","Stop!"},{"Yellow",1,"Description","Prepare to stop!"},{"Green",2,"Description", "Go!"}},HeaderFile="mytrafficcolors.h",DataScope="Imported"); sets DataScope to Imported and specifies for the code generator to import the enumerated type definition from external file mytrafficcolors.h.

Description — Description of enumeration data type

character vector | string scalar

Description of the enumeration data type, specified as a character vector or string scalar.

Example: "Basic colors"

DefaultValue — Default enumeration value

character vector | string

The default enumeration value, specified as a character vector or string. The value is one of the values specified for CellOfEnums.

Example: "Blue"

DataScope — Action for data type definition

"Auto" (default) | "Exported" | "Imported"

Action to take for the data type definition during code generation, specified as one of these values:

• "Auto" — If no value is specified for HeaderFile, export the type definition to model_types.h where model is the model name. If a value is specified for HeaderFile, import the data type definition from the specified header file.

• "Exported" — Export the data type definition to a header file. If no value is specified for HeaderFile, the header file name defaults to type.h, where type is the data type name.

• "Imported" — Import the data type definition from a header file. If no value is specified for HeaderFile, the header file name defaults to type.h, where type is the data type name.

To avoid MISRA C:2012 and MISRA C:2023 violations, set the data scope selection to "Imported" or "Exported".

HeaderFile — Header file

character vector | string

The external header file that contains the data type definition, specified as a character vector or string. By default, the generated #include directive uses the preprocessor delimiter " instead of < and >. To generate the directive #include <mytypes.h>, specify HeaderFile as '<myTypes.h>'.

Example: 'mybasiccolors.h'

AddClassNameToEnumNames — Whether class name is a prefix to enumeration

false or 0 (default) | true or 1

Whether the code generator applies the class name as a prefix to the enumerations, specified as a numeric or logical 1 (true) or 0 (false).

Example: true

StorageType — Data type used to store enumeration values

"int8" | "int16" | "int32" | "uint8" | "uint16" | "uint32"

Data type used to store the enumerations' underlying integer values in generated code, specified as a string.

Example: "int16"

IsTunableInCode — Whether enumeration values are tunable

false or 0 (default) | true or 1

Since R2025a

Option to enable tunability (changing, adding, and reordering) of enumeration values in generated code, specified as a numeric or logical 1 (true) or 0 (false). To set this argument to true, you must set DataScope to "Imported".

Example: true

Version History

Introduced in R2010b

R2026a: Group Name, Value, and Description of Enumerated Members

When defining an enumerated type, you can group the name, value, and description of each member into a single cell array.