matlab.metadata.EnumerationMember Class

Namespace: matlab.metadata
Superclasses: matlab.metadata.MetaData

Describe enumeration member of MATLAB class

Renamed from meta.EnumeratedValue in R2024a

Description

The matlab.metadata.EnumerationMember class contains information about enumeration members defined by MATLAB^® classes. The properties of a matlab.metadata.EnumerationMember object correspond to the attributes of the enumeration member being described.

All matlab.metadata.EnumerationMember properties are read-only. Query the matlab.metadata.EnumerationMember object to obtain information about the enumeration member it describes.

The matlab.metadata.EnumerationMember class is a handle class.

Class Attributes

Abstract	true
ConstructOnLoad	true

For information on class attributes, see Class Attributes.

Creation

Obtain a matlab.metadata.EnumerationMember object from the EnumerationMemberList property of a matlab.metadata.Class object. EnumerationMemberList is an array of matlab.metadata.EnumerationMember instances, one per enumeration member.

Properties

Name — Name of enumeration member

character vector

Name of the enumeration member, returned as a character vector.

Description — Short description of enumeration member

character vector

Short description of the enumeration member, returned as a character vector. For user-defined classes, the text for this property comes from code comments in the enumeration definition. If there are no comments, the property returns an empty character vector. For more information on how to include help text for your enumerations, see Custom Help Text.

DetailedDescription — Detailed description of enumeration member

character vector

Detailed description of the enumeration member, returned as a character vector. For user-defined classes, the text for this property comes from code comments in the enumeration definition. If there are no comments, the property returns an empty character vector. For more information on how to include help text for your enumerations, see Custom Help Text.

Hidden — Value of enumeration member attribute Hidden

false (default) | true

Value of enumeration member attribute Hidden, returned as a logical value.

DefiningClass — Class that defines enumeration

matlab.metadata.Class object

Class that defines the enumeration, returned as a matlab.metadata.Class object.

Examples

List Enumeration Member Names

Use the EnumerationMemberList property of a matlab.metadata.Class instance to get the names of the enumeration members defined in the matlab.lang.OnOffSwitchState enumeration class.

mc = ?matlab.lang.OnOffSwitchState;
mc.EnumerationMemberList.Name

ans =

    'off'


ans =

    'on'

Version History

Introduced in R2009b

R2024a: Renamed from meta.EnumeratedValue

The namespace and class name of meta.EnumeratedValue have been changed to matlab.metadata.EnumerationMember. The behavior remains the same.

MATLAB will continue to recognize the old metaclass names in most contexts. However, code that relies on string comparisons to identify metaclasses might need to be updated to continue to work as expected. For example, if mObj in the example below is a matlab.metadata.EnumerationMember instance, the code under the case statement for 'meta.EnumeratedValue' does not execute because class(mObj) returns 'matlab.metadata.EnumerationMember'.

switch class(mObj)
   case 'meta.EnumeratedValue'
       % code to execute if mObj is a meta.EnumeratedValue instance
   ...
end

To ensure this code continues to work as intended, use an if statement with isa. The isa command recognizes both the old and new names of the class.

if isa(mObj,'meta.EnumeratedValue') 
       % code to execute if mObj is a 
       % matlab.metadata.EnumerationMember instance
   else
       ...
   end

If compatibility with older releases of MATLAB is not a concern, you can update 'meta.EnumeratedValue' to 'matlab.metadata.EnumerationMember'. However, continue to use the old name if your code needs to run on versions of MATLAB before R2024a.