Project

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > Projectオブジェクト >

Project

ProjectオブジェクトはRepositoryオブジェクトのGetProjectInterface()を利用してアクセスすることができます。Projectオブジェクトが持つ、過去との互換性のために残されているメソッドでは、GUIDはXML形式でなければなりません。GUIDtoXMLのメソッドで、Enterprise ArchitectのGUIDからXML形式に変換できます。

 

属性

属性

型

R/W

説明

ObjectType

ObjectType

R

このオブジェクトの種類を区別するために利用することができます。

 

 

操作

操作

戻り値の型

説明

BuildExecutableStatemachine

(string ElementGUID,

string ExtraOptions)

bool

外部実行の状態マシン要素に対して、ソースコードをビルドします。

(ビルド1400以降で利用可能)

 

引数:

  • ElementGUID: string - 対象の外部実行の状態マシン要素のGUIDです。
  • ExtraOptions: string - 現在は未使用です。

CancelValidation()

なし

実行中の評価機能の動作をキャンセルします。

CanValidate()

bool

評価機能が利用可能な状態かどうかを返します。

CreateBaseline

(string PackageGUID,

string Version,

string Notes)

 

bool

新規にベースラインを作成します。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • Version: string - ベースラインのバージョンです。
  • Notes: string - ベースライン作成時のコメントです。

CreateBaselineEx

(string PackageGUID,

string Version,

string Notes,

EA.CreateBaselineFlag Flags)

 

bool

条件を指定して新規に ベースラインを作成 します。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • Version: string - ベースラインのバージョンです。
  • Notes: string - ベースライン作成時のコメントです。
  • Flags: EA.CreateBaselineFlag - 子パッケージを対象にするかどうかを指定します。

DefineRule

(string CategoryID,

EA.EnumMVErrorType ErrorType,

string ErrorMessage)

string

評価ルールを定義します。詳細は「モデルの評価についてのイベント」をご覧ください。

DefineRuleCategory

(string CategoryName)

 

string

 

評価ルールの項目を追加します。詳細は「モデルの評価についてのイベント」をご覧ください。

DeleteBaseline

(string BaselineGUID)

bool

指定したベースラインを削除します。対象をベースラインのGUIDで指定します。ベースラインのGUIDはGetBaselinesで取得できる結果のXMLに含まれています。

なお、対象のベースラインがProクラウドサーバのリポジトリに保存されている場合には、APIから削除はできません。常にfalseが返ります。

 

引数:

  • BaselineGUID: string - 比較するベースラインのIDです。

DoBaselineCompare

(string PackageGUID,

string Baseline,

string ConnectString)

 

string

ベースラインの比較機能を実行します。対象をパッケージのGUIDとベースラインのGUIDで指定します。

ベースラインのGUIDはGetBaselinesで取得できる結果のXMLに含まれています。オプションとして、対象のベースラインが含まれるプロジェクトを指定することができます。

このメソッドの結果は、比較結果をログ形式でまとめた文字列になります。この結果をDoBaselineMergeメソッドに渡すことで、マージ処理が可能になります。

 

引数:

  • PackageGUID: string - 比較するパッケージのGUIDです。
  • Baseline: string - 比較するベースラインのIDです。
  • ConnectString: string - 現在は利用できません。

DoBaselineMerge

(string PackageGUID,

string Baseline,

string MergeInstructions,

string ConnectString)

string

 

引数に指定するXMLファイルに指定されている方法で、マージ処理を実行します。ベースラインが含まれる他のプロジェクトを指定することもできます。

 

MergeInstructionsに含まれる個々のMergeItemノードにはGUIDが設定されています。マージ処理は単方向であり、常に指定されたパッケージに対して反映されるため、追加の引数は必要ありません。

 

<Merge>

     <MergeItem guid="{XXXXXX}"/>

     <MergeItem guid="{XXXXXX}"/>

</Merge>

 

また、単一のMergeitemのみを含み、GUIDがRestoreAllの項目を引数に指定することもできます。この場合には、全ての差分を自動的にマージします。

 

<Merge>

 <MergeItem guid="RestoreAll"

　　　　　　changed="true"

　　　　　　baselineOnly="true"

　　　　　　modelOnly="true" moved="true"

　　　　　　fullrestore="false"/>

</Merge>

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • Baseline: string - マージ対象となるベースラインのGUIDです。
  • MergeInstructions: string - DoBaselineCompare()メソッドで取得できる、マージの処理内容を示した文字列です。
  • ConnectString: string - 現在は利用できません。

DoPackageCompareAndMerge

(string PackageGUID,

string XMIFile,

string XMIComparisonFile)

string

