UML から C# への変換の構成

変換で予想どおりの出力を生成するために使用する情報を指定するには、構成のガイドをする新規変換構成ウィザード変換構成エディターを使用します。
このタスクについて

変換構成は、ファイル名拡張子 .tc を持ち、変換が予想通りの出力を生成するために使用する情報が含まれます。また、変換構成には、 特定のタイプの変換に固有の情報も含まれています。既存の変換構成を編集するには、ワークスペース・リソースを示すビューで変換構成ファイルをダブルクリックし、変換構成エディターを開きます。

変換構成ファイルに関する作業を簡略化するには、変換する要素を含むプロジェクトに構成ファイルを保管します。

UML から C# への変換を構成するには、以下のようにします。

  1. 「ファイル」 > 「新規」 > 「その他」 > 「変換」 > 「変換構成」の順にクリックします。
  2. 構成の詳細を指定します。新規変換構成ウィザードの「構成名および変換の指定」ページで、以下のステップを完了します。
    1. 名前フィールドに、構成の名前を指定します。
    2. 構成ファイル宛先フィールドで、変換構成ファイルの宛先を指定します。宛先は、現行ワークスペース内の相対パスです。完全修飾プロジェクト名またはフォルダー名を指定できます。プロジェクト内のフォルダーを指定する場合は、フォルダー名の前に接頭部としてスラッシュ (/) を付ける必要があります。
    3. 変換リストから変換を選択します。
      注: インストールされていても使用可能になっていない変換を表示するには、すべての変換の表示をクリックします。 変換は、このリストに表示するには、機能にバインドする必要があります。
  3. プロトコル」セクションでモデリング・プロトコルを指定します。これは、設計規約管理プロトコル (DCMP) とも呼ばれています。選択する値によって、変換のソースとターゲットを同期するかどうかが決定されます。
    • ソース・モデルが基本技術成果物の場合は、概念を選択します。 ソース・モデルへの変更はすべてターゲット・モデルに波及します。
    • ソース成果物が表すアーキテクチャーがターゲットとは独立して発展する場合は、「調整」を選択します。このオプションを選択すると、ソースとターゲットの比較や変更の調整に利用できる 後方変換を使用できるようになります。また、他のチームによって該当のアーキテクチャーが 実装、開発、または保守される場合にも、このオプションを選択することができます。
      注: このオプションを選択すると、「メイン」ページの「後方変換」セクションで、追加のプロパティーが使用可能になります。 一部の変換では、変換構成エディターで追加のページが使用可能になります。 後方変換の構成について詳しくは、下の関連リンクを参照してください。
  4. 「次へ」をクリックします。
  5. 変換のソース要素とターゲット要素を指定します。有効なソース要素とターゲット要素のリストについては、この変換に関する関連概念のトピックを参照してください。 「ソースとターゲット」ページで、以下のステップを実行します。
    1. 選択済みソース」ペインで、変換対象の変換用にソース要素を選択します。
    2. 選択済みターゲット」ペインで、変換出力の宛先を選択します。出力の新規の宛先を作成するには、ターゲット・コンテナーの作成をクリックします。
  6. 「終了」をクリックします。 変換構成エディターが開くと、構成の内容が表示されます。
  7. オプション: 変換構成に関する文書を指定します。このフィールドは、複数のユーザーが共有する構成に関する情報を伝達する場合に便利です。「メイン」ページの「文書」フィールドに、変換構成についての追加情報を指定します。
  8. オプション: 変換がターゲット・モデル要素およびファイルを生成する方法を指定するには、「プロパティー」タブをクリックします。
    • C# フィールドごとに getter および setter メソッドを持つ private フィールドを生成するには、「Getter および Setter の生成」を選択します。プロパティーの isLeaf (final) または isReadOnly 値が true に設定されている場合、setter は生成されません。プロパティーの isDerived 値が true に設定されている場合、setter 実装は空です。
    • 生成されたファイルを削除するかどうかを指定するには、「廃止された生成済みファイルの削除」セクションのオプションを選択します。UML から C# への変換によりクラス、メソッド、および属性が生成される場合、 これらの要素に @generated タグが割り当てられます。次回に変換を実行したときに、 変換によりこれらの要素が上書きされます。ソース・モデルから要素を削除し、UML から C# への変換を再適用する場合、 この変換は、@generated タグを持ち、かつ対応するソースのモデル要素を持っていない、 以前に生成されたフィールドおよびメソッドを削除します。ただし、 変換により生成されるファイルの場合、ファイルを削除する前にプロンプトを出すか、常にファイルを削除するか、またはファイルを削除しないかを指定できます。
  9. オプション: ソースのプロジェクトのそれぞれの UML コレクション・タイプごとに、 変換により生成される C# コレクション・タイプを指定するには、「コレクション」タブをクリックします。 コレクションは、モデル要素のグループを表します。選択する C# コレクション・タイプにより、コレクション内に重複モデル要素が存在可能か、またはモデル要素が順序を持つかどうかが決定されます。UML コレクション・タイプは、 モデル要素の isOrdered および isUnique プロパティーにより決定されます。
  10. オプション: 構成する変換がマッピングをサポートする場合は、マッピング・モデルを作成することで、変換で生成される成果物の代替名を指定できます。新規または既存のマッピング・モデルを使用するには、以下のステップを実行します。
    1. 変換構成エディターの 「マッピング」ページで、「この構成でマッピング機能を使用可能にする」チェック・ボックスを選択します。
    2. マッピング・モデルのファイル名」フィールドで、新規または既存のマッピング・モデルの名前を指定します。
  11. オプション: デバッグ情報を生成するには、「メイン」ページでデバッグ・ログの生成チェック・ボックスを選択します。 次回変換を実行したときに、ログ・ファイルが XML ファイルとして、変換の設定で指定したフォルダーに生成されます。 ログ・ファイルの場所を指定していない場合は、変換によりワークスペースの .metadata フォルダーにログ・ファイルが生成されます。
    ヒント: 変換の設定を行うには、「ウィンドウ」 > 「設定」とクリックし、「モデリング」を展開して、「変換」をクリックします。

    ログ・ファイルは、ソース要素、ターゲット要素、および変換によってソース要素が変換されるときに適用される規則に関する情報を提供します。変換が多数の要素を変換する場合、変換がログ・ファイルを生成している間はパフォーマンスが低下することがあります。そのため、ログ・ファイルを生成するのは、デバッグ目的の場合のみにしてください。

  12. オプション: 変換の実行中に新規ダイアログ・ボックスが開かないようにするには、「メイン」ページでサイレント・モードで前方変換を実行チェック・ボックスを選択します。

    サイレント・モードで変換を実行すると、変換によって生成されるすべてのダイアログ・ボックスが抑制されます。 変換ではデフォルトの規則と振る舞いが適用され、予期しない変換出力や不正確な変換出力が生成されることがあります。サイレント・モードでの変換の実行は、変換出力の検証ではなく、変換の実行を検証する場合のみ実行してください。例えば、自動化されたタスクや自動化されたテスト・スイートの一部として、変換をサイレント・モードで実行することがあります。

    変換がサイレント・モードで実行されるよう設定すると、指定したファイル上書きオプションがオーバーライドされ、必要に応じてファイルが上書きされます。

    後方変換を使用できるように、前方変換で「調整」の設計規約管理プロトコル・オプションを選択した場合、「サイレント・モードで後方変換を実行」を選択できます。後方変換をサイレント・モードで実行するよう指定すると、マージ・エディターが抑制されます。マージ中に競合が発生すると、変換が停止します。その場合には、サイレント・オプションをクリアして変換を再実行する必要があります。

  13. オプション: 変換のソースとターゲット間の追跡可能な関係を作成するには、「メイン」ページでトレース関係を作成チェック・ボックスを選択します。このチェック・ボックスは、混合モデリングまたは 調整されたモデリングのプロトコルを選択する場合のみ使用できます。

    トレース関係とビジュアル開発ツールを使用して、ソース・モデル要素と変換出力の関係を理解することができます。 この機能は、複数のモデルおよび変換構成を持つような大規模なプロジェクトの場合に便利です。 ソース・モデルは変換によって変更されません。

  14. オプション: 変換の実行時に発生したエラーを表示するには、「メイン」ページで変換の完了時に「レポート」ダイアログ・ボックスを開くチェック・ボックスを選択します。このチェック・ボックスを選択すると、生成されたエラーのみが表示されます。同じ情報はエラー・ログにも書き込まれます。このエラー・ログは「ウィンドウ」 > 「ビューの表示」 > 「エラー・ログ (Error Log)」の順にクリックすることで表示できます。

    変換の実行時に発生した警告を表示するには、「レポート」ダイアログ・ボックスに警告を表示チェック・ボックスを選択します。

  15. 「ファイル」 > 「保存」をクリックします。
タスクの結果
オプションは次回変換を実行したときに適用されます。

フィードバック