addSetting

Adiciona uma configuração, um item de valor nomeado, a um grupo de configurações.

Categoria: Environment and Settings > System Commands

Sintaxe

S = addSetting(G, name)

S = addSetting(G, name, Name, Value)

Descrição

Uma configuração guarda até quatro camadas de valor: temporário, pessoal, de instalação e de fábrica. Ler S.ActiveValue retorna a primeira camada definida, nessa ordem de prioridade, e gera erro se nenhuma estiver. Atribuir S.PersonalValue ou S.TemporaryValue grava o valor naquela camada e executa a função de validação.

Uma configuração nova começa sem valor em nenhuma camada; defina um valor pessoal antes de lê-la.

Argumentos de entrada

G

Um SettingsGroup criado com addGroup. Não é possível adicionar configurações à raiz retornada por settings.

name

Nome da configuração, com as mesmas regras de nome de um grupo.

'PersonalValue'

Valor pessoal inicial. É verificado pela função de validação, se houver.

'ValidationFcn'

Handle de função chamado a cada valor atribuído; deve gerar erro para valores inválidos, como @matlab.settings.mustBeNumericScalar.

'Hidden'

Flag lógica que oculta a configuração das listagens.

Argumentos de saída

S

O novo objeto matlab.settings.Setting.

Exemplo

Configuração com validação

s = settings;
g = addGroup(s, 'demo');
a = addSetting(g, 'Size', 'PersonalValue', 10, ...
    'ValidationFcn', @matlab.settings.mustBeNumericScalar);
disp(a.ActiveValue)
a.PersonalValue = 20;
disp(a.ActiveValue)
try
    a.PersonalValue = 'x';
catch err
    disp(['Rejected: ' err.message])
end
removeGroup(s, 'demo');

    10
    20
Rejected: Error setting 'Size' in group 'demo': Value must be numeric.

Observações

No MatLivre, os valores pessoais valem apenas para a sessão atual; não são gravados entre execuções como o MATLAB faz.

Veja também

addGroup removeSetting hasSetting settings hasPersonalValue