マージファイルを指定して、パッケージの比較を実行します。

このメソッドの結果は、比較結果をログ形式でまとめた文字列になります。この結果をDoBaselineMergeメソッドに渡すことで、マージ処理が可能になります。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • XMIファイル: string - マージ対象となるXMIファイルです。
  • XMIComparisonFile: string - マージファイルです。

ExportPackageXMI

(string PackageGUID,

enumXMIType XMIType,

int DiagramXML,

int DiagramImage,

int FormatXML,

int UseDTD,

string Filename)

 

string

 

指定したパッケージをXMI形式で出力します。

出力が正常に完了した場合には、空文字列が返ります。失敗した場合には、エラー内容が文字列として返ります。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • XMIType: EnumXMIType - XMIの種類です。 設定可能な値はXMIType定数値をご覧ください。
  • DiagramXML: int - 以下の値を指定します。

0 = ダイアグラムの情報を出力しません

1 = ダイアグラムの情報を出力します

2 = ダイアグラムの情報を出力します。要素の外見として別の画像が指定されている場合、その情報も出力します。

 

  • DiagramImage: int - ダイアグラムの画像の形式を指定します。

-1=画像を出力しません。

0=EMF

1=BMP

2=GIF

3=PNG

4=JPG

 

  • FormatXML: int - XMLを整形して出力する場合には1を指定します。整形しない場合には0を指定します。
  • UseDTD: int - DTDを利用する場合には1を指定します。利用しない場合には0を指定します。
  • Filename: String - 出力するファイル名です。

ExportPackageXMIEx

(string PackageGUID,

enumXMIType XMIType,

int DiagramXML,

int DiagramImage,

int FormatXML,

int UseDTD,

string Filename,

ea.ExportPackageXMIFlag Flags)

string

 

指定したパッケージをXMI形式で出力します。子パッケージの出力の有無が指定可能です。

出力が正常に完了した場合には、空文字列が返ります。失敗した場合には、エラー内容が文字列として返ります。

 

引数:

  • Flags: ExportPackageXMIFlag - 子パッケージの情報を含むかどうかを指定します。形式がxmiEADefaultの場合のみ有効です。
  • これ以外の引数は、ExportPackageXMIの説明をご覧ください。

ExportProjectXML

(string DirectoryPath)

bool

プロジェクト全体の情報を、XMLファイルの形式で出力します。指定したディレクトリにファイルが存在する場合、そのファイルは削除されます。
(ビルド1520以降で利用可能)

 

引数:

  • DirectoryPath: String - XMLファイルを出力するディレクトリ。

ExportReferenceData

(string Filename,

string Tables)

bool

リファレンス情報を出力します。

(ビルド1400以降で利用可能)

 

引数:

  • Filename: String - 出力先となるファイルのフルパスです
  • Tables: String - 出力対象の項目名を指定します。複数の場合には、 ";" で区切ります。この内容が空の場合には、対象を指定するダイアログが表示されます。

GenerateBuildRunExecutableStateMachine

(string ElementGUID,

string ExtraOptions)

bool

外部実行のステートマシンのソースコードを生成し、設定に基づいてビルド・実行を行います。<<executable statemachine>>のステレオタイプを持つ、外部実行のステートマシン要素を対象の要素として指定する必要があります。

(ビルド1400以降で利用可能)

 

引数:

  • ElementGUID: String - 生成対象の要素のGUIDです。
  • ExtraOptions: String-  現在利用されていません。空文字列を指定してください。

GenerateClass

(string ElementGUID,

string ExtraOptions)

 

bool

指定したクラスのソースコードを生成します。

 

引数:

  • ElementGUID:  String - 対象のクラスを指定します。
  • ExtraOptions: 現在は使われていません。

GenerateDiagramFromScenario

(string ElementGUID,

EnumScenarioDiagramType DiagramType,

int OverwriteExistingDiagram)

 

 

bool

シナリオからダイアグラムを生成します。

 

引数:

  • ElementGUID: string - 対象の要素のGUID
  • DiagramType: EnumScenarioDiagramType - 生成するダイアグラムの種類:ScenarioDiagramType列挙値をご覧ください。
  • OverwriteExistingDiagram: int - 既存のダイアグラムを上書きするかどうかを指定します。

0 = 既存のダイアグラムや要素を削除し、新規に生成する

1 = 既存のダイアグラムと同期し、ダイアグラムのレイアウトは維持する

2 = 既存のダイアグラムと同期し、ダイアグラムのレイアウトは初期化する

3 = ダイアグラムが存在する場合には、生成しない

GenerateElementDDL

(string ElementGUID,

string FileName,

string ExtraOptions)

 

bool

