setup

Одноразовая настройка задач для системных объектов

Описание

пример

setup(obj) выполняет разовые задачи настройки, относящиеся к системной object™.

setup(obj,input1,...,inputN) выполняет одноразовые задачи настройки, когда эти задачи настройки требуют выборочных входов для проверки входных значений.

Примеры

Инициализация объекта Counter System

В этом примере показано, как вызвать setup на системном объекте. В большинстве случаев вам не нужно звонить setup непосредственно потому, что setup инициализация происходит при первом запуске Системного объекта. Функции setup перед выполнением, только если у вас есть проблемы со временем выполнения инициализации.

Создайте Системный объект Counter с начальным значением 5. (См. полное определение Counter в приведенном ниже разделе.)

count = Counter('StartValue',5)
count = 
  Counter with properties:

    UseIncrement: 1
    UseWrapValue: 1
      StartValue: 5
       Increment: 1
       WrapValue: 10

В определении Counter объект, setupImpl инициализирует StartValue свойство с заданным номером для начала подсчета. Когда вы звоните setupСистемный объект вызывает setupImpl а также проверяет входы и значения свойств. Потому что Counter определил эти внутренние методы валидации, вы должны дать setup значение входа для проверки.

Инициализируйте StartValue для ваших count объект вызовом setup с заполнителем входного значения. После инициализации запустите объект.

setup(count,0)
count(2)
ans = 7

Полное определение Counter Системный объект

type Counter.m
classdef Counter < matlab.System
% COUNTER Compute an output value by incrementing the input value
  
  % All properties occur inside a properties declaration.
  % These properties have public access (the default)
  properties
    UseIncrement (1,1) logical = true    % Use custom increment value.
    UseWrapValue (1,1) logical = true    % Use max value.
    
    StartValue (1,1) {mustBeInteger,mustBePositive} = 1   % Value to start from.
    Increment (1,1) {mustBeInteger,mustBePositive} = 1    % What to add to Value every step.
    WrapValue (1,1) {mustBeInteger,mustBePositive} = 10   % Max value to wrap around.
  end

  properties(Access = protected)
      Value
  end

  methods
    % Constructor - Support name-value pair arguments when constructing object
    function obj = Counter(varargin)
        setProperties(obj,nargin,varargin{:})
    end

    function set.Increment(obj,val)
        if val >= 10
          error('The increment value must be less than 10');
        end
        obj.Increment = val;
    end
    
  end
  
  methods (Access = protected)
    % Validate the object properties  
    function validatePropertiesImpl(obj)
        if obj.UseIncrement && obj.UseWrapValue && ...
                (obj.WrapValue < obj.Increment)
          error('Wrap value must be greater than increment value');
        end
    end
    
    % Validate the inputs to the object
    function validateInputsImpl(~,x)
        if ~isnumeric(x)
          error('Input must be numeric');
        end
    end
    
    % Perform one-time calculations, such as computing constants
    function setupImpl(obj)
        obj.Value = obj.StartValue;
    end
  
    % Step
    function out = stepImpl(obj,in)
      if obj.UseIncrement
        % If using increment property, multiple the increment by the input.
        obj.Value = in*obj.Increment + obj.Value;
      else
         % If not using increment property, add the input.
        obj.Value = in + obj.Value;
      end
      if obj.UseWrapValue && obj.Value > obj.WrapValue
         % If UseWrapValue is true, wrap the value
         % if it is greater than the WrapValue.
         obj.Value = mod(obj.Value,obj.WrapValue);
      end
      out = obj.Value;
    end
  end
end

Входные параметры

свернуть все

Системный объект, который необходимо настроить перед запуском системного объекта.

Альтернативная функциональность

Для большинства системных объектов вам не нужно вызывать setup. Когда вы вызываете Системный объект впервые, setup вызывается. (См. «Сводные данные последовательности вызовов».) Вы должны позвонить setup отдельно только если вам нужно уменьшить вычислительную нагрузку инициализации.

Введенный в R2010a
Для просмотра документации необходимо авторизоваться на сайте