slrealtime.ui Properties

slrealtime UI component properties for instrument panel UI

Since R2021b

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

Component Operation

Enable — Enable component operation

true (default) | false

This property is available for each of the Simulink Real-Time components. The property selects whether the component is enabled (true) or disabled (false) when the app runs. For graphical (non Simulink Real-Time) components that are configured with a Simulink Real-Time ParameterTuner, you can use the Enable property on the ParameterTuner to enable or disable the graphical component.

• When true, the ParameterTuner sets or clears Enable property of the graphical component based on state of target computer.

• When false, the ParameterTuner sets the Enable property of the ParameterTuner component to false but continues to update the graphical component. In this way, the ParameterTuner Enable property acts as an enable property for the graphical component.

Example: k = uiknob; pt = slrealtime.ui.tool.ParameterTuner; pt.Component = k; pt.Enable = false;

Data Types: logical

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.

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.

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.

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 — Font angle selection

'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 — Font color selection

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 selection

[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

Event Manager Component

EventCallbacks — Managed events and callbacks

empty (default) | struct of events and callbacks

This property applies to the slrealtime.ui.tool.EventManager component. Use this property to add a structure of event names and callback function handles to be managed.

The struct has Event and Callback fields. Each Event is a string that is a target computer event. Each Callback is a function handle that takes two arguments (object, event). For more information about event listeners, see Overview Events and Listeners.

Example: hTgEventManager.EventCallbacks = struct('Event', {'ParamChanged'}, 'Callback', {matlab.apps.createCallbackFcn(hFig, @ParamChanged, true)});

Data Types: array of Instrument objects

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

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

PreConnectFcn — Callback code before connection

one or more MATLAB^® commands

The callback code for the PreConnectFcn function executes before the ConnectButton component issues a connect(tg) command.

Example: disp('Connecting to target computer')

PostConnectFcn — Callback code after connection

one or more MATLAB commands

The callback code for the PostConnectFcn function executes after completion of the connect(tg) command from the ConnectButton component.

Example: disp('Connected to target computer')

PreDisconnectFcn — Callback code before disconnection

one or more MATLAB commands

The callback code for the PreDisconnectFcn function executes before the ConnectButton component issues a disconnect(tg) command.

Example: disp('Disconnecting from target computer')

PostDisconnectFcn — Callback code after disconnection

one or more MATLAB commands

The callback code for the PostDisconnectFcn function executes after completion of the disconnect(tg) command from the ConnectButton component.

Example: disp('Disconnected from target computer')

Import File Log Button Component

PreImportFcn — Callback code before file log import

one or more MATLAB commands

The callback code for the PreImportFcn function executes before the ImportFileLogButton component issues a import(tg.FileLog) command.

Example: disp('Importing file log from target computer')

PostImportFcn — Callback code after file log import

one or more MATLAB commands

The callback code for the PostImportFcn function executes after completion of the import(tg.FileLog) command from the ImportFileLogButton component.

Example: disp('Imported file log from target computer')

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

PreLoadFcn — Callback code before load

one or more MATLAB commands

The callback code for the PreLoadFcn function executes before the LoadButton component issues a load(tg) command.

Example: disp('Loading MLDATX file on target computer')

PostLoadFcn — Callback code after load

one or more MATLAB commands

The callback code for the PostloadFcn function executes after completion of the load(tg) command from the LoadButton component.

Example: disp('Loaded MLDATX file on target computer')

Latch and Momentary Button Components

BlockPath — Parameter block path

empty (default) | string

This property applies to the slrealtime.ui.control.LatchButton and slrealtime.ui.control.MomentaryButton 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.control.LatchButton and slrealtime.ui.control.MomentaryButton components. The property identifies a parameter that is specified by block path and parameter name.

Example: 'Value'

Data Types: string

OnValue — ON state button value

1 (default) | double | int | fixed-point

This property applies to the slrealtime.ui.control.LatchButton and slrealtime.ui.control.MomentaryButton components. The property selects the value that the button downloads when the button is in the ON state. If the OnValue value type of does not match the parameter value type on the target computer, it is converted to the parameter value type on the target computer. If conversion is not possible, an error is reported.

Example: 1

Data Types: double | int | fixedpoint

Menu Component

AsyncLoad — Asynchronous load of application

false (default) | true

For property information, see AsyncLoad description. For an example applying this property for the slrealtime.ui.container.Menu component, see Create Menu by Using App Generator

Example: 0

Data Types: logical

AutoImportFileLog — Import file log on application stop

1 (import) (default) | 0 (no import)

For property information, see AutoImportFileLog description. For an example applying this property for the slrealtime.ui.container.Menu component, see Create Menu by Using App Generator

Example: 0

Data Types: logical

ExportToBaseWorkspace — Export file log data to model base workspace on application stop

1 (export) (default) | 0 (no export)

For property information, see ExportToBaseWorkspace description. For an example applying this property for the slrealtime.ui.container.Menu component, see Create Menu by Using App Generator

Example: 0

Data Types: logical

ReloadOnStop — Directive to reload application on stop

1(reload) (default) | 0 (no reload)

For property information, see ReloadOnStop description. For an example applying this property for the slrealtime.ui.container.Menu component, see Create Menu by Using App Generator

Example: 1

Data Types: logical

SkipInstall — Directive to skip installation of application

false (default) | true

For property information, see SkipInstall description. For an example applying this property for the slrealtime.ui.container.Menu component, see Create Menu by Using App Generator

Example: false

Data Types: logical

Parameter Set Button Component

ParameterSetIcon — Icon for button

'slrtParameterSetIcon.png' (default) | string

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

Example: 'slrtParameterSetIcon.png'

Data Types: string

ParameterSetText — Text for button

'Parameter Set' (default) | string

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

Example: 'Parameter Set'

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

Signals — Signals in signal table

struct

This property applies to the slrealtime.ui.control.SignalTable control. The Signals property value is a struct that contains fields:

• BlockPath — provides either the full block path or name for each signal.

• The PortIndex — provides either the port index value (for signals identified by block path) or the value -1 (for signals identified by name).

• Decimation — provides a decimation value for each signal. Default values is 1.

• ArrayIndex — provides an array index for each signal. Default values is [].

• BusElement — provides bus element selection for each signal. Default values is [], '', or "".

• Callback — provides callback code for each signal. Default values is [].

hSTable.Signals = struct( ... 
  'BlockPath', {'testmodel/Constant1', 'testmodel/Constant2', ...
                'Sine', 'String', 'testmodel/Switch1'}, ... 
  'PortIndex', {1, 1, -1, -1, 1}, ...
  'Decimation', {1, 2, 5, 1, 1}, ...
  'ArrayIndex', {[], [], 2, [2 2], 3}, ...
  'BusElement', {'', 'b', '', 'z', 'a'}, ...
  'Callback', {[], cb, [], [], []});

Example: struct

Data Types: struct

Parameters — Parameters in parameter table

struct

This property applies to the slrealtime.ui.control.ParameterTable control. The Parameters property value is a struct that contains fields BlockPath and ParameterName. The BlockPath field provides the full block path for each parameter in the table. The ParameterName field provides the parameter name for each parameter in the table. When using workspace variables in the Parameters property, the BlockPath is empty for the workspace variable, and the ParameterName value is the name of the workspace variable.

hPTable.Parameters = struct( ... 
  'BlockPath', {'testmodel/Constant1', '', ...
         'testmodel/Constant5', '', ... 
         'testmodel/str1', 'testmodel/str2', ...
         'testmodel/multi-line block name', ... 
         'testmodel/Constant6'}, ... 
  'ParameterName', {'Value', 'model_wksp_var', ...
           'Value', 'base_wksp_var', 'String', ... 
           'String', 'Value', 'Value'}); 

Example: struct

Data Types: struct

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.

The ConvertToComponent property must be a function handle that accepts one argument and returns one value. When a value changes on the target computer, the real-time application uploads the new value to the app to keep the components in sync with the real-time application. The ConvertToComponent property manipulates the value from the target computer into a value that is suitable for writing to the Value property of the component.

For example, you can convert a fixed-point value to a double. For a code example, see Apply ConvertToTarget and ConvertToComponent Properties.

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.

The ConvertToTarget property must be a function handle that accepts one argument and returns one value. When the uicontrol changes the value, the app downloads the value to the corresponding parameter. If the ConvertToTarget property is non-empty, the app executes the function handle, passes in the new value, and uses the return value to download to the parameter. This operation provides an opportunity to apply value manipulation before downloading.

For example, you can convert discrete knob states to integer values. For a code example, see Apply ConvertToTarget and ConvertToComponent Properties.

Example: @app.convertedInt

Data Types: object handle

Reboot Button Component

WaitForReboot — Pause instrument panel until target computer completes reboot

1 (pause) (default) | 0 (no pause)

This property applies to the slrealtime.ui.control.RebootButton component. The property selects whether to pause operation of the instrument panel while the target computer completes the reboot process.

Example: 0

Data Types: logical

Record Button Component

StartRecordingIcon — Icon for button

'slrtStartRecordIcon.png' (default) | string

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

Example: 'slrtStartRecordIcon.png'

Data Types: string

StartRecordingText — Text for button

'Start Recording' (default) | string

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

Example: 'Start Recording'

Data Types: string

StopRecordingIcon — Icon for button

'slrtStopRecordIcon.png' (default) | string

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

Example: 'slrtStopRecordIcon.png'

Data Types: string

StopRecordingText — Text for button

'Stop Recording' (default) | string

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

Example: 'Stop Recording'

Data Types: string

Start-Stop Button Component

AutoImportFileLog — Import file log on application stop

1 (import) (default) | 0 (no import)

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

Example: 1

Data Types: logical

ExportToBaseWorkspace — Export file log data to model base workspace on application stop

1 (export) (default) | 0 (no export)

This property applies to the slrealtime.ui.control.StartStopButton component. The property selects whether the button stop action exports the file log data to the model base workspace from the real-time application.

Example: 1

Data Types: logical

ReloadOnStop — Reload application on stop

1(reload) (default) | 0 (no reload)

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

Example: 1

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

PreStartFcn — Callback code before start

one or more MATLAB commands

The callback code for the PreStartFcn function executes before the StartStopButton component issues a start(tg) command.

Example: disp('Starting MLDATX run on target computer')

PostStartFcn — Callback code after start

one or more MATLAB commands

The callback code for the PostStartFcn function executes after completion of the start(tg) command from the StartStopButton component.

Example: disp('Started MLDATX run on target computer')

PreStopFcn — Callback code before stop

one or more MATLAB commands

The callback code for the PreStopFcn function executes before the StartStopButton component issues a stop(tg) command.

Example: disp('Stopping MLDATX run on target computer')

PostStopFcn — Callback code after stop

one or more MATLAB commands

The callback code for the PostStopFcn function executes after completion of the stop(tg) command from the StartStopButton component.

Example: disp(Stopped MLDATX run on target computer')

System Log Component

IncludeTimeStamps — Directive to 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

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: ts = slrealtime.ui.control.TargetSelector;

Example: h.TargetSource = ts;

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

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

Version History

Introduced in R2021b

R2024a: Added properties for components

The Simulink Real-Time LatchButton and MomentaryButton components provide push button support for App Designer apps and App Generator generated apps.

Information is available for the slrealtime.instrument.LineStyle object Label property. In the App Generator, for an Axes component, this property appears as Line Label. In App Designer, the Label property is set by using the slrealtime.instrument.LineStyle object.

To provide support for pre- and post-event callback code that executes when the state changes for a button component, several Simulink Real-Time App Designer components have added properties for adding callback code. In the App Generator, you can edit the code by using the Callback Editor. In the App Generator, select Options > Configure Components > component > Callbacks, provide a function name, and click the Add button. In App Designer, you can edit the code by using the Code View. For property descriptions, see slrealtime.ui Properties. The components and their event-related properties include:

• ConnectButton: PreConnectFcn, PostConnectFcn, PreDisconnectFcn, PostDisconnectFcn

• ImportFileLogButton: PreImportFcn, PostImportFcn

• LoadButton: PreLoadFcn, PostLoadFcn

• StartStopButton: PreStartFcn, PostStartFcn, PreStopFcn, PostStopFcn

R2023a: Added properties for components

The App Designer Simulink Real-Time components have an Enable property. You can use this property to disable selected components when the app runs. For more information, see the Enable property. For graphical (non Simulink Real-Time) components that are configured with a Simulink Real-Time ParameterTuner, you can use the Enable property on the ParameterTuner to enable or disable the graphical component.

R2022b: Added properties for components

Added properties for these components:

• Menu component — added AsyncLoad property, AutoImportFileLog property, ExportToBaseWorkspace property, ReloadOnStop property, and SkipInstall property.

• StartStopButton component — added AutoImportFileLog property, ExportToBaseWorkspace property, and ReloadOnStop property.

• RebootButton component — added WaitForReboot property.

• RecordButton component — added StartRecordingIcon property, StopRecordingIcon property, StartRecordingText property, and StopRecordingText property.