テーブル要素からDDLを生成します。

 

オプション指定の例:

owner=true;pkfkconstraints=true;

commentlevel=3;

 

引数:

  • ElementGUID: string ? 対象の要素のGUIDです。
  • FileName: string ? 出力するDDLファイルのパスとファイル名です。
  • ExtraOptions: string ? 生成する際のオプションを指定します。現在指定可能な項目は以下の通りです。
  • Owner生成の有無 (owner)
  • 主キー・外部キー制約の生成の有無 (pkfkconstraints)
  • コメント生成の有無
    (0 - なし, 1 - テーブル, 2 - 列, 3 - すべて)

GenerateExecutableStatemachine

(string ElementGUID,

string ExtraOptions)

bool

外部実行のステートマシンのソースコードを生成します。<<executable statemachine>>のステレオタイプを持つ、外部実行のステートマシン要素を対象の要素として指定する必要があります。

(ビルド1400以降で利用可能)

 

引数:

  • ElementGUID:  String - 生成対象の要素のGUIDです。
  • ExtraOptions: 現在は使われていません。空文字列を渡すようにしてください。

GeneratePackage

(string PackageGUID,

string ExtraOptions)

 

 

bool

指定されたパッケージ内の全てのクラスのソースコードを生成します。

 

例: "recurse=1;overwrite=1;dir=C:\"

 

引数:

  • PackageGUID: 対象のパッケージを指定します。
  • ExtraOptions: 追加のオプションを指定します。現在指定可能な項目は以下の通りです。
  • 配下のパッケージも対象にする (recurse)
  • 既存のファイルを上書きする (overwrite)
  • パスの指定 (dir)

注意:

dirが指定されている場合は、overwriteの設定に関わらず必ず上書きになります。dirを指定せずoverwrite=0に設定した場合は同期生成になります。

GeneratePackageDDL

(string PackageGUID,

string FileName,

string ExtraOptions)

 

bool

パッケージ内のテーブル要素からDDLを生成します。生成する際の対象や条件は、Enterprise Architectの画面から最後にDDL生成を実行した際の設定内容が利用されます。

GenerateTestFromScenario

(string ElementGUID,

EnumScenarioTestType TestType)

 

bool

 

要素のシナリオからテスト項目あるいはテスト項目要素を生成します。

 

引数:

  • ElementGUID: 対象の要素を指定します。
  • TestType: 生成する対象を指定します。詳細は「ScenarioTestType列挙値」をご覧ください。

GenerateWSDL

(string WSDLComponentGUID,

string Filename,

string Encoding,

string ExtraOptions)

bool

WSDLのステレオタイプが付加されたコンポーネント要素から、WSDLファイルを生成します。

 

引数:

  • WSDLComponentGUID: string - 対象のコンポーネントのGUIDを指定します。
  • Filename: string - 出力先のパスとファイル名を指定します。
  • Encoding: string - XMLファイルのエンコーディングを指定します。
  • ExtraOptions: string - 現在は利用されていません。

GenerateXSD

(string PackageGUID,

string Filename,

string Encoding,

string Options)

 

 

bool

 

XSDスキーマを生成します。成功するとTrueが返却されます。

 

引数:

  • PackageGUID パッケージを指定します。
  • Filename 出力先ファイルパスです。
  • Encoding XMLのエンコード方法を指定します。
  • Options 動作を設定します。カンマ区切りで指定します。
  • GenGlobalElement - グローバル要素の生成を、すべてglobal ComplexTypesにするかどうかを指定します。(1=する)

例: - GenGlobalElement=1

  • UseRelativePath - XSDのinclude文について、相対パスを利用するかどうかを指定します。(1=相対パス)
    外部のパッケージを指定する場合には、参照されるパッケージのschemaLocationタグの内容を空にしてください。
    (ビルド1350以降で利用可能)

GetAllDiagramImagesAndMap

(string Directory)

bool

指定したディレクトリに、モデル内の全てのダイアグラムの画像と画像マップのファイルを出力します。画像の形式はPNG形式で、ファイル名はダイアグラムのGUIDと同じ名前になります。画像マップはテキストファイルです。

プロジェクトのオプション「ダイアグラムの保存時に画像マップを自動的に生成」が有効になっている必要があります。また、画像マップが作成されていないダイアグラムは対象外です。

(ビルド1300以降で利用可能)

 

引数:

  • Directory: string - 画像および画像マップの出力先となるディレクトリを指定します。

 

(参考:クラウド)

GetBaselines

(string PackageGUID,

string ConnectString)

string

指定されたパッケージのベースラインの一覧をXML形式で取得します。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • ConnectString: string - 現在は利用されていません。

