Stateflow.Event

Event in chart, state, or box

Description

Use Stateflow.Event objects to trigger actions in one of these objects:

• A parallel state in a Stateflow^® chart

• Another Stateflow chart

• A Simulink^® triggered or function-call subsystem

For more information, see Synchronize Model Components by Broadcasting Events.

Creation

Syntax

event = Stateflow.Event(parent)

Description

event = Stateflow.Event(parent) creates a Stateflow.Event object in a parent chart, state, or box.

Input Arguments

parent — Parent for new event

Stateflow.Chart object | Stateflow.State object | Stateflow.Box object

Parent for the new event, specified as a Stateflow API object of one of these types:

• Stateflow.Box

• Stateflow.Chart

• Stateflow.State

Properties

Interface

Name — Name of event

'event' (default) | character vector

Name of the event, specified as a character vector.

Scope — Scope of event

'Local' (default) | 'Input' | 'Output'

Scope of the event, specified as 'Local', 'Input', or 'Output'. For more information, see Scope.

Trigger — Type of trigger

'Function call' (default) | 'Rising' | 'Falling' | 'Either'

Type of trigger associated with the event, specified as a character vector that depends on the scope of the data:

• For input events, use 'Function call', 'Rising', 'Falling', or 'Either'.

• For output events, use 'Function call' or 'Either'.

This property does not apply to local events. For more information, see Trigger.

Port — Port index for event

scalar

Port index for the event, specified as an integer scalar. This property applies only to input and output events. For more information, see Port.

Debugging

Debug.Breakpoints.StartBroadcast — Whether to set Start of Broadcast breakpoint

false or 0 (default) | true or 1

Whether to set the Start of Broadcast breakpoint for the event, specified as a numeric or logical 1 (true) or 0 (false). For more information, see Debugger Breakpoints.

Example: event.Debug.Breakpoints.StartBroadcast = true;

Debug.Breakpoints.EndBroadcast — Whether to set End of Broadcast breakpoint

false or 0 (default) | true or 1

Whether to set the End of Broadcast breakpoint for the event, specified as a numeric or logical 1 (true) or 0 (false). For more information, see Debugger Breakpoints.

Example: event.Debug.Breakpoints.EndBroadcast = true;

Hierarchy

Machine — Machine that contains event

Stateflow.Machine object

This property is read-only.

Machine that contains the event, specified as a Stateflow.Machine object.

Path — Location of parent in model hierarchy

character vector

This property is read-only.

Location of the parent of the event in the model hierarchy, specified as a character vector.

Identification

Description — Description

'' (default) | character vector

Description for the event, specified as a character vector.

Document — Document link

'' (default) | character vector

Document link for the event, specified as a character vector.

Tag — User-defined tag

[] (default) | any data type

User-defined tag for the event, specified as data of any type.

Id — Unique identifier

scalar

This property is read-only.

Unique identifier, specified as an integer scalar. Use this property to distinguish the event from other objects in the model. The value of this property is reassigned every time you start a new MATLAB^® session and may be recycled after an object is deleted.

Object Functions

classhandle	Provide class handle for object
dialog	Open properties dialog box
get	Return MATLAB structure containing property settings of object or array of objects
set	Set properties with specified values
up	Return parent of object
view	Display object in editing environment

Examples

Add Event to Chart

Add a event to the chart ch. Specify its name and scope.

event = Stateflow.Event(ch);
event.Name = 'E';
event.Scope = 'Input';