ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

System Object メソッド

System Object メソッドとは

System object™ を作成したら、さまざまなオブジェクト メソッドを使用してデータを処理したり、オブジェクトからの情報やオブジェクトに関する情報を取得できます。オブジェクトに適用できるすべてのメソッドは、そのオブジェクトのリファレンス ページで説明されています。System object メソッド名は小文字で始まり、クラス名とプロパティ名は大文字で始まります。メソッドを使用するための構文は <method>(<handle>) で、たとえば「step(H)」のようになり、必要に応じて入力引数を追加します。

System object では、データ処理に少なくとも 2 つのコマンド、オブジェクトを作成するコンストラクターとオブジェクトからデータを実行する step メソッドを使用します。宣言を実行から分離することで、異なる設定ごとに永続的で再利用可能な複数のオブジェクトを作成できます。このアプローチを使用すると、入力の確認と検証の反復を防ぐことができるだけでなく、プログラミング ループ内で簡単に使用することができるため、全体的なパフォーマンスが向上します。それとは対照的に、MATLAB® 関数は、関数の呼び出しのたびにパラメーターを確認しなければなりません。

これらの利点により、System object は、連続したデータ ストリームのセグメントが反復的に処理されるストリーミング データの処理に特に適しています。ストリーミング データの処理機能により、メモリに大量のデータを保存せずに済むという利点がもたらされます。ストリーミング データの使用により、ループを効率的に使用するシンプルなプログラムを使用できます。

Step メソッド

step メソッドは、主要な System object メソッドです。step は、そのオブジェクトによって定義されたアルゴリズムを使用してデータを処理するために使用します。step メソッドは、初期化やオブジェクトの状態を取り扱うなどのデータ処理に関連するその他の重要なタスクを実行します。各 System object には独自にカスタマイズされた step メソッドがあり、これについては各オブジェクトの step のリファレンス ページで説明されています。step メソッドおよびその他の利用可能なメソッドの詳細は、共通のメソッドの説明を参照してください。

共通のメソッド

すべての System object は、次のメソッドをサポートしています。これらのメソッドは、それぞれ特定のオブジェクトに関連するメソッド リファレンス ページで説明しています。メソッドが特定のオブジェクトに適用できない場合は、そのメソッドを呼び出してもオブジェクトには影響しません。

メソッド説明
step

オブジェクトによって定義されたアルゴリズムを使用してデータを処理します。この処理の一環として、必要なリソースを初期化し、出力を返し、オブジェクト状態を更新します。step メソッドを呼び出した後は、入力仕様 (次元、データ型、複雑度など) は変更できません。実行中は、調整可能なプロパティのみを変更できます。step メソッドは正規の MATLAB 変数を返します。

例: Y = step(H,X)

release

ファイル ハンドルやデバイス ドライバーなど、オブジェクトによって割り当てられた特別なリソースを解放し、オブジェクトのロックを解除します。System object では、デストラクターの代わりに release メソッドを使用します。

resetオブジェクトの内部状態をそのオブジェクトの初期値にリセットします。
getNumInputsstep メソッドで想定される入力数 (オブジェクト自体を除く) を返します。この数値は、オブジェクトで追加の入力を許容するプロパティがあるかどうかによって異なります。
getNumOutputsstep メソッドからの想定される出力数を返します。この数値は、オブジェクトで追加の出力を許容するプロパティがあるかどうかによって異なります。
getDiscreteState構造体のオブジェクトの離散状態を返します。オブジェクトのロック解除時 (オブジェクトがはじめて作成されてから step メソッドが実行されるまでの間、またはオブジェクトの解放後)、状態は空となります。オブジェクトに離散状態がない場合は、getDiscreteState は空の構造体を返します。
clone同じプロパティ値をもつ同じデータ型の別のオブジェクトを作成します。
isLockedオブジェクトがロックされているかどうかを示す論理値を返します。
isDoneソース オブジェクトのみに適用されます。step メソッドがデータ ファイルの終端に到達したかどうかを示す論理値を返します。特定のオブジェクトに end-of-data 機能がない場合、このメソッドの値は false を返します。
infoオブジェクトの特性情報を格納する構造体を返します。この構造体のフィールドは、オブジェクトによって異なります。特定のオブジェクトに特性情報がない場合、この構造体は空になります。

新しい System object の記述メソッドすべての一覧は、「Summary List of Methods for Defining New System Objects」を参照してください。

この情報は役に立ちましたか?