GetDiagramImageAndMap

(string DiagramGUID,

string Directory)

bool

指定したディレクトリに、指定したダイアグラムの画像と画像マップのファイルを出力します。画像の形式はPNG形式で、ファイル名はダイアグラムのGUIDと同じ名前になります。画像マップはテキストファイルです。

プロジェクトのオプション「ダイアグラムの保存時に画像マップを自動的に生成」が有効になっている必要があります。

(ビルド1300以降で利用可能)

 

引数:

  • DiagramGUID – 対象のダイアグラムのGUIDです。
  • Directory – 画像および画像マップの出力先となるディレクトリを指定します。

 

(参考:クラウド)

GetFileNameDialog

(string Filename,

string FilterString,

int FilterIndex,

int Flags,

string InitialDirectory,

int OpenOrSave)

string

Windows標準のファイルを開くダイアログあるいはファイル保存のダイアログを開きます。指定したファイル名のフルパスが戻ります。キャンセルされた場合には、空文字列になります。

このメソッドは、Enterprise Architectのスクリプト機能の中で利用することを想定したものです。

 

例:

Filename = ""

FilterString = "CSV Files

(*.csv)|*.csv|All Files (*.*)|*.*||"

Filterindex = 1

Flags = &H2 'OFN_OVERWRITEPROMPT

InitialDirectory = ""

OpenOrSave = 1

filepath = Project.GetFileNameDialog

(Filename, FilterString, Filterindex,

Flags,InitialDirectory, OpenOrSave)

 

この例では、CSVファイルを指定するためのダイアログを開きます。

 

引数:

  • Filename: string - ダイアログに表示する既定のファイル名です。
  • FilterString: string - 拡張子でフィルタする場合に指定します。指定方法は、Windows標準のダイアログで指定する場合と同じです。
  • Filterindex: int - 既定で適用するフィルタの番号を指定します。最初のフィルタを示す場合は「1」になります。
  • Flags: int - 動作を示すフラグを指定します。フラグの値の詳細はWindows APIのOPENFILENAMEをご覧下さい。
  • InitialDirectory: string - 初期状態のディレクトリを指定します。
  • OpenOrSave: int -  ファイルを開くのか、保存するのかを指定します。0 = 開く, 1 = 保存

GetLastError()

 

string

最後に発生したエラーの詳細情報です。エラーが発生したときには例外が発生しますので、この操作を利用することはほとんどありません。

ImportDirectory

(string PackageGUID,

string Language,

string DirectoryPath,

string ExtraOptions)

 

bool

指定したディレクトリのソースコードを読み込みます。

 

引数:

  • PackageGUID: string -  読み込むクラスを格納するパッケージを指定します。
  • Language: string -  対象の言語を指定します。
  • DirectoryPath: string -  読み込む対象のディレクトリを指定します。
  • ExtraOptions:  string - 追加のオプションを指定します。現在指定可能なのは、配下のディレクトリも対象にする (recurse) のみです。 例: "recurse=1;"

ImportFile

(string PackageGUID,

string Language,

string Filename,

string ExtraOptions)

 

 

bool

指定したソースファイルあるいはバイナリファイルを、指定したパッケージ内に読み込みます。

 

引数:

  • PackageGUID:  string - 読み込むクラスを格納するパッケージを指定します。名前空間の基準となるパッケージを指定します(読み込んだファイルに対応するクラスは、名前空間にあわせて生成位置が決まります)
  • Language:  string - 対象の言語を指定します。

 

言語として"DPNE"を指定すると、ファイルとして.NETのアセンブリかJavaのクラスファイルを指定できます。jarファイルは指定できません。

  • Filename:  string - 読み込む対象のファイルを指定します。
  • ExtraOptions:  string - 追加のオプションを指定します。現在は未使用です。

ImportPackageXMI

(string PackageGUID,

string Filename,

int ImportDiagrams,

int StripGUID)

 

 

string

指定したXMIファイルを、指定したパッケージに読み込みます。

処理が成功した場合は読み込んだパッケージのGUIDが、失敗した場合にはエラー内容(あるいは空文字列)が戻ります。

 

引数:

  • PackageGUID:  string - XMIを読み込むパッケージのGUIDです。
  • Filename or XMIText:  string - XMIファイルのファイル名またはXML形式の内容です。

注意:

与えられた文字列がファイル名であれば、ファイルとして読み込みます。 それ以外の場合にはXMLとして読み込みます。
  • ImportDiagrams:  int - ダイアグラムの情報を読み込むかどうかを指定します。1を指定した場合には読み込みます。0を指定した場合には読み込みません。
  • StripGUID:  int - 要素のIDを読みこみ時に削除するかどうかを指定します。1を指定した場合には削除します。0を指定した場合には削除しません。削除する場合にはパッケージはEAに複数回同じパッケージを読み込むことができます。

