Main Content

exit

Class: matlab.DiscreteEventSystem
Package: matlab

Event action before entity exit from storage

Syntax

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

Description

[events]=exit(obj,storage,entity,destination) specifies event actions of the object when an entity exits a storage.

[events,out1,...]=exit(obj,storage,entity,destination,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

Destination of entity, such as an output port or a storage element. It has these fields:

  • type (character vector) — Specify output, storage, or extract

  • index (double) — Output or storage index

The type is specified as extract if an entity is being extracted from a Discrete-Event System block.

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 after the method returns. 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

Create a new entity when an existing entity exits the storage element.

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