Main Content

共通のブロック プロパティ

この表は、ブロック コールバック プロパティを含む、すべての Simulink® ブロックに共通のプロパティを示しています (コールバックを使用したモデル動作のカスタマイズを参照)。この表の後に、これらのプロパティを変更するコマンドの例を示します (ブロックプロパティ設定の例を参照)。

共通のブロック プロパティ

プロパティ説明値

AncestorBlock

ブロックがリンクされているライブラリ ブロックの名前 (使用できないリンクをもつブロックの名前)。

文字ベクトル

AttributesFormatString

ブロック注釈テキスト (ブロック プロパティに対応する)。

文字ベクトル

BackgroundColor

背景色。

カラー値 |'[r,g,b]' | '[r,g,b,a]'

r、g および b は、0.0 ～ 1.0 の範囲の赤、緑および青のカラー値です。この値を指定すると、アルファ値 (a) は無視されます。

指定できるカラー値は 'black'、'white'、'red'、'green'、'blue'、'cyan'、'magenta'、'yellow'、'gray'、'lightBlue'、'orange'、'darkGreen' です。

BlockDescription

ブロック パラメーターのダイアログ ボックスまたはプロパティ インスペクターの上部に表示されるブロックの説明。

文字配列

BlockType

ブロック タイプ (読み取り専用)。

文字配列

BlockKeywords

1 つ以上のキーワードをカスタム ライブラリ ブロックに関連付けます。

文字ベクトル | string スカラー | string 配列

BlockMirrorブロック ミラー。

{'off'} | 'on'

BlockRotationブロック回転角度。

0 度の回転の場合は、double 型数値 0。270 度の回転の場合は、270。

ClipboardFcn

ブロックをクリップボードにコピー (Ctrl+C) するか、メニュー項目 [コピー] を選択したときに呼び出される関数。

関数 | 文字ベクトル

CloseFcn

close_system がブロックで実行されるときに呼び出される関数。

関数 | 文字ベクトル

Commentedシミュレーションからブロックを除外します。

{'off'} | 'on' | 'through'

CompiledBusType

端子に接続されている信号が、バスでないか、バーチャル バスであるか、または非バーチャル バスであるかを返します (読み取り専用)。

get_param を使用している場合は端子またはライン ハンドルを指定します。以下に例を示します。

ports = get_param(gcb,'PortHandles');
feval(gcs,[],[],[],'compile');
bt = get_param(ports.Outport,'CompiledBusType')

バス情報の表示を参照してください。

'NOT_BUS' | 'VIRTUAL_BUS' | 'NON_VIRTUAL_BUS'

CompiledIsActive

コンパイル時にブロックのステータスがアクティブかどうかを指定します。

CompiledIsActive は、コンパイル時に次の条件のいずれか 1 つに当てはまる場合に off を返します。

  • ブロックがインライン バリアントの非アクティブなパスである。

  • ブロックがバリアント サブシステムの非アクティブな選択肢である。

  • ブロックがコメントアウトされたサブシステムにある。

  • ブロックがバリアント サブシステムから伝播された条件により非アクティブになっている。

CompiledisActive は、非アクティブな選択肢の場合は off を返し、バリアント サブシステムのアクティブな選択肢の場合は on を返します。

'off' | 'on'

CompiledPortComplexSignals

ブロック線図を更新した後の端子信号の実数/複素数。このプロパティを照会する前に、モデルをコンパイルする必要があります。以下に例を示します。

openExample('simulink_general/VanDerPolOscillatorExample');
vdp([],[],[],'compile');
d = get_param(gcb,'CompiledPortComplexSignals');
vdp([],[],[],'term');
構造体配列

CompiledPortDataTypes

ブロック線図を更新した後の端子信号のデータ型。このプロパティを照会する前に、モデルをコンパイルする必要があります。CompiledPortComplexSignals を参照してください。

構造体配列

CompiledPortDesignMin

ブロック線図を更新した後の端子信号の設計の最小値。このプロパティを照会する前に、モデルをコンパイルする必要があります。以下に例を示します。

feval(gcs, [],[],[],'compile');
ports = get_param(gcb,'PortHandles');
min = get_param(ports.Outport, 'CompiledPortDesignMin')
feval(model, [],[],[],'term');
構造体配列

CompiledPortDesignMax

コンパイル時の端子信号の設計の最大値。このプロパティを照会する前に、モデルをコンパイルする必要があります。以下に例を示します。

