Simulink.IntEnumType Class

Namespace: Simulink

Abstract class for defining enumerations

Description

The Simulink.IntEnumType class is an abstract class for defining an enumerated data type. An enumerated data type defines a set of enumerated values. Each enumerated value consists of an enumerated name and an underlying integer which the software uses internally and in generated code.

To create an enumerated data type that you can use in Simulink^® models, define an enumeration class as a subclass of Simulink.IntEnumType using a classdef block in a MATLAB^® file.

Alternatively, you define an enumerated data type by using one of these methods:

• Use the function Simulink.defineIntEnumType. You do not need a class definition file to define the type.

• Use the function Simulink.importExternalCTypes to create a Simulink representation of an enumerated data type (enum) that your external C code defines.

Methods

Public Methods

getDefaultValue	Get default value of enumerated data type.
getDescription	Get description of enumerated data type.
getHeaderFile	Get name of header file where type is defined for generated code. The method getDataScope determines the significance of the file.
getDataScope	Determine whether generated code exports or imports the definition of the enumerated data type. Use the method getHeaderFile to get the generated or included header file that defines the type.
addClassNameToEnumNames	Determine whether the class name becomes a prefix in generated code.
IsTunableInCode	Determine whether enumerated values are tunable in generated code.

Examples

Derive Enumeration Class from Simulink.IntEnumType Class

Create an enumerated type BasicColors derived from the abstract class Simulink.IntEnumType.

classdef  BasicColors < Simulink.IntEnumType
    enumeration
        Red(0)
        Yellow(1)
        Blue(2)
    end
end

Version History

Introduced before R2006a