ImportPerspective

(string Filename)

bool

パースペクティブを定義したファイルを読み込み、追加します。

(ビルド1600以降で利用可能)

 

引数:

  • Filename: String - 読み込み元となるファイルのフルパスです

ImportReferenceData

(string Filename,

string DataSets)

bool

リファレンス情報を読み込みます。

(ビルド1400以降で利用可能)

 

引数:

  • Filename: String - 読み込み元となるファイルのフルパスです
  • DataSets: String - 読み込み対象の項目名を指定します。複数の場合には、 ";" で区切ります。空の場合には、対象を指定するダイアログを表示します。

ImportVisualStudioSolution

(string PackageGUID,

string SolutionPath)

bool

Visual Studioのソリューションを読み込みます。

(ビルド1600以降で利用可能)

 

引数:

  • PackageGUID: String - 読み込み先となるパッケージのGUIDです。
  • SolutionPath: string - 読み込み対象のVisualStudioのソリューションファイルのパスを指定します。

LayoutDiagram

(string DiagramGUID,

int LayoutStyle)

 

bool

 

表示されているダイアグラムの自動レイアウトを既定の設定で実行します。

クラス図やオブジェクト図での利用をおすすめします。

注意:

このメソッドは互換性のために残されています。「LayoutDiagramEx」をご利用ください。

 

引数:

  • DiagramGUID: string -  対象のダイアグラムのGUIDです。
  • LayoutStyle: int - このパラメータは利用されていません。

LayoutDiagramEx

(string DiagramGUID,

int LayoutStyle,

int Iterations,

int LayerSpacing,

int ColumnSpacing,

bool SaveToDiagram)

 

 

bool

表示されているダイアグラムの自動レイアウトを実行します。クラス図やオブジェクト図の場合に利用することをお勧めします。

LayoutStyleには、以下のオプションを指定できます。複数のオプションを指定する場合は、ビット演算のORで値を足して設定してください。

 

  • 既定値
  • lsDiagramDefault
  • lsProgramDefault
  • 循環解決の設定
  • lsCycleRemoveGreedy
  • lsCycleRemoveDFS
  • 階層化の設定
  • lsLayeringLongestPathSink
  • lsLayeringLongestPathSource
  • lsLayeringOptimalLinkLength
  • 初期設定
  • IsInitializeNaive
  • IsInitializeDFSOut
  • IsInitializeDFSIn
  • 交差減少の設定
  • lsCrossReduceAggressive
  • 向き
  • lsLayoutDirectionUp
  • lsLayoutDirectionDown
  • lsLayoutDirectionLeft
  • lsLayoutDirectionRight

 

引数:

  • DiagramGUID:  string -対象のダイアグラムのGUIDです。
  • LayoutStyle:  int - ConstLayoutStyles 定数値にある定数値を指定します
  • Iterations:  int - 交差減少の反復回数を指定します。既定値は4です。
  • LayerSpacing:  int - 要素間の層の間隔です。既定値は20です。
  • ColumnSpacing:  int - 要素間の列の間隔です。既定値は20です。
  • SaveToDiagram:  bool - 指定したレイアウトの設定情報を保存するかどうかを指定します。

Migrate

(string GUID,

string SourceType,

string DestinationType)

 

なし

 

BPMN・SysML・UPDM・Archimateのモデルを新しいバージョンの内容に変更します。

 

引数:

  • GUID: string - 対象の要素あるいはパッケージのGUIDです。
  • SourceType: String - 変換元の種類を指定します。指定可能な文字列は次の通りです。
  • BPMN
  • BPMN1.1
  • UPDM
  • SysML1.1
  • SysML1.2
  • SysML1.3
  • Archimate
  • Archimate2
  • UPDM2
  • DestinationType: String - 変換先の種類を指定します。指定可能な文字列は次の通りです。なお、実際に変換可能な値は、SourceTypeとして指定した文字列に依存します。
  • BPMN1.1
  • BPMN1.1::BPEL
  • BPMN2.0
  • UPDM2
  • SysML1.2
  • SysML1.3
  • SysML1.4
  • Archimate2
  • Archimate3
  • UAF

MigrateToBPMN11

(string GUID,

string Type)

 

 

なし

 

パッケージ内のBPMN 1.0の構成要素や単独の要素をBPMN1.1形式に移行します。

過去との互換性のために残していますので、Migrate関数を利用してください。

 

引数

  • GUID: string - 対象のパッケージや要素を指定します。
  • Type: string - 移行先の形式を指定します。:

