slrealtime.ui Properties

slrealtime UI component properties for instrument panel UI

Using these properties, you can customize the appearance and operation of slrealtime.ui.control controls and slrealtime.ui.tool tools.

Target Computer Selection

TargetName — Target computer selected by TargetSelector component (read-only)

default target computer (default) | string

When you select a target computer from the target computer selector component, the component updates its TargetName property and synchronizes the TargetSource property of all instrument panel controls to the current state of the selection. See the TargetSource property.

Example: myTarget = h.TargetName

Data Types: string

TargetSource — Target computer used by this component (write-only)

empty (default) | string | slrealtime.ui.control.TargetSelector

When you select a target computer from the target computer selector component, all instrument panel controls synchronize and update to the current state of the selection. All Simulink^® Real-Time™ components (other than the TargetSelector component) have a TargetSource property that has one of these values:

• empty (default)

  Empty is the default and tells the component to use the default SLRT target computer.

• string

  String is the name of an SLRT target computer.

• slrealtime.ui.control.TargetSelector

  slrealtime.ui.control.TargetSelector enables a component to query the currently selected target and to be notified when the selection changes.

Example: h.TargetName = 'TargetPC1'

Data Types: string | slrealtime.ui.control.TargetSelector

Position and Size

Position — Location and size of component

[100 100 200 30] (default) | [left bottom width height]

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: h.Position = [0 0 200 200]

Data Types: integer array

IconAlignment — Location of icon relative to button text

'left' (default) | 'right' | 'center' | 'top' | 'bottom'

This property applies to the slrealtime.ui.control button controls. For more information, see the property description in Button Properties.

Example: 'left'

Data Types: string

HorizontalAlignment — Horizontal alignment of icon and text

'center' (default) | 'left' | 'right'

This property applies to the slrealtime.ui.control button controls. For more information, see the property description in Button Properties.

Example: 'center'

Data Types: string

VerticalAlignment — Vertical alignment of icon and text

'center' (default) | 'top' | 'bottom'

This property applies to the slrealtime.ui.control button controls. For more information, see the property description in Button Properties.

Example: 'center'

Data Types: string

Component Appearance

FontName — Font name

'Helvetica' (default) | system supported font name

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: 'Helvetica'

Data Types: system supported font name

FontSize — Font size

12 (default) | positive number

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: 12

Data Types: positive number

FontWeight — Font weight

'normal' (default) | 'bold'

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: 'normal'

Data Types: string

FontAngle — Selects font angle for component text

'normal' (default) | string

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: 'normal'

Data Types: string

FontColor — Selects

0 0 0 (default) | RGB triplet | hexadecimal color code | 'r' | 'g' | 'b'

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: 0 0 0

Data Types: RGB triplet

BackgroundColor — Background color

[0.96 0.96 0.96] (default) | RGB triplet | hexadecimal color code | 'r' | 'g' | 'b'

This property applies to all slrealtime.ui.control controls. For more information, see the property description in UI Figure Properties.

Example: [0.96 0.96 0.96]

Data Types: RGB triplet

Connect Button Component

ConnectedIcon — Icon for button

'slrtConnectIcon.png' (default) | string

This property applies to the slrealtime.ui.control.ConnectButton component. The property selects the icon that is displayed on the button in the connected state.

Example: 'slrtConnectIcon.png'

Data Types: string

DisconnectedIcon — Icon for button

'slrtDisconnectIcon.png' (default) | string

This property applies to the slrealtime.ui.control.ConnectButton component. The property selects the icon that is displayed on the button in the disconnected state.

Example: 'slrtDisconnectIcon.png'

Data Types: string

ConnectedText — Text for button

Connected (default) | string

This property applies to the slrealtime.ui.control.ConnectButton component. The property selects the text that is displayed on the button in the connected state.

Example: 'Connected'

Data Types: string

DisconnectedText — Text for button

Disconnected (default) | string

This property applies to the slrealtime.ui.control.ConnectButton component. The property selects the text that is displayed on the button in the disconnected state.

Example: 'Disconnected'

Data Types: string

Load Button Component

ShowLoadedApplication — Show loaded application

true (default) | false

This property applies to the slrealtime.ui.control.LoadButton component. The property selects whether the button displays the name of the loaded real-time application in the loaded state.

Example: true

Data Types: logical

LoadIcon — Icon for button

'slrtLoadIcon.png' (default) | string

This property applies to the slrealtime.ui.control.LoadButton component. The property selects the icon that is displayed on the button.

Example: 'slrtLoadIcon.png'

Data Types: string

LoadText — Text for button

'Load Application' (default) | string

This property applies to the slrealtime.ui.control.LoadButton component. The property selects the text that is displayed on the button.

Example: 'Load Application'

Data Types: string

SkipInstall — Skip installation of application

false (default) | true

