Documentation

matlab.DiscreteEventSystem class

Package: 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. 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

Define as public these methods:

  • blocked

  • destroy

  • entry

  • exit

  • generate

  • iterate

  • setupEvents

  • timer

For other methods, set Access = protected.

Methods

This list contains the methods to implement and the utility methods.

blockedEvent action when entity forward fails
cancelDestroyCancel previously scheduled entity destroy event
cancelForwardCancel previously scheduled forward events
cancelGenerateCancel previously scheduled entity generation event
cancelIterateCancel previously scheduled iterate event
cancelTimerCancel previously scheduled timer event
destroyEvent action upon entity destruction
entityTypeDefine entity type
entryEvent action when entity enters storage element
eventDestroyCreate entity destroy event
eventForwardCreate entity forward event
eventGenerateCreate entity generate event
eventIterateCreate entity iterate event
eventTimerCreate entity timer event
exitEvent action before entity exit from storage
generateEvent action upon entity creation
getEntityPortsImplDefine input ports and output ports of discrete-event system
getEntityStorageImplDefine entity storage elements of discrete-event system
getEntityTypesImplDefine entity types of discrete-event system
initEventArrayInitialize event array
iterateEvent action when entity iterates
queueFIFODefine first-in first-out (FIFO) queue storage
queueLIFODefine last-in last-out (LIFO) queue storage
queuePriorityDefine priority queue storage
queueSysPriorityDefine system priority queue storage
setupEventsInitialize entity generation events
timerEvent action when timer completes

Inherited Methods

The matlab.DiscreteEventSystem class inherits a subset of the matlab.System class.

getIconImpl

Name to display as block icon

getHeaderImpl

Header for System object display

getPropertyGroupsImpl

Property groups for System object display

isInactivePropertyImpl

Inactive property status

validatePropertiesImpl

Validate property values

processTunedPropertiesImpl

Action when tunable properties change

getNumInputsImpl

Number of inputs to step method

getInputNamesImpl

 Names of System block input ports

getNumOutputsImpl

Number of outputs from step method

getOutputNamesImpl

Names of System block output ports

getOutputSizeImpl

 Sizes of output ports

getOutputDataTypeImpl

 Data types of output ports

isOutputComplexImpl

Complexity of output ports

getDiscreteStateSpecificationImpl

Discrete state size, data type, and complexity

getDiscreteStateImpl

Discrete state property values

matlab.DiscreteEventSystem.initEventArray

Initialize event array

setupImpl

Initialize System object

resetImpl

Reset System object states

releaseImpl

Release resources

loadObjectImpl

Load System object from MAT file

saveObjectImpl

 Save System object in MAT file

infoImpl

Information about System object

isDoneImpl

End-of-data flag

Introduced in R2016a

Was this topic helpful?