feval(gcs, [],[],[],'compile');
ports = get_param(gcb,'PortHandles');
max = get_param(ports.Outport, 'CompiledPortDesignMax')
feval(model, [],[],[],'term');
構造体配列

CompiledPortDimensions

ブロック線図を更新した後の端子信号の次元。このプロパティを照会する前に、モデルをコンパイルする必要があります。詳細については、コンパイルされた端子の次元の取得を参照してください。

数値配列

CompiledPortDimensionsMode

端子信号に可変サイズがあるかどうかを示します (ブロック線図の更新後)。このプロパティを照会する前に、モデルをコンパイルする必要があります。信号線が可変サイズかどうかの確認を参照してください。

double 型。0 は信号に可変サイズがないことを示します。1 は信号に可変サイズがあることを示します。

CompiledPortFrameData

ブロック線図を更新した後の端子信号のフレーム モード。このプロパティを照会する前に、モデルをコンパイルする必要があります。

構造体配列

CompiledPortUnits

ブロック端子の単位の構造体配列 (ブロック線図の更新後)。このプロパティを照会する前に、モデルをコンパイルする必要があります。

構造体配列

CompiledPortWidths

ブロック線図を更新した後の端子幅の構造体。このプロパティを照会する前に、モデルをコンパイルする必要があります。

構造体配列

CompiledSampleTime

ブロック線図を更新した後のブロック サンプル時間。このプロパティを照会する前に、モデルをコンパイルする必要があります。

ベクトル [sample time, offset time]

または

cell {[sample time 1, offset time 1]; [sample time 2, offset time 2];.....[sample time n, offset time n]}

ContinueFcn

シミュレーション再開時に呼び出される関数 (一時停止の後)。

関数 | 文字ベクトル

CopyFcn

ブロックをコピーするときに呼び出される関数。詳細については、ブロックのコールバックを参照してください。

関数 | 文字ベクトル

DataTypeOverrideCompiled

内部で使用。

 

DeleteFcn

ブロックを削除するときに呼び出される関数。詳細については、ブロックのコールバックを参照してください。

MATLAB® 式

DestroyFcn

ブロックを破壊するときに呼び出される関数。詳細については、ブロックのコールバックを参照してください。

MATLAB 式

Description

ブロックの説明。[ブロック プロパティ] ダイアログ ボックスの [一般] ペインの [説明] フィールドで設定します。

テキストとトークン

Diagnostics

内部で使用。

 

DialogParameters

非マスク ブロックのブロック固有のパラメーターまたはマスク ブロックのマスク パラメーターの名前/属性のリスト。

構造体

DropShadow

影の表示。

{'off'} | 'on'

ExtModeLoggingSupported

ブロックがエクスターナル モードでの (たとえば、Scope ブロックでの) 信号データのアップロードをサポートできるようにします。

{'off'} | 'on'

ExtModeLoggingTrig

ブロックがeエクスターナル モードでの信号アップロードの Trigger ブロックとして機能できるようにします。

{'off'} | 'on'

ExtModeUploadOption[外部信号とトリガー] ダイアログ ボックスで [すべて選択] チェック ボックスがオフの場合に、ブロックがエクスターナル モードで信号データをアップロードできるようにします。値を log にすると、ブロックが信号をアップロードします。値を none にすると、ブロックは信号をアップロードしません。monitor という値は、現在使用されていません。[外部信号とトリガー] ダイアログ ボックスで [すべて選択] チェック ボックスをオンにしている場合は、このパラメーターの設定がオーバーライドされます。{'none'} | 'log' | 'monitor'

FontAngle

フォントの角度。

'normal' | 'italic' | 'oblique' | {'auto'}

FontName

フォント名。

文字配列

FontSize

フォント サイズ。値が -1 のときは、このブロックが DefaultBlockFontSize モデル パラメーターで指定されるフォント サイズを継承することを示します。

real {'-1'}

FontWeight

フォントの重み。

'light' | 'normal' | 'demi' | 'bold' | {'auto'}

ForegroundColor

ブロック アイコンの前景色。

カラー値 |'[r,g,b]' | '[r,g,b,a]'

r、g および b は、0.0 ～ 1.0 の範囲の赤、緑および青のカラー値です。値は、キャンバスの色 (ScreenColor パラメーター) に非常に似ている場合変更されます。get_param を使用すると、実際の値が返されます。この値を指定すると、アルファ値 (a) は無視されます。

