Event Properties :: API Properties and Methods by Object (Stateflow User's Guide)

Stateflow User's Guide

Event Properties

Stateflow API objects of type Event have the properties listed in the table below. See also Event Methods.

Property
Type
Access
Description

Debug.
Breakpoints.
StartBroadcast
Boolean
RW
If set to true (default = false), set a debugger breakpoint for the start of the broadcast of this event. Equivalent to selecting the Start of broadcast check box in the properties dialog for this event.

Debug.
Breakpoints.
EndBroadcast
Boolean
RW
If set to true (default = false), set a debugger breakpoint for the end of the broadcast of this event. Equivalent to selecting the End of broadcast check box in the properties dialog for this event.

Description
String
RW
Description of this event (default = ''). Equivalent to entering a description in the Description field of the properties dialog for this event.

Document
String
RW
Document link to this event (default = ''). Equivalent to entering the Document Link field of the properties dialog for this event.

Id
Integer
RO
Unique identifier assigned to this event to distinguish it from other objects loaded in memory.

Machine
Machine
RO
Machine this event belongs to.

Name
String
RW
Name of this event (default = eventn, where n is a counter of events with the name root event).). Equivalent to entering the name in the Name field of the properties dialog for this event.

Port
Integer
RO
Port index number for this event (default = 1).

Scope
Enum
RW
Scope of this event. Allowed values vary with the object containing this data.
The following apply to any event:
'Local'

The following apply to events for charts only:
'input' (Input fromSimulink in properties dialog)

'Output' (Output to Simulink in properties dialog)

The following apply to events for machines only:
'Imported'

'Exported'

Tag
Any Type
RW
Holds data of any type (default = []) for this event.

Trigger
Enum
RW
Type of signal that triggers this chart input event. Also the type of trigger associated with this chart output event. Equivalent to the entries for the Trigger field in the Event dialog for this event.

The following triggers apply to both chart input and output events:
'Either' (Either Edge)

'Function call' (Function Call)

The following triggers apply only to chart input events:
'Rising' (Rising Edge)

'Falling' (Falling Edge)

Property	Type	Access	Description
`Debug.` `Breakpoints.` `StartBroadcast`	Boolean	RW	If set to `true` (default = `false`), set a debugger breakpoint for the start of the broadcast of this event. Equivalent to selecting the Start of broadcast check box in the properties dialog for this event.
`Debug.` `Breakpoints.` `EndBroadcast`	Boolean	RW	If set to `true` (default = `false`), set a debugger breakpoint for the end of the broadcast of this event. Equivalent to selecting the End of broadcast check box in the properties dialog for this event.
`Description`	String	RW	Description of this event (default = `''`). Equivalent to entering a description in the Description field of the properties dialog for this event.
`Document`	String	RW	Document link to this event (default = `''`). Equivalent to entering the Document Link field of the properties dialog for this event.
`Id`	Integer	RO	Unique identifier assigned to this event to distinguish it from other objects loaded in memory.
`Machine`	Machine	RO	Machine this event belongs to.
`Name`	String	RW	Name of this event (default = `eventn`, where `n` is a counter of events with the name root `event`).). Equivalent to entering the name in the Name field of the properties dialog for this event.
Port	Integer	RO	Port index number for this event (default = `1`).
`Scope`	Enum	RW	Scope of this event. Allowed values vary with the object containing this data. The following apply to any event: `'Local'` The following apply to events for charts only: `'input'` (Input fromSimulink in properties dialog) `'Output'` (Output to Simulink in properties dialog) The following apply to events for machines only: `'Imported'` `'Exported'`
Tag	Any Type	RW	Holds data of any type (default = `[]`) for this event.
`Trigger`	Enum	RW	Type of signal that triggers this chart input event. Also the type of trigger associated with this chart output event. Equivalent to the entries for the Trigger field in the Event dialog for this event. The following triggers apply to both chart input and output events: `'Either'` (Either Edge) `'Function call'` (Function Call) The following triggers apply only to chart input events: `'Rising'` (Rising Edge) `'Falling'` (Falling Edge)

Data Methods Event Methods