Stateflow    
Event Properties

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

Property
Type
Acc
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.
PortNumber
Integer
RO
Port index number for this event (default = 1).
Scope
Enum
RW
Scope of this data. Allowed values vary with the object containing this data.
The following apply to any event:
  • 'LOCAL_EVENT' (Local - default)
The following apply to events for charts only:
  • 'INPUT_EVENT' (Input from Simulink)
  • 'OUTPUT_EVENT' (Output to Simulink)
The following apply to events for machines only:
  • 'IMPORTED_EVENT' (Imported)
  • 'EXPORTED_EVENT' (Exported)
Above values are equivalent to entering the value shown in parentheses in the Scope field of the properties dialog or the Explorer for this data.
Tag
Any Type
RW
Holds data of any type (default = []) for this event.
Trigger
Enum
RW
Type of signal that triggers this Input to Simulink or Output to Simulink event associated with its chart. Can be one of the following:
  • 'EITHER_EDGE_EVENT' (Either Edge - default)
  • 'RISING_EDGE_EVENT' (Rising Edge)
  • 'FALLING_EDGE_EVENT' (Falling Edge)
  • 'FUNCTION_CALL_EVENT' (Function Call)
Equivalent to specifying the indicated parenthetical expression for the Trigger field of the properties dialog for this event.


  Data Properties Target Properties