BPMN = BPMN 1.1に移行します。

BPEL = BPMN1.1に移行し、さらに次の処理を行います。:

  • ダイアグラムのうち、ステレオタイプがBPMN のものを BPELに変更します。
  • 要素のうち、ステレオタイプがBusinessProcessのものをBPELProcessに変更します。

注意:

BPELへの移行はユニファイド版かアルティメット版でのみ利用可能です。

ProjectTransfer

(string SourceFilePath,

string TargetFilePath,

string LogFilePath)

 

bool

プロジェクトの内容をEAPX/FEAP/QEA/QEAXファイルに転送します。処理が成功した場合にはtrueを返します。

 

引数:

  • SourceFilePath: string - 転送元のプロジェクトの情報です。プロジェクトファイルへのフルパスか、DBMSリポジトリへの接続文字列を指定します。
  • TargetFilePath: string - 転送先のEAPX/FEAP/QEA/QEAXファイルのパスです。転送先となる、拡張子を含むフルパスで指定します。
  • LogFilePath: string - 転送のログの出力先です。

 

実行すると、転送先として指定された位置にEABaseファイルをコピーし、そのファイルに転送元のプロジェクトの内容を転送します。実行時には、転送先の位置にファイルが存在しないようにする必要があります。

PublishResult

(string CategoryID,

EA.EnumMVErrorType ErrorType,

string ErrorMessage)

 

 

bool

 

評価機能での評価結果をEnterprise Architectに伝えます。

追加に成功するとtrueが返ります。

 

引数:

  • CategoryID: string  - DefineRuleCategoryメソッドで戻る値を指定します。
  • ErrorType: EA.EnumMVErrorType - エラーの種類を指定します。以下のいずれかです。
  • mvErrorCritical
  • mvError
  • mvWarning
  • mvInformation
  • ErrorMessage: string - エラーの内容を指定します。

 

(参考:EA_OnInitializeUserRules、モデル評価の例)

PutDiagramImageOnClipboard

(string DiagramGUID,

int Type)

 

bool

 

指定したダイアグラムのイメージをクリップボードにコピーします。

 

引数:

  • DiagramGUID: string  - 対象のダイアグラムを指定します。
  • Type: int  - 以下のいずれかを指定します。
  • 0を指定するとメタファイルになります。
  • 1を指定するとビットマップになります。

PutDiagramImageToFile

(string Diagram GUID,

string FileName,

int Type)

 

 

bool

 

指定したダイアグラムのイメージをファイルに保存します。

 

引数:

  • DiagramGUID: string - 対象のダイアグラムを指定します。
  • Filename: string - 出力するファイル名を指定します。
  • Type: int - 以下のいずれかを指定します。
  • 0を指定するとメタファイルになります。
  • 1を指定するとメタファイル以外の画像形式になります。形式はファイルの拡張子(.bmp, .jpg, .gif, .png, .tga)で指定します。

RunExecutableStatemachine

(string ElementGUID,

string ExtraOptions)

bool

外部実行のステートマシンを実行します。<<executable statemachine>>のステレオタイプを持つ、外部実行のステートマシン要素を対象の要素として指定する必要があります。

(ビルド1400以降で利用可能)

 

引数:

  • ElementGUID:  String - 実行対象の要素のGUIDです。
  • ExtraOptions: 現在は使われていません。

RunModelSearch

(string Search,

string SearchTerm,

bool ShowInEA)

なし

検索機能を実行します。

 

引数:

  • Search: string - 検索ルールの名前を指定します。
  • SearchTerm: string - 検索単語を指定します。
  • ShowInEA: bool - 検索結果を、検索ビューとしてEnterprise Architect内部に表示するかどうかを指定します。

RunReport

(string PackageGUID,

string TemplateName,

string Filename)

 

なし

 

ドキュメントを出力します。出力内容を詳細に制御したい場合には、DocumentGeneratorオブジェクトを利用します。

 

 

引数:

  • PackageGUID: string - 対象のパッケージあるいはドキュメント定義パッケージを指定します。
  • TemplateName: string - 利用するテンプレートの名前を指定します。PackageGUIDが指すパッケージがドキュメント定義パッケージの場合には、テンプレートの指定は不要です。
  • Filename: string - 出力先となるファイルを指定します。ファイル名の拡張子がRTFの場合はRTFドキュメントを、PDFの場合はPDFドキュメントを、DOCXの場合にはDOCX形式のドキュメントを生成します。

 

(参考:ドキュメントの生成ダイアログ、ドキュメント出力定義要素)

RunHTMLReport

(string PackageGUID,

string ExportPath,

string ImageFormat,

string Style,

string Extension)

 

 

