matlab.DiscreteEventSystem Class

Namespace: matlab
Superclasses: matlab.System

Base class for discrete-event system objects

Description

matlab.DiscreteEventSystem is the base class for discrete-event System objects. In your class definition file, you must subclass your object from this base class (or from another class that derives from this base class). Subclassing allows you to use the implementation and service methods provided by this base class to build your object. For more information about implementing matlab.DiscreteEventSystem class with MATLAB Discrete-Event System block, see Create Custom Blocks Using MATLAB Discrete-Event System Block.

Type this syntax as the first line of your class definition file to directly inherit from the matlab.DiscreteEventSystem base class, where ObjectName is the name of your object:

classdef ObjectName < matlab.DiscreteEventSystem

For more information about implementing a discrete-event System object™, see Create a Discrete-Event System Object. For information about linking the discrete-event System object to a SimEvents^® model and creating a custom behavior, see Delay Entities with a Custom Entity Storage Block.

The matlab.DiscreteEventSystem class is a handle class.

Class Attributes

`Abstract`	`false`
`HandleCompatible`	`true`
`StrictDefaults`	`false`

For information on class attributes, see Class Attributes.

Methods

expand all

Public Methods

`entityType`	Define entity type
`blocked`	Event action when entity forward fails
`destroy`	Event action upon entity destruction
`entry`	Event action when entity enters storage element
`exit`	Event action before entity exit from storage
`generate`	Event action upon entity creation
`iterate`	Event action when entity iterates
`modified`	Event action upon entity modification by the Entity Find block
`resourceAcquired`	Event action upon successful resource acquisition
`resourceReleased`	Event action upon successful resource release
`testEntry`	Event action to accept or refuse entity
`timer`	Event action when timer completes
`setupEvents`	Initialize entity generation events
`queueFIFO`	Define first-in first-out (FIFO) queue storage
`queueLIFO`	Define last-in last-out (LIFO) stack storage
`queuePriority`	Define priority queue storage
`queueSysPriority`	Define system priority queue storage
`resourceSpecification`	Create specifications for a resource acquisition or a resource release event
`resourceType`	Specify an entity type and the name of the resources to be acquired by the specified entity
`initResourceArray`	Initialize a resource specification array
`eventAcquireResource`	Create a resource acquisition event
`eventDestroy`	Create entity destroy event
`eventForward`	Create entity forward event
`eventGenerate`	Create entity generate event
`eventIterate`	Create entity iterate event
`eventReleaseResource`	Create an event to release previously acquired resources
`eventReleaseAllResources`	Create an event to release all resources acquired by an entity
`eventTestEntry`	Create an event to indicate that the acceptance policy for the storage has changed and the storage retests arriving entities
`eventTimer`	Create entity timer event
`cancelAcquireResource`	Cancel previously scheduled resource acquisition event
`cancelDestroy`	Cancel previously scheduled entity destroy event
`cancelForward`	Cancel previously scheduled forward events
`cancelGenerate`	Cancel previously scheduled entity generation event
`cancelIterate`	Cancel previously scheduled iterate event
`cancelTimer`	Cancel previously scheduled timer event

Protected Methods

`initEventArray`	Initialize event array
`getEntityPortsImpl`	Define input ports and output ports of discrete-event system
`getEntityStorageImpl`	Define entity storage elements of discrete-event system
`getEntityTypesImpl`	Define entity types of discrete-event system
`getResourceNamesImpl`	Define resource pools from which to acquire resources

Examples

collapse all

Create a Custom Entity Storage Block to Delay Entities

This example shows how to use discrete-event System object methods to create a custom entity storage block that has one input port, one output port, and one storage element. The discrete-event System object is the instantiation of the matlab.DiscreteEventSystem class, which allows you to use the implementation and service methods provided by this class. Then, you use the MATLAB Discrete-Event System block to integrate the System object into a SimEvents model. The custom MATLAB Discrete-Event System block accepts an entity from its input port and forwards it to its output port with a specified delay. For more information, see Delay Entities with a Custom Entity Storage Block.

classdef CustomEntityStorageBlock < matlab.DiscreteEventSystem
                        
    % A custom entity storage block with one input, one output, and one storage. 
 
    % Nontunable properties 
    properties (Nontunable)
    % Capacity
        Capacity = 1;
    % Delay
        Delay=4;
    end
    
    methods (Access=protected)        
        function num = getNumInputsImpl(~)
            num = 1;
        end
        
        function num = getNumOutputsImpl(~)
            num = 1;
        end      
        
        function entityTypes = getEntityTypesImpl(obj)
            entityTypes = obj.entityType('Car');
        end
        
        function [inputTypes,outputTypes] = getEntityPortsImpl(obj)
            inputTypes = {'Car'};
            outputTypes = {'Car'};
        end

        function [storageSpecs, I, O] = getEntityStorageImpl(obj)
            storageSpecs = obj.queueFIFO('Car', obj.Capacity);
            I = 1;
            O = 1;
        end
       
    end
    
   methods
       
        function [entity,event] = CarEntry(obj,storage,entity,source)
            % Specify event actions when entity enters storage.
        
             event = obj.eventForward('output', 1, obj.Delay);
           
        end
     
    end
    
end

Version History

Introduced in R2016a