Simulink.io.FileType Class

Namespace: Simulink.io

Base class for file type readers for Simulink interfaces such as Signal Editor

Since R2020a

Description

Simulink.io.FileType is the base class for Simulink.io.FileType objects. In your class definition file, you must subclass your object from this base class. Simulink^® requires direct inheritance from FileType. Subclassing allows you to use the implementation methods and service methods provided by this class to build your object. Type this syntax as the first line of your class definition file to directly inherit from the Simulink.io.FileType base class, where ObjectName is the name of your object:

classdef ObjectName < Simulink.io.FileType

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

Class Attributes

Abstract	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Properties

FileName — File name

character array

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

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

exportImpl	Export signals to file
Simulink.io.FileType.getFileTypeDescription	Get custom file reader description
Simulink.io.FileType.isFileSupported	Check if file type is supported in Simulink
Simulink.io.FileType.isInput	Check if input is acceptable Simulink input
Simulink.io.FileType.isSimulinkParameter	Check if input is Simulink parameter
loadImpl	Load signal names from custom FileType object
loadAVariableImpl	Load specified variable from MAT-file
validateFileNameImpl	Validate contents of custom MAT-file
whosImpl	Determine contents of MAT-file associated with Simulink.io.FileType object

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 contain 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

Subclass FileType

Define a Simulink.io.FileType class.

classdef MySignalMatFile < Simulink.io.FileType

end

Interact with FileType Using Specialized Functions

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

Get contents of foo.mat.

fileName = 'foo.mat';
aReader = Simulink.io.CreateSignals(fileName);
resultOfWhos = whos(aReader);

Import custom signals from foo.mat.

aFileType = Simulink.io.CreateSignals('foo.mat');
out = import(aFileType);

Load the custom signals in foo.mat.

aFileType = Simulink.io.CreateSignals('foo.mat');
out = load(aFileType);

Load a variable from foo.mat.

aFileType = Simulink.io.CreateSignals('foo.mat');
out = loadAVariable( aFileType,'bar');

Export the signals from Signal Editor.

ds = Simulink.SimulationData.Dataset;
ds = ds.addElement(timeseries([1:10]',[1:10]'),'Siganl1');
ds = ds.addElement(timeseries([1:10]',[11:20]'),'Siganl2');
ds = ds.addElement(timeseries([1:10]',[21:30]'),'Siganl3');

aReader = Simulink.io.CreateSignals('myFileToExport.mat');

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

Version History

Introduced in R2020a