iterate

Класс: matlab. DiscreteEventSystem
Пакет: matlab

Действие события при итерации сущности

Синтаксис

[entity,events,next]=iterate(obj,storage,entity,tag,cur)
[entity,events,next,out1,...]=iterate(obj,storage,entity,tag,cur,in1,...)

Описание

[entity,events,next]=iterate(obj,storage,entity,tag,cur) задает действия события для, когда сущность обрабатывается как часть итерационного события.

[entity,events,next,out1,...]=iterate(obj,storage,entity,tag,cur,in1,...) задает такие действия события, когда блок имеет один или несколько портов входного сигнала и/или выходных портов сигнала.

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

расширить все

Дискретно-событийный Системный объект.

Индекс элемента хранения.

Сущность в данный момент обрабатывается. Сущность имеет следующие поля:

  • sys (MATLAB structure) - В нем есть следующие поля:

    • id (double) - Идентификатор сущности

    • priority (double) - Приоритет сущности

  • data - Данные сущности

Тег события итерации текущей сущности.

Структура MATLAB, указывающая текущее состояние итерации. Структура имеет следующие поля:

  • size

    Общее количество сущностей в хранилище

  • position

    Положение текущей итерационной сущности

Любые входы данных объекта. Эти входные аргументы существуют только, когда объект имеет входы данных.

Выходные аргументы

расширить все

Сущность обрабатывается, возможно, с измененными данными.

События, запланированные после возвратов метода. Использование matlab.DiscreteEventSystem методы класса для создания событий. Каждое событие имеет следующие поля:

  • type (character vector) - Тип события

  • delay (double) - Задержка перед событием

  • priority (double) - Приоритет мероприятия

  • Storage (double) - Индекс элемента хранения данных

  • tag (character vector) - Тег события

  • location (MATLAB structure) - Источник или место назначения сущности

  • Правда

    Продолжить обработку следующей сущности в элементе хранения.

  • Ложный

    Завершите итерационное событие и оставьте оставленные сущности элемента хранения необработанными.

Выходы объекта. Вы должны задать эти выходные аргументы, когда объект имеет выходы.

Примеры

Пересылка первой сущности

Передайте первую сущность с совпадающим значением данных в выходной порт 1 системы дискретных событий.

function [entity,events,next] = iterate(obj,storage,entity,tag,status)
    % Forward the first entity with matching data value to output
    % port 1 of the discrete-event system.
    disp(['Searching in storage element ' num2str(storage)]);
    disp(['    Total size = ' num2str(status.size)]);
    disp(['    Current position = ' num2str(status.position)]);
    if (entity.data == obj.dataToSearch)
        events = obj.eventForward('output', 1, 0);
        next = false;   % Found -- early terminate
    else
        events = [];
        next = true;    % Not yet found -- continue
    end
end

Пользовательский блок хранения сущностей с событием итерации

В этом примере пользовательский блок позволяет сущностям вводить свой элемент хранения через его входной порт. Элемент хранения данных является очередью приоритетов, которая сортирует сущности на основе их Diameter атрибут в порядке возрастания. Каждый вход сущности в хранилище блока вызывает событие итерации, чтобы отобразить диаметр и положение каждой сущности в хранилище.

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

classdef CustomEntityStorageBlockIteration < matlab.DiscreteEventSystem
    
    % A custom entity storage block with one input port and one storage element. 
    
    % Nontunable properties 
    properties (Nontunable)
        % Capacity
        Capacity = 5;
    end
    % Create the storage element with one input and one storage.
    methods (Access=protected)

        function num = getNumInputsImpl(obj)
            num = 1;
        end
        
        function num = getNumOutputsImpl(obj)
            num = 0;
        end
        
        function entityTypes = getEntityTypesImpl(obj)
            entityType1 = obj.entityType('Wheel');
            entityTypes = entityType1;
        end
        
        function [inputTypes,outputTypes] = getEntityPortsImpl(obj)
            inputTypes = {'Wheel'};
            outputTypes={};
            
        end
        
        function [storageSpecs, I, O] = getEntityStorageImpl(obj)
            storageSpecs = obj.queuePriority('Wheel',obj.Capacity, 'Diameter','ascending');
            I = 1;
            O = [];
            
        end
        
    end
    % Entity entry event action
    methods 

        function [entity, event] = WheelEntry(obj,storage,entity, source)
            % Entity entry invokes an iterate event.      
            event = obj.eventIterate(1, '');
        end

        % The itarate event action
        function [entity,event,next] = WheelIterate(obj,storage,entity,tag,cur)
            % Display wheel id, position in the storage, and diameter.
            coder.extrinsic('fprintf');
            fprintf('Wheel id %d, Current position %d, Diameter %d\n', ...
                entity.sys.id, cur.position, entity.data.Diameter);
            if cur.size == cur.position 
                fprintf('End of Iteration \n')
            end
            next = true;
            event=[];
        end
        
    end

end
Введенный в R2016a