クラスダイアグラムビューアー

クラスの詳細とクラスの階層を調べるダイアグラムの作成

R2021a 以降

説明

クラスダイアグラムビューアーアプリでは、クラス実装の詳細と階層を表示するダイアグラムを作成できます。このアプリを使用してクラス構造体を確認し、クラスダイアグラムを他のユーザーと共有できます。これらのダイアグラムには、次の詳細を含めることができます。

プロパティとメソッドおよびそのアクセス属性を含む、クラスの内部構造
パッケージを含む、継承関係をもつクラスの階層

グラフィカルインターフェイスまたは matlab.diagram.ClassViewer で定義されるコマンドライン API を使用してクラスダイアグラムを作成できます。

クラスダイアグラムビューアーを開く

MATLAB^® ツールストリップ: [アプリ] タブの [MATLAB] で、アプリのアイコンをクリックします。
MATLAB コマンドプロンプト: 「 matlab.diagram.ClassViewer」と入力します。

例

すべて展開する

単純なクラスダイアグラムの作成と保存

クラスダイアグラムビューアーを開きます。[クラスブラウザー] ペインで、[クラスをインポート]、[フォルダー]、または [ファイル] ボタンを展開して [パッケージをインポート] を選択します。パッケージ名として「matlab.unittest」と入力し、[OK] をクリックします。unittest のフォルダーが [クラスブラウザー] に表示されます。

Class Browser with unittest added

unittest フォルダーを展開して InteractiveTestCase クラスを選択します。ツールバーの [追加] ボタンをクリックし、クラスのカードを [クラスダイアグラムビューアー] キャンバスに追加します。同じメソッドを使用して TestCase クラスを追加します。TestCase は InteractiveTestCase のスーパークラスなので、クラスダイアグラムビューアーは自動的に InteractiveTestCase から TestCase までの矢印を描画してこの関係を示します。

TestCase and InteractiveTestCase classes on canvas

クラスカードの上部にある青い縞模様の境界は、これらのクラスの両方がハンドルクラスであることを示しています。[凡例] ペインはキャンバス上のグラフィックス効果とアイコンが何を表しているのかを示しています。

Legend pane

[クラスブラウザー] から直接キャンバスに項目をドラッグアンドドロップすることもできます。ビューアーに Test クラスをドラッグアンドドロップします。カード上部にある green plus button は Test に表示可能なスーパークラスがあることを示しています。

Test class card with green plus button

green plus button をクリックしてスーパークラスをダイアグラムに追加します。Test から TestSuite を指す矢印は TestSuite が Test のスーパークラスであることを示しています。

Test and TestSuite class icons

ドラッグアンドドロップによるビューアーでのクラスの移動に加えて、ツールバーの [ズームとパン] セクションで以下のようなオプションを使用してビューをカスタマイズできます。

ズームインおよびズームアウト
現在の画面サイズに合わせたモデルの表示
パン

[ビュー] セクションで、[mixin] チェックボックスをオンにします。この操作を行っても mixin クラスはダイアグラムに自動的に追加されませんが、この後でスーパークラスを追加するいずれかの操作を実行すると、ビューアーによって mixin クラスが表示に追加されます。

Test のすべてのスーパークラスを追加するには、Test クラスカードを右クリックして [すべてのスーパークラスの追加] を選択します。CustomDisplay mixin が Test のスーパークラスとして表示され、TestSuiteExtension が TestSuite のスーパークラスとして表示されます。CustomDisplay の名前がイタリックで表記され、抽象クラスであることを示します。

CustomDisplay mixin and TestSuiteExtension visible

スーパークラスとサブクラスの追加には、それぞれ 2 つのオプションがあります。

スーパークラスの追加: 指定したクラスの直接的な継承元となるスーパークラスを追加します。
すべてのスーパークラスの追加: 指定したクラスの直接的または間接的な継承元となるすべてのスーパークラスを追加します。上記の例では、Test は TestSuiteExpansion から間接的に継承します。
サブクラスの追加: 指定したクラスから直接的に継承する既知のサブクラスを追加します。
すべてのサブクラスの追加: 指定したクラスから直接的または間接的に継承するすべての既知のサブクラスを追加します。

メモ

MATLAB では、指定したクラスのすべての既存のサブクラスが特定されない可能性があります。その場合、[クラスブラウザー] を使用して手動でサブクラスを追加します。

クラス間の関係に加えて、それ自体のクラス定義も確認できます。カードのクラス名の横にある矢印をクリックして、Test クラスを展開します。クラスカードが展開され、クラスで定義されるプロパティとメソッドが表示されます。スーパークラスから継承されたプロパティとメソッドはサブクラスカードに表示されません。

プロパティ名とメソッド名の横にあるアイコンは、プロパティとメソッドのアクセスレベルを識別します。たとえば、ロックアイコンは ExternalFixtures がプライベートプロパティであることを示しています。

Test class card with properties visible

クラスカードでプロパティまたはメソッドを選択すると、[インスペクター] ペインにアクセス情報やその他の情報も表示されます。

1 つ以上のクラスのソースコードを表示するには、そのカードを選択してツールバーの [ソースに移動] をクリックします。ソースコードファイルが MATLAB エディターで開きます。

ダイアグラムを保存または共有するには、次の 2 つのオプションのいずれかを使用します。

[エクスポート] をクリックしてダイアグラムを静的イメージとして保存します。
[保存]、[名前を付けて保存] を選択し、クラスダイアグラムビューアーインスタンスで再度開いて編集できる MLDATX ファイルを作成します。

プログラムでの使用

すべて展開する

`matlab.diagram.ClassViewer`

matlab.diagram.ClassViewer は、クラスを読み込まずにクラスダイアグラムビューアーインスタンスを開きます。

`matlab.diagram.ClassViewer(Name,Value)`

matlab.diagram.ClassViewer(Name,Value) は指定されたクラスを [クラスブラウザー] ペインとキャンバスの両方に追加します。有効な名前と値の引数は次のとおりです。

string またはオブジェクト名として指定されるクラス名をもつ Classes
string として指定されるフォルダー名をもつ Folders
string として指定されるパッケージ名をもつ Packages

その他の名前と値の引数については、matlab.diagram.ClassViewer を参照してください。引数を Name1=Value1,...,NameN=ValueN として指定します。ここで Name は引数名で、Value は対応する値です。

ヒント

クラスダイアグラムビューアーは、matlab.diagram.ClassViewer クラスのインスタンスです。一度に複数のビューアーを開くには、クラスコンストラクターを使用します。
が 2 つのクラス間の矢印上に表示される場合、追加のクラスはクラスカード自体ではなく、接続されている 2 つのクラス間の階層上にあります。をクリックし、階層のその部分に表示可能なすべてのクラスを追加します。
クラスダイアグラムビューアーの使用中にクラスコードに変更を加えた場合、[リフレッシュ] をクリックしてダイアグラムを自動的に更新できます。