Main Content

simevents.SimulationObserver Class

Namespace: simevents
Superclasses: handle

Interface to create your custom observer for models with SimEvents blocks

expand all in page

Description

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

Class Attributes

Abstract
false
HandleCompatible
true
StrictDefaults
false

For information on class attributes, see Class Attributes.

Creation

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

expand all

Examples

collapse all

This example shows how to construct an animator.

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

For more information on creating a simulation observer object, and using it to observe entities in a model, see Observe Entities Using simevents.SimulationObserver Class.

Version History

Introduced in R2016a

See Also

| |

Topics