io.reader Class

Namespace: io

Base class used to define custom variable or file reader for Simulation Data Inspector

Since R2020b

Description

Use the io.reader base class to specify how to import custom variable and file formats into the Simulation Data Inspector. Write a class definition file that uses the io.reader methods to specify how to extract information like time and data values from the variable or file. Use this syntax as the first line in the class definition file to inherit from the io.reader class, where MyReader is the name of your subclass:

classdef MyReader < io.reader

For an example that shows how to write and use a custom file reader, see Import Data Using Custom File Reader.

For an example that shows how to write and use a custom workspace data reader, see Import Workspace Variables Using a Custom Data Reader.

The io.reader class is a handle class.

Class Attributes

`Abstract`	`true`
`HandleCompatible`	`true`

For information on class attributes, see Class Attributes.

Properties

expand all

`FileName` — Name of imported file
`''` (default) | character array

Name of imported file when using the subclass to import a file, specified as a character array.

Example: 'MyCustomFile'

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`VariableName` — Name of imported variable
`''` (default) | character array

Name of imported variable or signal, specified as a character array.

Example: 'MyVar'

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`VariableValue` — Imported variable
variable

Imported variable. The VariableValue property has the same data type as the variable in the workspace or file. Use the VariableValue property to access the variable data inside method definitions.

Example: MyVar

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Methods

expand all

Public Methods

Abstract Methods

`getName`	Get names for data imported using a custom reader
`getDataValues`	Return data values for data imported using a custom reader
`getTimeValues`	Return time values for data imported using a custom reader

Commonly Used Methods

`getChildren`	Return custom reader object for each node and signal in data imported using a custom reader
`supportsFile`	Return logical indication of whether custom reader supports file
`registerFileReader`	Register custom file reader for use in the Simulation Data Inspector
`unregisterFileReader`	Unregister custom file reader for the Simulation Data Inspector
`supportsVariable`	Return logical indication of whether custom reader supports variable
`registerWorkspaceReader`	Register custom workspace reader for the Simulation Data Inspector
`unregisterWorkspaceReader`	Unregister custom workspace reader for the Simulation Data Inspector

Static Methods

`io.reader.getRegisteredFileReaders`	Return all custom file readers registered for the Simulation Data Inspector
`io.reader.getSupportedReadersForFile`	Return all readers available to import file
`io.reader.getRegisteredWorkspaceReaders`	Return all custom workspace readers registered for the Simulation Data Inspector

Additional Public Methods

`getDescription`	`desc = getDescription(obj)` Return a character array or string that provides a description of the custom file reader to display in the import dialog in the Simulation Data Inspector.
`getSampleDimensions`	`dims = getSampleDimensions(obj)` Return a vector that represents the dimensions of a single sample. For a scalar signal, return `[1]`. Return a single value for wide signals (`[3]`).
`getSignalDescription`	`desc = getSignalDescription(obj)` Return a character array or string to use as the value for the `Description` property of the imported `Simulink.sdi.Signal` object.
`getBlockPath`	`blkPath = getBlockPath(obj)` Return a character array, string, or `Simulink.SimulationData.BlockPath` object that represents the source of the signal.
`getPortIndex`	`portInd = getPortIndex(obj)` Return an integer that corresponds to the index of the block output port that produces the signal.
`getInterpolation`	`int = getInterpolation(obj)` Return a character array or string that contains `zoh` to use zero-order hold interpolation or `linear` to use linear interpolation.
`getUnit`	`sigUnit = getUnit(obj)` Return a character array or string that contains the unit of measure for the signal.
`isEventBasedSignal`	`eventBased = isEventBasedSignal(obj)` Return true when the signal is event-based or a message.

Version History

Introduced in R2020b

io.reader Class

Description

Class Attributes

Properties

`FileName` — Name of imported file
`''` (default) | character array

Attributes:

`VariableName` — Name of imported variable
`''` (default) | character array

Attributes:

`VariableValue` — Imported variable
variable

Attributes:

Methods

Public Methods

Additional Public Methods

Version History

See Also

Functions

Objects

Topics

io.reader Class

Description

Class Attributes

Properties

FileName — Name of imported file '' (default) | character array

Attributes:

VariableName — Name of imported variable '' (default) | character array

Attributes:

VariableValue — Imported variable variable

Attributes:

Methods

Public Methods

Additional Public Methods

Version History

See Also

Functions

Objects

Topics

`FileName` — Name of imported file
`''` (default) | character array

`VariableName` — Name of imported variable
`''` (default) | character array

`VariableValue` — Imported variable
variable