Stateflow

Reference Table Column Descriptions

Reference tables for Stateflow API properties and methods have the following columns:

• Name -- The name for the property or method. Each property or method has a name that you use in dot notation along with a Stateflow object to set or obtain the property's value or call the method.
• Type -- A data type for the property. Some types are other Stateflow API objects, such as the Machine property, which is the Machine object that contains this object.
• Access -- An access type for the property. Properties that are listed as RW (read/write) can be read and changed. For example, the Name and Description properties of particular objects are RW. However, some properties are RO (read-only) because they are set by MATLAB itself. For example, the Dirty property of Chart and Machine objects, which indicates whether a model has been changed in memory, is managed by the system and cannot be set directly by users.
• Description -- A description for the property or method. For some properties, the equivalent GUI operations in Stateflow for setting it are also given.
• Objects -- The types of objects that have this property or method. The object types are listed by a single letter corresponding to the beginning character of each object type (except for the Target object), which are as follows:
  
  

  Object	Abbreviation		Object	Abbreviation
  Root	R		Transition	T
  Machine	M		Junction	J
  Chart	C		Event	E
  State	S		Data	D
  Box	B		Target	X
  Function	F		Editor	Editor
  Note	N		Clipboard	Clipboard

API Properties and Methods by Use

Categories of Use