指定できるカラー値は 'black'、'white'、'red'、'green'、'blue'、'cyan'、'magenta'、'yellow'、'gray'、'lightBlue'、'orange'、'darkGreen' です。

Handle

ブロック ハンドル。

実数

HideAutomaticName

Simulink エディターによって自動的に指定されたブロック名をモデル内に表示するかどうかを指定します。自動生成名を非表示にするには、既定の設定 'on' を使用します (モデルの HideAutomaticNames パラメーターも 'on' に設定しなければなりません)。'off' に設定して名前を表示し、ブロックの ShowName パラメーターも 'on' に設定します。この設定にかかわらず、ShowName パラメーターが 'off' のブロックは非表示になります。パラメーターの相互作用の詳細については、Hide or Display Block Namesを参照してください。{'on'} | 'off'

HiliteAncestors

内部で使用。

 

InitFcn

ブロックの初期化関数。[モデル プロパティ] ダイアログ ボックスの [コールバック] ペインで作成します。詳細については、モデルのコールバックの作成を参照してください。

非マスク ブロックでは、ブロック線図を更新するか、シミュレーションを実行すると、この関数が呼び出されます。

MATLAB 式

InputSignalNames

入力信号の名前。

cell 配列

IntrinsicDialogParameters

ブロック固有のパラメーター (マスク ブロックか非マスク ブロックかに関係ない) の名前/属性のリスト。マスク ブロックまたは非マスク ブロックのブロック固有のパラメーターが必要な場合は代わりに DialogParameters を使用します。

構造体

IOSignalStrings

ビューアーおよびジェネレーター マネージャーに接続されているオブジェクトへのブロック パス。Simulink ソフトウェアによりモデルの保存時にこれらのパスが保存されます。

list

IOType

ビューアーおよびジェネレーター マネージャーのタイプ。内部で使用。

 

IsStateOwnerBlock

ブロックが State Reader ブロックおよび State Writer ブロック (読み取り専用) と共に使用できる、サポートされている状態オーナー ブロックであるかどうかを示します。State Reader および State Writer を参照してください。

'off' | 'on'

LibraryVersion

リンクされたブロックの場合、このプロパティの初期値はリンクが作成されたときのライブラリの ModelVersion です。ライブラリのモデル バージョンでは値がインクリメントで更新されます。

文字ベクトル — {'1.1'}

LineHandles

ブロックに接続されているラインのハンドル。

構造体

LinkData

パラメーター付きのリンクとそのライブラリとの間で異なるリンク内のブロックへの変更に関する詳細の配列。ブロック名とパラメーター値がリストされています。deparameterized (パラメーターなし) にリセットするには set_param(gcb,'linkData',[]) のように [] を使用します。

cell 配列

LinkStatus

ブロックのリンク ステータス。get_param を使用してクエリするときに無効なリンク付きブロックを更新します。

リンク付きブロックのプログラムによる制御を参照してください。

'none' | 'resolved' | 'unresolved' | 'implicit' | 'inactive' | 'restore' | 'propagate' | 'propagateHierarchy' | 'restoreHierarchy'

LoadFcn

ブロックを読み込むときに呼び出される関数。

MATLAB 式

MinMaxOverflowLogging_Compiled

内部で使用。

 

ModelCloseFcn

モデルが閉じているときに呼び出される関数。ModelCloseFcn は、ブロックの DeleteFcn および DestroyFcn コールバックのいずれかが設定されている場合に、その前に呼び出されます。

MATLAB 式

ModelParamTableInfo

内部で使用。

 

MoveFcn

ブロックを移動するときに呼び出される関数。

MATLAB 式

Name

ブロックまたは信号名。

信号名を指定するには、対応する端子とライン ハンドルを使用します。

ports = get_param(gcb,'PortHandles');
set_param(ports.Outport(1),'Name','NewName');

信号名を伝播するには、モデルをコンパイルします。Simulink ツールストリップの [モデル化] タブで [モデルの更新] をクリックします。

あるいは、ブロックの出力信号に名前を付ける場合は、SignalNameFromLabel を使用できます。

文字ベクトル

NameChangeFcn

ブロック名が変更されるときに呼び出される関数。

MATLAB 式

NamePlacement

ブロック名の位置。

{'normal'} | 'alternate'

ObjectParameters

ブロック パラメーターの名前または属性。

