io.reader クラス

名前空間: io

シミュレーションデータインスペクターのカスタム変数またはファイルリーダーの定義に使用される基底クラス

R2020b 以降

説明

io.reader 基底クラスを使用して、カスタム変数とファイル形式をシミュレーションデータインスペクターにインポートする方法を指定します。io.reader メソッドを使用するクラス定義ファイルを記述して、変数またはファイルから時間値やデータ値などの情報を抽出する方法を指定します。次の構文を、io.reader クラスから継承するクラス定義ファイルの最初の行として使用します。MyReader はサブクラスの名前です。

classdef MyReader < io.reader

カスタムファイルリーダーの記述および使用方法を示す例については、カスタムファイルリーダーを使用したデータのインポートを参照してください。

カスタムワークスペースデータリーダーの記述および使用方法を示す例については、カスタムデータリーダーを使用したワークスペース変数のインポートを参照してください。

io.reader クラスは handle クラスです。

クラス属性

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

クラス属性の詳細については、クラスの属性を参照してください。

プロパティ

すべて展開する

`FileName` — インポートされたファイルの名前
`''` (既定値) | 文字配列

ファイルのインポートにサブクラスを使用する場合のインポートされたファイルの名前。文字配列として指定します。

例: 'MyCustomFile'

属性:

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

`VariableName` — インポートされた変数の名前
`''` (既定値) | 文字配列

インポートされた変数または信号の名前。文字配列として指定します。

例: 'MyVar'

属性:

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

`VariableValue` — インポートされた変数
変数

インポートされた変数。VariableValue プロパティはワークスペースまたはファイル内の変数と同じデータ型をもちます。VariableValue プロパティを使用してメソッド定義内の変数データにアクセスします。

例: MyVar

属性:

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

メソッド

すべて展開する

パブリックメソッド

抽象メソッド

`getName`	カスタムリーダーを使用してインポートされたデータの名前を取得する
`getDataValues`	カスタムリーダーを使用してインポートされたデータのデータ値を返す
`getTimeValues`	カスタムリーダーを使用してインポートされたデータの時間値を返す

一般的に使用されるメソッド

`getChildren`	カスタムリーダーを使用してインポートされたデータの各ノードと信号に対するカスタムリーダーオブジェクトを返す
`supportsFile`	カスタムリーダーがファイルをサポートするかどうかの論理インジケーターを返す
`registerFileReader`	シミュレーションデータインスペクターで使用するカスタムファイルリーダーの登録
`unregisterFileReader`	シミュレーションデータインスペクターに対するカスタムファイルリーダーの登録解除
`supportsVariable`	カスタムリーダーが変数をサポートするかどうかの論理インジケーターを返す
`registerWorkspaceReader`	シミュレーションデータインスペクターに対するカスタムワークスペースリーダーの登録
`unregisterWorkspaceReader`	シミュレーションデータインスペクターに対するカスタムワークスペースリーダーの登録解除

静的メソッド

`io.reader.getRegisteredFileReaders`	シミュレーションデータインスペクターに登録されたすべてのカスタムファイルリーダーを返す
`io.reader.getSupportedReadersForFile`	ファイルのインポートに使用できるすべてのリーダーを返す
`io.reader.getRegisteredWorkspaceReaders`	シミュレーションデータインスペクターに登録されているすべてのカスタムワークスペースリーダーを返す

追加のパブリックメソッド

`getDescription`	`desc = getDescription(obj)` カスタムファイルリーダーの説明を提供し、シミュレーションデータインスペクターのインポートダイアログに表示する文字配列または string を返します。
`getSampleDimensions`	`dims = getSampleDimensions(obj)` 単一のサンプルの次元を表すベクトルを返します。スカラー信号の場合、`[1]` を返します。幅広い信号に対して 1 つの値を返します (`[3]`)。
`getSignalDescription`	`desc = getSignalDescription(obj)` インポートされた `Simulink.sdi.Signal` オブジェクトの `Description` プロパティに対する値として使用する文字配列または string を返します。
`getBlockPath`	`blkPath = getBlockPath(obj)` 信号のソースを表す文字配列、string、または `Simulink.SimulationData.BlockPath` オブジェクトを返します。
`getPortIndex`	`portInd = getPortIndex(obj)` 信号を生成するブロック出力端子のインデックスに対応する整数を返します。
`getInterpolation`	`int = getInterpolation(obj)` ゼロ次ホールド内挿を使用する `zoh` または線形内挿を使用する `linear` が含まれる文字配列または string を返します。
`getUnit`	`sigUnit = getUnit(obj)` 信号の測定単位が含まれる文字配列または string を返します。
`isEventBasedSignal`	`eventBased = isEventBasedSignal(obj)` 信号がイベントベースまたはメッセージの場合は true を返します。

io.reader クラス