Documentation

simevents.SimulationObserver class

Package: simevents
Superclasses: handle

Interface to create your custom visualization for models with SimEvents blocks

Description

This class is an interface for creating custom visualizations for models with SimEvents® blocks. Subclass this class to create your own visualization, using the methods below. Some utility functions are also provided to interact with event calendars, blocks, and entities. Do not overwrite these utility functions.

Construction

obj = SimulationObserver(modelName) returns an object of the SimulationObserver class, used to create a model observer for a SimEvents model.

Input Arguments

expand all

The name of the model to observe.

Methods

simevents.SimulationObserver.simStartedSpecify behavior when simulation starts
simevents.SimulationObserver.simPausedSpecify behavior when simulation pauses
simevents.SimulationObserver.simResumedSpecify behavior when simulation resumes
simevents.SimulationObserver.simTerminatingDefine observer behavior when simulation is terminating
simevents.SimulationObserver.getBlocksToNotifySpecify list of blocks to be notified of entity entry and exit events
simevents.SimulationObserver.notifyEventCalendarEventsSpecify whether you want notification for all events in event calendar
simevents.SimulationObserver.postEntrySpecify behavior after an entity enters a block that has entity storage
simevents.SimulationObserver.preExitSpecify behavior before an entity exits a block with entity storage
simevents.SimulationObserver.preExecuteSpecify behavior before execution of an event
simevents.SimulationObserver.addBlockNotificationAdd block to list of blocks to be notified
simevents.SimulationObserver.removeBlockNotificationRemove block from list of blocks being notified
simevents.SimulationObserver.getEventCalendarsGet handles to event calendars
simevents.SimulationObserver.getAllBlockWithStoragesGet list of blocks that store entities
simevents.SimulationObserver.getHandleToBlockReturn block handle for a given block path
simevents.SimulationObserver.getHandlesToBlockStoragesReturn storage handles of specified block

Examples

expand all

Construct an animator.

function this = seExampleRestaurantAnimator
            % Constructor
            modelname = 'seExampleCustomVisualization';
            this@simevents.SimulationObserver(modelname);
            this.mModel = modelname;
        end

Introduced in R2016a

Was this topic helpful?