This property applies to the slrealtime.ui.control.LoadButton component. The property selects whether the button action skips installation and just loads the real-time application.

Example: false

Data Types: logical

AsyncLoad — Asynchronous load of application

false (default) | true

This property applies to the slrealtime.ui.control.LoadButton component. The property selects whether the button action that loads the real-time application is asynchronous (does not block) MATLAB operation.

Example: false

Data Types: logical

Application — Application to load

empty (default) | application name

This property applies to the slrealtime.ui.control.LoadButton component. The property selects the application that loads when you click the button. If set, the button loads the specified application instead of opening a dialog box to select an application.

Example: 'myApplication'

Data Types: string

Start-Stop Button Component

ReloadOnStop — Reload application on stop

true (default) | false

This property applies to the slrealtime.ui.control.StartStopButton component. The property selects whether the button stop action reloads the real-time application.

Example: true

Data Types: logical

StartIcon — Icon for button

'slrtRunIcon.png' (default) | string

This property applies to the slrealtime.ui.control.StartStopButton component. The property selects the icon that is displayed on the button.

Example: 'slrtRunIcon.png'

Data Types: string

StartText — Text for button

'Start' (default) | string

This property applies to the slrealtime.ui.control.StartStopButton component. The property selects the text that is displayed on the button.

Example: 'Start'

Data Types: string

StopIcon — Icon for button

'slrtStopIcon.png' (default) | string

This property applies to the slrealtime.ui.control.StartStopButton component. The property selects the icon that is displayed on the button.

Example: 'slrtStopIcon.png'

Data Types: string

StopText — Text for button

'Stop' (default) | string

This property applies to the slrealtime.ui.control.StartStopButton component. The property selects the text that is displayed on the button.

Example: 'Stop'

Data Types: string

System Log Component

IncludeTimeStamps — Include time stamps for log entries

false (default) | true

This property applies to the slrealtime.ui.control.SystemLog component. The property selects whether the log entries include timestamps.

Example: false

Data Types: logical

Update Button Component

UpdateIcon — Icon for button

'slrtUpdateIcon.png' (default) | string

This property applies to the slrealtime.ui.control.UpdateButton component. The property selects the icon that is displayed on the button.

Example: 'slrtUpdateIcon.png'

Data Types: string

UpdateText — Text for button

'Update Software' (default) | string

This property applies to the slrealtime.ui.control.UpdateButton component. The property selects the text that is displayed on the button.

Example: 'Update Software'

Data Types: string

Parameter Table and Signal Table Component

TableForegroundColor — Table foreground color

[0 0 0] (default) | RGB triplet

This property applies to the slrealtime.ui.control.ParameterTable and slrealtime.ui.control.SignalTable controls. For more information, see the RGB triplet table the property description in UI Figure Properties.

Example: [0 0 0]

Data Types: RGB triplet

TableBackgroundColor — Table background color

[1 1 1] (default) | RGB triplet

This property applies to the slrealtime.ui.control.ParameterTable and slrealtime.ui.control.SignalTable controls. For more information, see the RGB triplet table in the property description in UI Figure Properties.

Example: [1 1 1]

Data Types: RGB triplet

Parameter Tuner Component

Component — App Designer component

empty (default) | graphic object

This property applies to the slrealtime.ui.tool.ParameterTuner component. The property identifies the underlying App Designer component connected to the parameter tuner.

Example: hKnob

Data Types: graphic object

BlockPath — Parameter block path

empty (default) | string

This property applies to the slrealtime.ui.tool.ParameterTuner component. The property identifies a parameter that is specified by block path and parameter name.

Example: 'testmodel/Constant6'

Data Types: string

ParameterName — Parameter name

empty (default) | string

This property applies to the slrealtime.ui.tool.ParameterTuner component. The property identifies a parameter that is specified by block path and parameter name.

Example: 'Value'

Data Types: string

ConvertToComponent — Convert parameter value to component value

@app.convToDouble (default) | handle

This property applies to the slrealtime.ui.tool.ParameterTuner component. Use this property to convert a parameter value to a value used by the component Value property. For example, you can convert a fixed-point value to a double.

Example: @app.convToDouble

Data Types: object handle

ConvertToTarget — Convert component value to target parameter

empty (default) | handle

This property applies to the slrealtime.ui.tool.ParameterTuner component. Use this property to convert a component value to a value used by the real-time application on the target computer. For example, you can convert discrete knob states to integer values.

Example: @app.convertedInt

Data Types: object handle

Instrument Manager Component

Instruments — Managed Instrument objects

empty (default) | array of Instrument objects

This property applies to the slrealtime.ui.tool.InstrumentManager component. Use this property to add Instrument objects to the array of managed instruments. The Instrument objects are bound to one or more UI components.

Example: [hInstAxes hInstGauge]

Data Types: array of Instrument objects

Version History

Introduced in R2021b