enumeration

Returns enumeration member names for a classdef enumeration class.

📝Syntax

c = enumeration(obj)
c = enumeration(className)

📥Input Arguments

Parameter	Description
obj	a classdef enumeration object
className	an enumeration class name as a string

📤Output Arguments

Parameter	Description
c	a cell of strings

📄Description

enumeration returns the public enumeration members declared by a classdef class.

Enumeration members can be accessed as ClassName.MemberName.

Enumeration members can pass constructor arguments; stored properties initialized by the constructor are copied to the member value.

💡Examples

List enumeration members.

d = [tempdir(), 'nelson_help_enumeration/'];
mkdir(d);
filewrite([d, '/NelsonHelpColor.m'], ["classdef NelsonHelpColor"; "  enumeration"; "    Red"; "    Blue"; "  end"; "end"]);
addpath(d);
members = enumeration('NelsonHelpColor')

Use constructor arguments in enumeration members.

d = [tempdir(), 'nelson_help_enumeration_ctor/'];
if ~isdir(d)
  mkdir(d);
end
filewrite([d, '/NelsonHelpLevel.m'], ["classdef NelsonHelpLevel"; "  properties"; "    Code = 0"; "  end"; "  methods"; "    function obj = NelsonHelpLevel(code)"; "      if nargin > 0"; "        obj.Code = code;"; "      end"; "    end"; "  end"; "  enumeration"; "    Low(1)"; "    High(2)"; "  end"; "end"]);
addpath(d);
high = eval('NelsonHelpLevel.High');
high.Code

🔗See Also

metaclass classdef

🕔Version History

Version	Description
2.0.0	classdef enumeration support added

Edit this page on GitHub