string

HTML形式のドキュメントを出力します。 (モデルブラウザ内のパッケージを選択し、「HTMLドキュメントの生成」メニューを実行した場合と同じです。「HTMLドキュメントの生成」メニューの利用手順については、「HTMLドキュメントの生成」 のページをご覧ください。)

 

引数:

  • PackageGUID: string - 対象のパッケージあるいはドキュメント定義パッケージ要素を指定します。
  • ExportPath: string - 出力位置を指定します。
  • ImageFormat: string - 画像の形式をGIFまたはPNGで指定します。
  • Style: string - HTMLテンプレートを利用する場合には、その名前を指定します。
  • Extension: string - HTMLファイルの拡張子を指定します。

 

(参考:ドキュメント定義パッケージとドキュメント出力定義要素)

SaveDiagramImageToFile

(string Filename)

 

 

string

現在表示されているダイアグラムのイメージを指定したファイルに保存します。

 

引数:

  • Filename: String - 保存するファイルのファイル名です。

ShowWindow

(int Show)

 

なし

EAのメインウィンドウを表示あるいは非表示にします。

 

引数:

  • Show: int - 1で表示・0で非表示です。

SynchronizeClass

(string ElementGUID,

string ExtraOptions)

 

bool

ソースコードを参照し、クラスを同期します。

 

引数:

  • ElementGUID: string - 対象のクラスを指定します。
  • ExtraOptions: string - 現在は使われていません。

SynchronizePackage

(string PackageGUID,

string ExtraOptions)

 

 

bool

指定したパッケージ内のクラスをすべて同期します。

 

引数:

  • PackageGUID: string - 対象のパッケージを指定します。
  • ExtraOptions: string - 追加のオプションを指定します。現在利用されていません。

TransformElement

(string TransformName,

string ElementGUID,

string TargetPackage,

string ExtraOptions)

 

 

bool

指定した要素を変換します。

 

引数:

  • TransformName: string - 変換ルールの名前を指定します。
  • ElementGUID: string - 対象の要素を指定します。
  • TargetPackageGUID: string - 変換結果を格納するパッケージを指定します。
  • ExtraOptions: string - 以下のオプションが利用できます。
  • GenCode=True/False - 変換後にソースコード生成を実行するかどうかを指定します。この設定は、モデル側での設定より優先して適用されます。

TransformPackage

(string TransformName,

string SourcePackage,

string TargetPackage,

string ExtraOptions)

 

bool

指定されたパッケージ内の全ての要素を変換します。

 

引数:

  • TransformName: string - 変換ルールの名前を指定します。
  • SourcePackageGUID: string - 対象のパッケージを指定します。
  • TargetPackageGUID: string - 変換結果を格納するパッケージを指定します。
  • ExtraOptions: string - 以下のオプションが利用できます。
  • GenCode=True/False - 変換後にソースコード生成を実行するかどうかを指定します。
  • SubPackages=true/false - 子パッケージの内容も変換対象として処理するかどうかを指定します。

ValidateDiagram

(string DiagramGUID)

 

bool

ダイアグラムを評価します。詳細は「モデルの評価についてのイベント」をご覧ください。

 

引数:

  • DiagramGUID: string - 対象のダイアグラムを指定します。

ValidateElement

(string ElementGUID)

 

 

bool

要素を評価します。詳細は「モデルの評価についてのイベント」をご覧ください。

 

引数:

  • ElementGUID: string - 対象の要素を指定します。

ValidatePackage

(string PackageGUID)

 

 

bool

パッケージを評価します。詳細は「モデルの評価についてのイベント」をご覧ください。

 

引数:

  • PackageGUID: string - 対象のパッケージを指定します。

 

 

過去との互換性のために残されている操作

以下の表に含まれる操作は、Enterprise Architectの初期のAPIとして提供されたもので、現在は利用する必要のない操作です。過去のバージョンとの互換性のために残されています。

以下の表に含まれる操作が提供する機能は、すべて他のオブジェクト(Repository, Package, Elementなど)で提供しています。

 

操作

戻り値の型

説明

EnumDiagramElements

(string DiagramGUID)

 

string

 

ダイアグラム内に配置されている要素の一覧をXML形式で取得します。

 

引数:

  • DiagramGUID: string - 対象のダイアグラムのGUIDです。XML形式で指定します。

EnumDiagrams

(string PackageGUID)

 

string

 

ダイアグラムの一覧をXML形式で取得します。

 

引数:

  • PackageGUID: string - XML形式で指定します。対象のパッケージのGUIDです。

EnumElements

(string PackageGUID)

 

string

