Documentation Center

  • Trial Software
  • Product Updates

Events

Contain all event objects

Description

Property to indicate events in a model object. Read-only array of Event objects.

An event defines an action when a defined condition is met. For example, the quantity of a species may double when the quantity of species B is 100. An event is triggered when the conditions specified in the event are met by the model. For more information, see Events and Event Object.

Add an event to a Model object with the method addevent method and remove an event with the delete method. See Event object for more information.

You can view event object properties with the get command and modify the properties with the set command.

Characteristics

Applies toObject: model
Data typeArray of event objects
Data valuesEvent object. The default is [] (empty).
AccessRead-only

Examples

  1. Create a model object, and then add an event object.

    modelObj = sbmlimport('oscillator')
    eventObj = addevent(modelObj, 'time>= 5', 'OpC = 200');
  2. Get a list of properties for an event object.

    get(modelObj.Events(1));
    

    Or

    get(eventObj)

    MATLAB® displays a list of event properties.

                Active: 1
            Annotation: ''
             EventFcns: {'OpC = 200'}
                  Name: ''
                 Notes: ''
                Parent: [1x1 SimBiology.Model]
                   Tag: ''
               Trigger: 'time >= 5'
          TriggerDelay: 0
     TriggerDelayUnits: 'second'
                  Type: 'event'
              UserData: []
Was this topic helpful?