基本クラス ibm_ilog.graphlayout.GraphLayoutReport は、以下の情報を格納します:
コード
このフィールドには、レイアウト中に発生した特別な定義済みのケースに関する情報が含まれます。
可能な値は以下のとおりです。
ibm_ilog.graphlayout.GraphLayoutReport.LAYOUT_DONE
- レイアウトが正常に実行された場合に表示されます。ibm_ilog.graphlayout.GraphLayoutReport.STOPPED_AND_VALID
- レイアウトが実行されたが、レイアウト時間が超過したか、あるいは、メソッドstopImmediately
が呼び出されたために、完了せずに停止した場合に表示されます。レイアウト・アルゴリズムは反復メカニズムを使用するため、停止時点のノードとリンクの位置は、有効です。ibm_ilog.graphlayout.GraphLayoutReport.STOPPED_AND_INVALID
- (非反復) レイアウトが実行されたが、レイアウト時間が超過したか、あるいは、メソッドstopImmediately
が呼び出されたために、完了せずに停止した場合に表示されます。 停止時点のノードとリンクの位置は、無効です。多くの場合、まだ全く変更されていません。ibm_ilog.graphlayout.GraphLayoutReport.NOT_NEEDED
- 前回レイアウトが正常に実行されて以降、グラフとパラメーターに変更が生じなかったため、レイアウトが実行されなかった場合に表示されます。ibm_ilog.graphlayout.GraphLayoutReport.EMPTY_GRAPHER
- グラフが空の場合に表示されます。
コードを読み込むには、メソッド getCode を使用します。
var report = graphLayout.getLayoutReport(); var reportCode = report.getCode();
レイアウト時間
このフィールドには、レイアウトの終了時点のレイアウト・アルゴリズムの合計所要時間が含まれます。
この時間 (ミリ秒単位)
を読み込むには、次のようにします。
var time = report.getLayoutTime();
完了のパーセンテージ
このフィールドには、完了しているレイアウトのパーセンテージの見積もりが含まれます。
これは、レイアウト・アルゴリズムが完了パーセンテージの汎用計算機能をサポートしている場合に使用されます。計算完了パーセンテージ を参照してください。これは、通常、以下のセクションで説明するレイアウト・イベント・リスナーの内部で使用されます。
パーセンテージにアクセスするには、メソッド getPercentageComplete を使用します。
var percentage = report.getPercentageComplete();
追加情報
特定のレイアウト・アルゴリズムに関する追加情報は、
ibm_ilog.graphlayout.GraphLayoutReport
のサブクラスによって格納されます。
詳細については、これらのクラスの解説書を参照してください。