Simulink.io.SignalBuilderSpreadsheet class

Package: Simulink.io

Read spreadsheet in format used by Signal Builder

Since R2020a

Description

Simulink.io.SignalBuilderSpreadsheet inherits from the Simulink.io.FileType base class. It reads spreadsheets formatted in a format used by Signal Builder. To import spreadsheets used in Signal Builder, use this class.

classdef SignalBuilderSpreadsheet < Simulink.io.FileType

The Simulink.io.SignalBuilderSpreadsheet class is a handle class.

Class Attributes

Abstract	false
HandleCompatible	true

For information on class attributes, see Class Attributes.

Properties

FileName — File name

character array

File name of file that contains signals to import to Signal Editor, specified as a character array.

Attributes:

GetAccess	public
SetAccess	public

Data Types:

Methods

Specialized Operators and Functions

These methods specialize standard MATLAB^® operators and functions for objects in this class.

export	This method calls the exportImpl method. From Signal Editor, write the structure of signals to a MAT-file. The structure must contains two cell arrays; one for signal names and one for signal values. Specify if the method appends to or overwrites the contents of the MAT-file. The method indicates if it succeeded in writing to the MAT-file and returns any error messages.
import	[importedData, warnStr ] = import(reader) To import custom signals for a custom file type, identify the custom file type reader as a Simulink.io.FileType object. The method returns the found variable as a cell array of signal variables of supported types. For more information on supported types, see Choose a Base Workspace and MAT-File Format. The method returns a structure with two fields, Data and Name. Data is a cell array of signals and Name is a cell array of character vectors of the corresponding signal names.
importAVariable	varOut = importAVariable(reader,variableName) To import a specified variable for a custom file type, identify the custom file type reader as a Simulink.io.FileType object. Use VariableName, specified as a character array, to extract the desired signal from the file of custom format signals. The method returns the found variable, returned as a cell array of signal variables of supported types. For more information on supported types, see Choose a Base Workspace and MAT-File Format.
load	This method calls the loadImpl method. Load the signal listed in the custom file type.
loadAVariable	This method calls the loadAVariableImpl method. Validate the format of the signals in the custom MAT-file fileName with the associated Simulink.io.FileType reader.
validateFileName	This method calls the validateFileNameImpl method. Validate the format of the signals in the custom MAT-file fileName with the associated Simulink.io.FileType reader.
whos	This method calls the whosImpl method. Return the contents of the custom file type MAT-file.

Examples

Interact with SignalBuilderSpreadsheet Using Specialized Functions

Interact with FileType using specialized functions. This example refers to the open('Simulink.io.CreateSignals') sample file.

Get contents of Signal Builder format foo.xlsx spreadsheet.

fileName = 'foo.xlsx';
aReader = Simulink.io.SignalBuilderSpreadsheet(fileName);
resultOfWhos = whos( aReader );

Load the custom signals in foo.xlsx.

fileName = 'foo.xlsx';

aReader = Simulink.io.SignalBuilderSpreadsheet(fileName);
varsOnFileStruct = load(aReader,'myGroup1');

Load a variable from foo.xlsx.

fileName = 'foo.xlsx';

aReader = Simulink.io.SignalBuilderSpreadsheet(fileName);
var = loadAVariable(aReader,'myGroup1');

Import custom signals from foo.xlsx.

fileName = 'foo.xlsx';

aReader = Simulink.io.SignalBuilderSpreadsheet(fileName);
importedVars = import(aReader,'myGroup1');

Export the signals from Signal Editor.

ds = Simulink.SimulationData.Dataset;
ds = ds.addElement(timeseries([1:10]',[1:10]'),'Signal1'); %#ok<*NBRAK>
ds = ds.addElement(timeseries([1:10]',[11:20]'),'Signal2');
ds = ds.addElement(timeseries([1:10]',[21:30]'),'Signal3');

aReader = Simulink.io.SignalBuilderSpreadsheet('myFileToExport.xls');

didWrite = aReader.export(filePath,{'ds'},{ds},0);

Version History

Introduced in R2020a