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

Stateflow User's Guide

Graphical Function Properties

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

Property
Type
Access
Description

ArrowSize
Double
RW
Size of transition arrows coming into this graphical function (default = 8). Equivalent to selecting Arrowhead Size from the context menu for this function.

BadIntersection
Boolean
RO
If true, this state graphically intersects a state, box, or other graphical function.

Chart
Chart
RO
Chart object containing this function.

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

Document
String
RW
Document link to this function. Equivalent to entering the Document Link field of the properties dialog for this function.

FontSize
Double
RW
Size of the (default = 12) font of the label text for this function. This property overrides the font size set for this function at creation by the StateFont.Size property of the containing Chart's object. Equivalent to selecting Font Size > <font size> in the context menu for this function.

Id
Integer
RO
Unique identifier assigned to this function to distinguish it from other objects in the model.

InlineOption
Boolean
RW
Determine how generated code for this graphical function is implemented. Possible settings are as follows:
'Inline' -- Call to function is replaced by code.
'Function' -- Function becomes a C function.
'Auto' -- Stateflow determines if the function is inlined or made a function through an internal calculation.

IsGrouped
Boolean
RW
If set to true (default = false), group this function.

IsSubchart
Boolean
RW
If set to true (default = false), make this function a subchart.

LabelString
String
RW
Label for this function (default = '()'). Equivalent to typing the label for this function in its label text field in the diagram editor.

Machine
Machine
RO
Machine that contains this function.

Name
String
RW
Name of this function (default = ''). Equivalent to typing this function's name into the beginning of the label text field after the word 'function' in the diagram editor.

Position
Rect
RW
Position and size of this function's box in the Stateflow chart, given in the form of a 1-by-4 array (default is [0 0 90 60]) consisting of the following:
(x,y) coordinates for the box's left upper vertex relative to the upper left vertex of the Stateflow diagram editor workspace

Width and height of the box

Subviewer
Chart or State
RO
State or chart in which this function can be graphically viewed.

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

Property	Type	Access	Description
`ArrowSize`	Double	RW	Size of transition arrows coming into this graphical function (default = `8`). Equivalent to selecting Arrowhead Size from the context menu for this function.
`BadIntersection`	Boolean	RO	If `true`, this state graphically intersects a state, box, or other graphical function.
`Chart`	Chart	RO	Chart object containing this function.
`Description`	String	RW	Description of this function (default = `''`). Equivalent to entering a description in the Description field of the properties dialog for this function.
`Document`	String	RW	Document link to this function. Equivalent to entering the Document Link field of the properties dialog for this function.
FontSize	Double	RW	Size of the (default = `12`) font of the label text for this function. This property overrides the font size set for this function at creation by the `StateFont.Size` property of the containing Chart's object. Equivalent to selecting Font Size > <font size> in the context menu for this function.
`Id`	Integer	RO	Unique identifier assigned to this function to distinguish it from other objects in the model.
InlineOption	Boolean	RW	Determine how generated code for this graphical function is implemented. Possible settings are as follows: `'Inline'` -- Call to function is replaced by code. `'Function'` -- Function becomes a C function. `'Auto'` -- Stateflow determines if the function is inlined or made a function through an internal calculation.
IsGrouped	Boolean	RW	If set to `true` (default = `false`), group this function.
IsSubchart	Boolean	RW	If set to `true` (default = `false`), make this function a subchart.
`LabelString`	String	RW	Label for this function (default = `'()'`). Equivalent to typing the label for this function in its label text field in the diagram editor.
`Machine`	Machine	RO	Machine that contains this function.
`Name`	String	RW	Name of this function (default = `''`). Equivalent to typing this function's name into the beginning of the label text field after the word `'function'` in the diagram editor.
`Position`	Rect	RW	Position and size of this function's box in the Stateflow chart, given in the form of a 1-by-4 array (default is `[0 0 90 60]`) consisting of the following: (x,y) coordinates for the box's left upper vertex relative to the upper left vertex of the Stateflow diagram editor workspace Width and height of the box
`Subviewer`	Chart or State	RO	State or chart in which this function can be graphically viewed.
Tag	Any Type	RW	Holds data of any type (default = `[]`) for this function.

Box Methods Graphical Function Methods