構造体

OpenFcn

この [ブロック パラメーター] ダイアログ ボックスが開いたときに呼び出される関数。

MATLAB 式

Orientation

ブロックの向き。

{'right'} | 'left' | 'up' | 'down'

OutputSignalNames

出力信号の名前。

cell 配列

Parent

ブロックを所有するシステムの名前。

文字ベクトル {'untitled'}

ParentCloseFcn

親サブシステムを閉じるときに呼び出される関数。モデルが閉じられている場合は、ルート モデル レベルのブロックの ParentCloseFcn は呼び出されません。

MATLAB 式

PauseFcn

シミュレーションの一時停止時に呼び出される関数。

関数 | 文字ベクトル

PortConnectivity

このプロパティの値は、構造体の配列で、各構造体では、ブロックの入力端子または出力端子の 1 つを説明します。各端子の構造体は、次のフィールドをもちます。

  • Type

    端子のタイプや数を指定します。このフィールドは、次の値をとることができます。

    • n。ここで、n はデータ端子の端子数です。

    • 'enable' 端子がイネーブル端子である場合

    • 'trigger' 端子がトリガー端子である場合

    • 'state' 状態端子に対して

    • 'ifaction' アクション端子に対して

    • 'LConn#' 左接続端子に対して。# は端子番号

    • 'RConn#' 右接続端子に対して。# は端子番号

    • 'event' サブシステムの再初期化イベント端子に対して

  • Position

    このフィールドの値は、端子の位置を指定する 2 要素ベクトル [x y] です。

  • SrcBlock

    この端子に接続されているブロックのハンドル。このフィールドは、出力端子には [] で、未接続の入力端子には -1 になります。SrcBlock プロパティは Variant Subsystem ブロックの有効なソース ハンドルです。

  • SrcPort

    この端子に接続されている、ゼロからはじまる端子数。このフィールドは、出力端子と未接続の入力端子の両方に対して [] になります。

  • DstBlock

    この端子に接続されているブロックのハンドル。このフィールドは、入力端子には [] で、未接続の出力端子には 1 行 0 列の空の行列になります。

  • DstPort

    この端子に接続されている、ゼロからはじまる端子数。このフィールドは、入力端子には [] で、未接続の出力端子には 1 行 0 列の空の行列になります。Simscape™ ブロックの場合、フィールドには端子ハンドルが含まれます。

構造体配列

PortHandles

このプロパティの値は、ブロックの端子のハンドルを指定する構造体です。この構造体には、以下のフィールドがあります。

  • Inport

    入力端子のハンドル。

  • Outport

    出力端子のハンドル。

  • Enable

    イネーブル端子のハンドル。

  • Trigger

    トリガー端子のハンドル。

  • State

    状態端子のハンドル。

  • LConn

    左接続端子のハンドル (物理モデリング ツールをサポートするブロック)。

  • RConn

    右接続端子のハンドル (物理モデリング ツールをサポートするブロック)。

  • Ifaction

    アクション端子のハンドル。

  • Reset

    リセット端子のハンドル。

  • Event

    サブシステムの再初期化イベント端子のハンドル。

構造体配列

PortRotationType

このブロックにより使用される端子の回転タイプ (読み取り専用)。

'default' | 'physical'

Ports

このブロックがもつ各種の端子数を指定するベクトル。ベクトルの要素の順序は、次の端子のタイプに対応します。

  • Inport

  • Outport

  • Enable

  • Trigger

  • State

  • LConn

  • RConn

  • Ifaction

  • Reset

  • Event

ベクトル

Position

モデル ウィンドウでのブロックの位置。

ブロックの並びを整えるために、設定する位置を実際のブロック位置と数ピクセルだけ変えることができます。get_param を使用すると、実際の位置が返されます。

座標ベクトル (ピクセル単位): [left top right bottom]

いずれかのキャンバスがサイズ変更される前は、原点は Simulink エディターのキャンバスの左上隅にあります。サポートされる座標の範囲は -1073740824 以上 1073740823 以下です。原点より右および下が正の値です。原点より左および上が負の値です。

PostSaveFcn

ブロックが保存された後に呼び出される関数。

MATLAB 式

PreCopyFcn

ブロックがコピーされる前に呼び出される関数。詳細については、ブロックのコールバックを参照してください。 MATLAB 式

PreDeleteFcn

