MATLAB中enumeration函数用法

目录

语法

说明

示例

显示枚举成员名称

显示对象中的枚举成员名称

获取枚举成员

获取枚举成员和名称

        enumeration函数的功能是显示类枚举成员和名称。

语法

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

说明

        enumeration ClassName 为名称为 ClassName 的 MATLAB® 类显示枚举成员的名称。

        enumeration(obj) 为 obj 类显示枚举成员的名称。

        m = enumeration(___) 返回列向量 m 中的枚举成员。

        [m,s] = enumeration(___) 返回列向量 m 中的枚举成员以及元胞数组 s 中的成员名称。s 中的名称按元素对应于 m 中的枚举成员。

示例

显示枚举成员名称

        显示 matlab.lang.OnOffSwitchState 类的枚举成员名称。

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

    off
    on

显示对象中的枚举成员名称

        显示使用枚举成员对象的 matlab.lang.OnOffSwitchState 类的枚举成员名称。

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

    off
    on

获取枚举成员

        以列向量形式返回 matlab.lang.OnOffSwitchState 类的枚举成员。

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

    off
    on 

获取枚举成员和名称

        以列向量形式返回 matlab.lang.OnOffSwitchState 类的枚举成员，以元胞数组形式返回枚举名称。

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

    off
    on 

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

参数说明

ClassName — 枚举类名称

        枚举类名称，指定为字符向量或字符串标量。

obj — 枚举类的实例

        枚举类的实例。

m — 枚举成员

        枚举成员，以列向量形式返回。

s — 枚举成员名称

        枚举成员名称，以字符向量元胞数组形式返回。

行为说明

enumeration 函数的行为。

• 派生自内置类的枚举类可以为给定的枚举成员指定多个名称。

• 调用不带输出参数的 enumeration 函数时，MATLAB 仅显示每个枚举成员的第一个名称（如类定义中所指定）。要查看所有可用的枚举成员及其名称，请使用两个输出参数。例如，[m,s] = enumeration(obj);。