Main Content

enumeration

Class enumeration members and names

collapse all in page

Syntax

enumeration ClassName
enumeration(obj)
m = enumeration(___)
[m,s] = enumeration(___)

Description

enumeration ClassName displays the names of the enumeration members for the MATLAB® class with the name ClassName.

example

enumeration(obj) displays the names of the enumeration members for the class of obj.

example

m = enumeration(___) returns the enumeration members in the column vector m.

example

[m,s] = enumeration(___) returns the enumeration members in the column vector m and the member names in the cell array s. The names in s correspond element-wise to the enumeration members in m.

example

Examples

collapse all

Open Live Script

Display the enumeration member names for the matlab.lang.OnOffSwitchState class.

enumeration matlab.lang.OnOffSwitchState
Enumeration members for class 'matlab.lang.OnOffSwitchState':

    off
    on
Open Live Script

Display the enumeration member names for the matlab.lang.OnOffSwitchState class using an enumeration member object.

e = matlab.lang.OnOffSwitchState.off;
enumeration(e)
Enumeration members for class 'matlab.lang.OnOffSwitchState':

    off
    on
Open Live Script

Return the enumeration members for the matlab.lang.OnOffSwitchState class in a column vector.

m = enumeration('matlab.lang.OnOffSwitchState')
m = 
  2x1 OnOffSwitchState enumeration array

    off
    on
Open Live Script

Return the enumeration members of the matlab.lang.OnOffSwitchState class in a column vector and the enumeration names in a cell array.

[m,s] = enumeration('matlab.lang.OnOffSwitchState')
m = 
  2x1 OnOffSwitchState enumeration array

    off
    on 


s = 2x1 cell
    {'off'}
    {'on' }

Input Arguments

collapse all

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

Data Types: char | string

Instance of enumeration class.

Output Arguments

collapse all

Enumeration members, returned as a column vector.

Enumeration member names, returned as a cell array of character vectors.

More About

collapse all

Behavior Description

Behavior of the enumeration function.

  • An enumeration class that derives from a built-in class can specify more than one name for a given enumeration member.

  • When you call the enumeration function with no output arguments, MATLAB displays only the first name for each enumeration member (as specified in the class definition). To see all available enumeration members and their names, use the two output arguments. For example, [m,s] = enumeration(obj);.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Version History

Introduced in R2009b

See Also

Topics