commentedBy

グラフィカル オブジェクトを暗黙的にコメントアウトするオブジェクトの特定

R2023a 以降

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

構文

objArray = commentedBy(graphicalObject)

説明

objArray = commentedBy(graphicalObject) は、グラフィカル オブジェクト graphicalObject をコメントアウトさせる明示的にコメント化されたオブジェクトの配列を返します。グラフィカル オブジェクトは次の場合にコメントアウトされます。

  • IsExplicitlyCommented プロパティの値が true である。この場合、objArray にはグラフィカル オブジェクトが含まれます。

  • IsImplicitlyCommented プロパティの値が true である。この場合、objArray には、オブジェクトを含む明示的にコメント化されたステート、ボックス、または関数が含まれます。さらに次のようになります。

    • graphicalObject が遷移である場合、objArray には、遷移元または遷移先をコメントアウトさせる明示的にコメント化されたオブジェクトが含まれます。

    • graphicalObject が entry 端子または exit 端子である場合、objArray には、対応する entry ジャンクションまたは exit ジャンクションをコメントアウトさせる明示的にコメント化されたオブジェクトが含まれます。

例

例

すべて折りたたむ

この例では次を使用します。

ライブ スクリプトを開く

ステート、ボックス、または関数を明示的にコメントアウトすると、それに含まれるすべてのグラフィカル オブジェクトが暗黙的にコメントアウトされます。たとえば、次のチャートのステート 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.

モデルを開きます。

open_system("sfHierarchyAPIExample")

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

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

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

get([sA sA1 sA2],{"Name", ...
    "isCommented","isExplicitlyCommented","isImplicitlyCommented"})
ans=3×4 cell array
    {'A' }    {[0]}    {[0]}    {[0]}
    {'A1'}    {[0]}    {[0]}    {[0]}
    {'A2'}    {[0]}    {[0]}    {[0]}

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

sA.IsExplicitlyCommented = true;
sA2.IsExplicitlyCommented = true;

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

get([sA sA1 sA2],{"Name", ...
    "isCommented","isExplicitlyCommented","isImplicitlyCommented"})
ans=3×4 cell array
    {'A' }    {[1]}    {[1]}    {[0]}
    {'A1'}    {[1]}    {[0]}    {[1]}
    {'A2'}    {[1]}    {[1]}    {[1]}

各ステートをコメントアウトさせる明示的にコメント化されたオブジェクトを特定します。

get(commentedBy(sA),{"Name"})
ans = 1×1 cell array
    {'A'}


get(commentedBy(sA1),{"Name"})
ans = 1×1 cell array
    {'A'}


get(commentedBy(sA2),{"Name"})
ans = 2×1 cell
    {'A' }
    {'A2'}

入力引数

すべて折りたたむ

制限

  • グラフィカル オブジェクトが Atomic サブチャートまたは Atomic ボックスに含まれている場合、関数 commentedBy は、そのサブチャートまたはボックスに含まれている明示的にコメント化されたオブジェクトのみを返します。

バージョン履歴

R2023a で導入

参考

関数

オブジェクト

トピック