`enumeration`

Lista os membros de uma classe de enumeração.

Sintaxe

enumeration ClassName

Exibe os membros de enumeração da classe.

m = enumeration('ClassName')

Retorna os membros como uma coluna de objetos de enumeração.

[m, names] = enumeration('ClassName')

Também retorna os nomes dos membros como um cell array de vetores de caracteres.

Descrição

Uma classe de enumeração define um conjunto fixo de valores nomeados em um bloco enumeration de um arquivo classdef, por exemplo Red, Green, Blue. A função enumeration é como um programa descobre esse conjunto em tempo de execução, por exemplo para preencher um menu ou percorrer todas as opções.

Também é a palavra-chave que abre esse bloco dentro de uma classdef; fora isso, a função e a palavra-chave não têm relação.

Argumentos de entrada

ClassName: Nome de uma classe definida com um bloco enumeration.

Argumentos de saída

m: Os membros da enumeração.
names: Nomes dos membros, na ordem em que foram declarados.

Exemplo

Uma classe que não existe

try
  enumeration('NoSuchEnum')
catch
  disp('no such class')
end

Saída

no such class

Observações

Um script não consegue declarar uma classe de enumeração, então o exemplo só mostra o caminho de falha. Com uma classe salva em seu próprio arquivo, [m, names] = enumeration('Color') retorna os membros e seus nomes como no MATLAB. Classes de enumeração embutidas, como matlab.lang.OnOffSwitchState, não estão disponíveis.

Veja também

ismethod isprop events meta.class.fromName