cancelIterate

Class: matlab.DiscreteEventSystem
Package: matlab

Cancel previously scheduled iterate event

Syntax

event=cancelIterate(storageID,tag)


Description

event=cancelIterate(storageID,tag) cancels a previously scheduled iterate event. You can commit the cancellation by returning it as the output argument when implementing an event action method, such as entry.

Input Arguments

storageID — Storage index

double

Storage index of the to-be-cancelled iterate event.

tag — Tag

character vector

Tag of the to-be-cancelled iterate event.

Output Arguments

event — Event

MATLAB^® structure

Event for cancelling the specified iterate event.

Examples

Cancel Previously Scheduled Iterate Event

Cancel a previously scheduled iterate event.

function [entity,event] = entry(obj,storage,entity,src)
    % Cancel a previously scheduled iterate event. The event was
    % scheduled for storage element 2, with a custom tag 'search'. 
    event = obj.cancelIterate(2, 'search');
end

Version History

Introduced in R2016a