指定したパッケージ内の要素の一覧をXML形式で取得します。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。XML形式で指定します。

EnumLinks

(string ElementGUID)

string

指定したパッケージ内の接続の一覧をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象のパッケージのGUIDです。XML形式で指定します。

EnumPackages

(string PackageGUID)

string

パッケージの一覧をXML形式で取得します。

 

引数:

  • PackageGUID: String - 対象のパッケージのGUIDです。XML形式で指定します。

EnumProjects()

string

モデルルートの一覧を取得します。

EnumViews()

string

最上位のパッケージの一覧をXML形式で取得します。

EnumViewEx

(string ProjectGUID)

string

指定したモデルルート直下のパッケージの一覧を取得します。

引数:

  • ProjectGUID: string - 対象のモデルルートのGUIDです。XML形式で指定します。

Exit()

 

string

現在のインスタンスを終了させます。

(利用されているオブジェクトがなくなれば、自動的にEnterprise Architectは終了しますので、この操作の実行は不要です。)

GetDiagram

(string DiagramGUID)

 

 

string

 

指定したダイアグラムの詳細をXML形式で取得します。

 

引数:

  • DiagramGUID: string - 対象のダイアグラムのGUIDです。XML形式で指定します。

GetElement

(string ElementGUID)

 

 

string

 

指定した要素の情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementConstraints

(string ElementGUID)

 

 

string

 

指定した要素の制約の情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 　対象の要素のGUIDです。XML形式で指定します。

GetElementEffort

(string ElementGUID)

 

 

string

 

指定した要素の作業の情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementFiles

(string ElementGUID)

 

 

string

 

指定した要素に関連付けられたファイルの一覧をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementMetrics

(string ElementGUID)

 

 

string

指定した要素の測定の情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementProblems

(string ElementGUID)

 

 

string

指定した要素の問題をXML形式で取得します。

 

引数:

  • ElementGUID: string -対象の要素のGUIDです。XML形式で指定します。

GetElementProperties

(string ElementGUID)

string

指定した要素のタグ付き値をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementRequirements

(string ElementGUID)

 

string

指定した要素の要求(内部要求)をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementResources

(string ElementGUID)

 

string

指定した要素に割り当てられたりソースの情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します

GetElementRisks

(string ElementGUID)

 

 

string

指定した要素のリスクをXML形式で取得します。

 

引数:

  • ElementGUID: string -対象の要素のGUIDです。XML形式で指定します。

GetElementScenarios

(string ElementGUID)

 

 

string

指定した要素のシナリオの情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetElementTests

(string ElementGUID)

 

string

指定した要素のテスト項目の情報をXML形式で取得します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。XML形式で指定します。

GetLink

(string LinkGUID)

 

 

string

指定した接続の詳細をXML形式で取得します。

 

引数:

  • LinkGUID: string - 対象の接続のGUIDです。XML形式で指定します。

GUIDtoXML

(string GUID)  

string

GUIDをXML形式に変換します。

 

引数:

  • GUID: string - EA形式のGUIDを指定します。

LoadControlledPackage

(string PackageGUID)

string

コントロールパッケージとして指定されているパッケージのXMIを読み込みます。XMIファイルのパスは、パッケージに結びついている情報を利用します。

 

引数:

  • PackageGUID: string -  対象のパッケージを指定します。

LoadDiagram

(string DiagramGUID)

 

 

bool

 

GUIDを指定してダイアグラムを読み込みます。

 

引数:

  • DiagramGUID: string -  このときのGUIDはXML形式でなければなりません。XML形式にするには、GUIDtoXMLやXMLtoGUIDなどのメソッドを利用してください。

LoadProject

(string Filename)

 

 

bool

 

指定したプロジェクトファイルを読み込みます。既にファイルを読み込んでいるRepositoryオブジェクトからこのインターフェースを利用する場合には、このメソッドは利用することはできません。

 

引数:

  • Filename: string - 対象のファイル名を指定します。

ReloadProject()

bool

現在利用しているプロジェクトを再読み込みします。

このメソッドは、Enterprise Architectの外部から(=APIを利用せずに)プロジェクトの内容を変更した場合に、その変更内容を反映するために利用します。

SaveControlledPackage

(string PackageGUID)

 

 

string

 

指定したパッケージをXMIファイルとして保存します。コントロールパッケージとして設定した内容に沿って処理を行います。

 

引数:

  • PackageGUID: String -保存するパッケージを指定します。パッケージはコントロールパッケージである必要があります。

XMLtoGUID

(string GUID)

 

string

XML形式で表現されたGUIDを通常の形式に変換します。

 

引数:

  • GUID: string - XML形式のGUIDを指定します。