Main Content

destroy

Class: matlab.DiscreteEventSystem
Package: matlab

Event action upon entity destruction

Syntax

[events]=destroy(obj,storage,entity)
[events,out1,...]=destroy(obj,storage,entity,in1,...)

Description

[events]=destroy(obj,storage,entity) specifies event actions of the object before an entity is destroyed.

[events,out1,...]=destroy(obj,storage,entity,in1,...) specifies such event actions of the object when the block has one or more input signal ports and/or signal output ports.

Input Arguments

expand all

Discrete-event System object.

Index of the storage element.

Entity leaving storage element. Entity has these fields:

  • sys (MATLAB structure) — It has these fields:

    • id (double) — Entity ID

    • priority (double) — Entity priority

  • data — Entity data

Any data inputs of the object. These input arguments exist only when the object has data inputs.

Output Arguments

expand all

Events to be scheduled. Use matlab.DiscreteEventSystem class methods to create events. Each event has these fields:

  • type (character vector) — Type of the event

  • delay (double) — Delay before the event

  • priority (double) — Priority of the event

  • Storage (double) — Index of the storage element

  • tag (character vector) — Event tag

  • location (MATLAB structure) — Source or destination location of entity

Data outputs of the object. You must specify these output arguments when the object has data outputs.

Examples

expand all

Specify event action upon entity destruction in storage.

function events = destroy(obj,storage,entity)
    % Upon destroy of an entity, display its ID and schedule to
    % generate a new entity.
    disp(['Entity of ID ' num2str(entity.sys.id) ' is destroyed']);
    events = obj.eventGenerate(storage, 'Refill', 1, entity.sys.priority);
end
 
Introduced in R2016a