ブロックが削除される前に呼び出される関数。詳細については、ブロックのコールバックを参照してください。 MATLAB 式

PreSaveFcn

ブロックが保存される前に呼び出される関数。詳細については、ブロックのコールバックを参照してください。

MATLAB 式

Priority

同じモデル内の他のブロックに対するブロックの実行順序を指定します。[ブロック プロパティ] ダイアログ ボックスの [一般] ペインの [優先順位] フィールドで設定します。

文字ベクトル {''}

ReferenceBlock

このブロックがリンクするライブラリ ブロックの名前。

文字ベクトル {''}

RequirementInfo

内部で使用。

 

RTWData

ユーザーが指定するデータ。Simulink Coder™ ソフトウェアで使用されます。ユーザー定義 S-Function 専用。詳細については、S-Function RTWdata (Simulink Coder)の節を参照してください。

 

SampleTime

サンプル時間パラメーターの値。詳細については、サンプル時間の指定を参照してください。

文字ベクトル

Selected

ブロックが選択されているかどうかのステータス。

{'on'} | 'off'

ShowName

ブロック名の表示または非表示。

Simulink エディターで指定したブロック名 (自動生成名) を表示するには、ブロックの 'HideAutomaticName' パラメーターを 'off' に、ShowName を 'on' に設定します。エディターで指定した自動ブロック名を非表示にするには、モデル上で ShowName を 'on' に、HideAutomaticName を 'on' に、HideAutomaticNames を 'on' に設定します。パラメーターの相互作用の詳細については、Hide or Display Block Namesを参照してください。

{'on'} | 'off'

SignalHierarchy

信号がバス信号の場合、バス内の信号の名前と階層が返されます (読み取り専用)。

get_param を使用している場合は端子またはライン ハンドルを指定します。以下に例を示します。

ports = get_param(gcb,'PortHandles');
feval(gcs,[],[],[],'compile');
sh = get_param(ports.Outport,'SignalHierarchy')

バス情報の表示を参照してください。

指定した信号の構造体を反映した値

StartFcn

シミュレーションの開始時に呼び出される関数。

MATLAB 式

StatePerturbationForJacobian

線形化時に使用する状態の摂動サイズ。詳細については、線形化時に摂動するブロックの摂動レベルの変更 (Simulink Control Design)を参照してください。

文字ベクトル

StaticLinkStatus

ブロックのリンク ステータス。get_param を使用してクエリするときに無効なリンク付きブロックを更新しません。「LinkStatus」も参照してください。

'none' | 'resolved' | 'unresolved' | 'implicit' | 'inactive' | 'restore' | 'propagate' | 'propagateHierarchy' | 'restoreHierarchy'

StopFcn

シミュレーションの終了時に呼び出される関数。

MATLAB 式

Tag

Simulink ソフトウェアが生成するブロック ラベルに表示するテキスト。[ブロック プロパティ] ダイアログ ボックスの [一般] ペインの [タグ] フィールドで設定します。

文字ベクトル {''}

Type

Simulink オブジェクト タイプ (読み取り専用)。

'block'

UndoDeleteFcn

ブロックの削除が行われていないときに呼び出される関数。

MATLAB 式

UserData

任意の MATLAB データ型にすることができるユーザー定義データ。

{'[]'}

UserDataPersistent

UserData がモデル ファイルに保存されるかどうかのステータス。

'on' | {'off'}

VariantConfigurationObjectモデルに関連付けられたバリアント構成オブジェクトを指定する。Save and Reuse Variant Configurations Using Variant Configuration Data Objectを参照してください。{''}
構成オブジェクトが関連付けられていない場合、値は空の文字ベクトルです。それ以外の場合は、Simulink.VariantConfigurationData オブジェクトの名前です。

ブロックプロパティ設定の例

これらの例は、共通のブロック プロパティの変更方法を示します。

このコマンドは、mymodel システムでの Gain ブロックの向きを変更して、反対向きにします (右から左)。

set_param('mymodel/Gain','Orientation','left')

このコマンドは、OpenFcn コールバックを mymodel システムの Gain ブロックと関連付けます。

set_param('mymodel/Gain','OpenFcn','my_open_cb')

このコマンドは、mymodel システムの Gain ブロックの Position プロパティを設定します。ブロックは、幅 75 ピクセル、高さ 25 ピクセルです。 

set_param('mymodel/Gain','Position',[50 250 125 275])

参考

|

関連するトピック