Main Content

isCommented

グラフィカル オブジェクトがコメントアウトされているかどうかの判別

ページ内をすべて折りたたむ

構文

tf = isCommented(graphicalObject)

説明

例

tf = isCommented(graphicalObject) は、グラフィカル オブジェクトがコメントアウトされているかどうかを示す論理値を返します。関数は次の場合に logical 1 (true) を返します。

  • グラフィカル オブジェクトが明示的にコメントアウトされている。オブジェクトを明示的にコメントアウトするには、その IsExplicitlyCommented プロパティを true に設定します。あるいは、グラフィカル オブジェクトを右クリックして [コメント アウト] を選択できます。

  • グラフィカル オブジェクトが暗黙的にコメントアウトされている。この場合、その IsImplicitlyCommented プロパティの値が true になっています。オブジェクトを含むステート、ボックス、または関数を明示的にコメントアウトすると、そのオブジェクトは暗黙的にコメントアウトされます。さらに次のようになります。

    • 遷移は、その遷移元と遷移先をコメントアウトすると暗黙的にコメントアウトされます。

    • 入口端子と出口端子は、対応する入口ジャンクションまたは出口ジャンクションをコメントアウトすると暗黙的にコメントアウトされます。

それ以外の場合、関数は logical 0 (false) を返します。

例

すべて折りたたむ

ステート、ボックス、または関数を明示的にコメントアウトすると、それに含まれるすべてのグラフィカル オブジェクトが暗黙的にコメントアウトされます。たとえば、次のチャートのステート A をコメントアウトすると、そのサブステートである A1 と A2 もコメントアウトされます。

Stateflow chart with a hierarchy of states. The outer state is called A. It contains two inner states called A1 and A2.

A、A1、および A2 という名前の Stateflow.State オブジェクトを検索します。

sA = find(ch,"-isa","Stateflow.State",Name="A");
sA1 = find(ch,"-isa","Stateflow.State",Name="A1");
sA2 = find(ch,"-isa","Stateflow.State",Name="A2");

ステート A とそのサブステートがコメントアウトされていないことを確認します。

[isCommented(sA),isCommented(sA1),isCommented(sA2)]
ans =

  1×3 logical array

   0   0   0

ステート A を明示的にコメントアウトします。

sA.IsExplicitlyCommented = true;

ステート A とそのサブステートがコメントアウトされていることを確認します。

[isCommented(sA),isCommented(sA1),isCommented(sA2)]
ans =

  1×3 logical array

   1   1   1

入力引数

すべて折りたたむ

グラフィカル オブジェクト。次のいずれかのタイプの Stateflow® API オブジェクトとして指定します。

バージョン履歴

R2016a で導入

参考

関数

オブジェクト

トピック