Simulink.Block.getSampleTimes

ブロックのサンプル時間情報を返す

構文

ts = Simulink.Block.getSampleTimes(block)

入力引数

block

Simulink ブロックの完全な名前またはハンドル

出力引数

ts

関数 Simulink.Block.getSampleTimes は、指定されたモデルに関連付けられている Simulink.SampleTime オブジェクトの 1 行 n 列の配列 ts を返します。ここで、n はそのモデルに関連付けられているサンプル時間の数です。戻り値の形式は、以下のとおりです。

1xn Simulink.SampleTime
Package: Simulink


value: [1x2 double]
Description: [char string]
ColorRGBValue: [1x3 double]
Annotation: [char string]
OwnerBlock: [char string]
ComponentSampleTimes: [1x2 struct]


Methods

  • value — サンプル時間とオフセットを含む 2 つの double の要素配列。マルチレートの場合、Simulink によって任意のサンプル時間の周期とオフセットが割り当てられるため、値は空です。

  • Description — サンプル時間のタイプを記述する文字ベクトルまたは string。

  • ColorRGBValue — サンプル時間の色の値 (RGB: 赤、緑、青) を含む 1 行 3 列の double の配列。

  • Annotation — 特定のサンプル時間の注釈 ('D1' など) を表す文字ベクトルまたは string

  • OwnerBlock — 非同期、制御可能、IRT、離散エクスポート関数、および可変サンプル時間の場合、サンプル時間を制御するブロックへの絶対パスを含む文字ベクトルまたは string。他のすべてのタイプのサンプル時間では、空の文字ベクトルまたは string になります。

  • ComponentSampleTimes — Simulink.Block.getSampleTimes と同じ型の要素からなる構造体の配列 (サンプル時間が非同期の和集合の場合、またはサンプル時間がマルチレートでコンポーネント サンプル時間が利用可能な場合)。

説明

ts = Simulink.Block.getSampleTimes(block) は、ブロック線図の更新を行い、次に入力引数 mdl/signal で指定されたブロックに関連付けられているサンプル時間を返します。ブロック線図の更新は、返されるサンプル時間の情報が確実に最新となるようにします。モデル API の呼び出しによって、モデルが既にコンパイル済みの状態になっている場合、ブロック線図の更新は必要ありません。

このメソッドを使用すると、タイミング凡例のすべての情報にプログラムからアクセスできます。

バージョン履歴

R2009a で導入

参考