Signal Editor

Display, create, edit, and switch interchangeable scenarios

expand all in page
  • Library:

  • Simulink / Sources

Description

The Signal Editor block displays, creates, and edits interchangeable scenarios. You can also use the block to switch scenarios in and out of models.

The Signal Editor block supports MAT-files that contain one or more scalar Simulink.SimulationData.Dataset objects.

You can port Signal Builder block configurations to the Signal Editor block using the signalBuilderToSignalEditor function. For more information, see Replace Signal Builder Block with Signal Editor Block.

To programmatically get the total number of scenarios and signals in the Signal Editor block, use the get_param NumberOfScenarios and NumberOfSignals properties. These properties contain the values as character vectors. To convert these values to doubles, use the str2double function.

To programmatically enable the Signal Editor block to label output signal lines, set the set_param PreserveSignalName to 'on' (default). For example:

set_param(gcb,'PreserveSignalName','on')

Limitations

The Signal Editor block does not support:

  • Function-calls

  • Array of buses

  • Buses while using rapid accelerator mode

  • timetable objects

  • Ground signals

The Signal Editor block supports dynamic strings. It does not support strings with maximum length. In addition, strings in the Signal Editor block cannot output:

  • Non-scalar MATLAB strings.

  • String data that contains missing values.

  • String data that contains non-ASCII characters.

Ports

Output Arguments

expand all

One or more signals, which can be:

  • A MATLAB® timeseries object

  • A structure of MATLAB timeseries objects

  • A two-dimensional matrix

The port label depends on the associated variable in the data set MAT-file.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | string | fixed point | enumerated | bus

Parameters

expand all

Data set file, specified as character vector, containing one or more scalar Simulink.SimulationData.Dataset objects. Do not use a file name from one locale in a different locale. When using the block on multiple platforms, consider specifying just the MAT-file name and having the MAT-file be on the MATLAB path.

Dependencies

  • If untitled.mat does not exist in the current folder, these parameters are disabled:

    • Active scenario

    • Signals

    • Output a bus signal

    • Unit

    • Sample time

    • Interpolate data

    • Enable zero-crossing detection

    • Form output after final data value by

  • To create a MAT-file, click . This button starts the Signal Editor user interface, which lets you create and edit scenario MAT-files.

Programmatic Use

Block Parameter: Filename
Type: character vector
Values: character vector
Default: 'untitled.mat'

Active scenario, specified as a character vector. The specified MAT-file must exist.

Dependencies

  • To enable this parameter, ensure that the specified MAT-file exists.

  • With fast restart enabled, you can:

    • Change the active scenario

    • Change the active signal

    • Start the Signal Editor user interface and edit data

    While you can change the active signal, you cannot edit the signal properties in the block.

Programmatic Use

Block Parameter: ActiveScenario
Type: character vector | numeric
Values: character vector | index value
Default: 'Scenario'

To start Signal Editor user interface, click .

Signal to configure, specified as a signal name. This signal is considered the active signal. The MAT-file must exist before you can configure signals.

To enable this parameter, ensure that the specified MAT-file exists.

Tip

Do not use the set_param function to set the active signal property Name-Value argument ('ActiveSignal') in combination with another Name-Value pair argument for the Signal Editor block.

Programmatic Use

Block Parameter: ActiveSignal
Type: character vector | numeric
Values: character vector | index vector
Default: 'Signal 1'

Configure signal as a bus:

On

Configure signal as a bus.

Off

Do not configure signal as a bus.

The specified MAT-file must exist.

Tip

Select this check box only if the active signal is a MATLAB structure whose fields are the same as an existing, or create a new matching object. If you select this check box for an active signal that is not a MATLAB structure, simulation returns an error.

Dependencies

  • Selecting Output a bus signal check box enables the Select bus object parameter.

  • To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: IsBus
Type: character vector
Values: 'off' | 'on'
Default: 'off'

Select or enter the bus object name. To edit the bus object or create a bus object using the Data Type Assistant, click >>. The active signal must be a MATLAB structure whose fields are the same as this bus object. The specified MAT-file must exist.

Dependencies

To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: OutputBusObjectStr
Type: character vector
Values: bus object name
Default: 'Bus: BusObject'

Select the bus object name. If you do not have a bus object, create one by clicking Edit, which starts the Bus Editor. For more information, see Create Bus Objects with the Bus Editor.

Physical unit of the signal, specified as an allowed unit. To specify a unit, begin typing in the text box. As you type, the parameter displays potential matching units. For more information, see Unit Specification in Simulink Models. For a list of supported units, see Allowed Unit Systems.

To constrain the unit system, click the link to the right of the parameter:

  • If a Unit System Configuration block exists in the component, its dialog box opens. Use that dialog box to specify allowed and disallowed unit systems for the component.

  • If a Unit System Configuration block does not exist in the component, the model Configuration Parameters dialog box displays. Use that dialog box to specify allowed and disallowed unit systems for the model.

The specified MAT-file must exist.

Dependencies

To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: Unit
Type: character vector
Values: 'inherit' | supported physical unit
Default: 'inherit'

Time interval between samples, specified in seconds. The specified MAT-file must exist.

Dependencies

To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: SampleTime
Type: character vector
Values: -1 | sample time in seconds
Default: '0'

Linearly interpolate data at time hits for which no corresponding workspace data exist. The specified MAT-file must exist.

The Signal Editor block linearly interpolates:

On

Linearly interpolate at time hits for which no corresponding workspace data exist, select this option.

Off

The current output equals the output at the most recent time for which data exists.

The Signal Editor block interpolates by using the two corresponding workspace samples:

  • For double data, linearly interpolates the value by using the two corresponding samples

  • For Boolean data, uses false for the first half of the time between two time values and true for the second half

  • For a built-in data type other than double or Boolean:

    • Upcasts the data to double

    • Performs linear interpolation (as described for double data)

    • Downcasts the interpolated value to the original data type

You cannot use linear interpolation with enumerated (enum) data.

The block uses the value of the last known data point as the value of time hits that occur after the last known data point.

To determine the block output after the last time hit for which data is available, combine the settings of these parameters:

  • Interpolate data

  • Form output after final data value by

For details, see the Form output after final data value by parameter.

Dependencies

To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: Interpolate
Type: character vector
Values: 'off' | 'on'
Default: 'off'

If you select the Enable zero-crossing detection parameter, then when the input array contains multiple entries for the same time hit, Simulink® detects a zero crossing. For example, suppose that the input array has this data:

time:     0 1 2 2 3
signal:   2 3 4 5 6

At time 2, there is a zero crossing from input signal discontinuity. For more information, see Zero-Crossing Detection.

For bus signals, Simulink detects zero crossings across all leaf bus elements.

The specified MAT-file must exist.

Dependencies

To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: ZeroCross
Type: character vector
Values: 'off' | 'on'
Default: 'off'

To determine the block output after the last time hit for which workspace data is available, combine the settings of these parameters:

  • Interpolate data

  • Form output after final data value by

This table lists the block output, based on the values of the two options.

Setting for Form Output After Final Data Value BySetting for Interpolate DataBlock Output After Final Data

Extrapolation

On

Extrapolated from final data value

Off

Error

Setting to zero

On

Zero

Off

Zero

Holding final value

On

Final value from workspace

Off

Final value from workspace

For example, the block uses the last two known data points to extrapolate data points that occur after the last known point if you:

  • Select Interpolate data.

  • Set Form output after final data value by to Extrapolation.

The specified MAT-file must exist.

Dependencies

To enable this parameter, ensure that the specified MAT-file exists.

Programmatic Use

Block Parameter: OutputAfterFinalValue
Type: character vector
Values: 'Setting to zero' | 'Extrapolation' | 'Holding final value'
Default: 'Setting to zero'

Model Examples

Parallel Simulations Using Parsim: Test-Case Sweep

Parallel Simulations Using Parsim: Test-Case Sweep

Run multiple Simulink® simulations corresponding to different test cases in the Signal Builder block using SimulationInput objects and the parsim command. The parsim command uses Parallel Computing Toolbox™, if it is available, to run simulations in parallel, otherwise the simulations are run in serial.

Open Script
Parallel Simulations Using Parsim: Parameter Sweep in Rapid Accelerator Mode

Parallel Simulations Using Parsim: Parameter Sweep in Rapid Accelerator Mode

Run multiple simulations of a Monte Carlo study in parallel by using Parallel Computing Toolbox™. Parallel execution leverages the multiple cores of your host machine to run many simulations more quickly. These simulations could also be run in parallel on computer clusters using the MATLAB Parallel Server™. This example will work even if the Parallel Computing Toolbox™ or the MATLAB Parallel Server™ is not available, but the simulations will run in serial.

Open Script

Block Characteristics

Data Types

Boolean | bus | double | enumerated | fixed point | integer | single | string

Direct Feedthrough

no

Multidimensional Signals

yes

Variable-Size Signals

no

Zero-Crossing Detection

yes

Extended Capabilities

Fixed-Point Conversion
Convert floating-point algorithms to fixed point using Fixed-Point Designer™.

See Also

| | |

Topics

Introduced in R2017b

Simulink Documentation
Support
Free Ebook: Managing Model-Based Design

Free Ebook: Managing Model-Based Design

Download now