FineKernelToolKit: FK_CLI::fk_GraphEdge クラス

FineKernelToolKit 4.3.0

読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | プロパティ | 全メンバ一覧
FK_CLI::fk_GraphEdge クラス

グラフ構造の辺を制御するクラス [詳解]

`#include <CLI/FK_CLI/include/GraphEdge_CLI.h>`

FK_CLI::fk_GraphEdge の継承関係図
[凡例]
FK_CLI::fk_GraphEdge 連携図
[凡例]

## 公開メンバ関数

fk_GraphNode ^ | GetNode (bool mode)
| ノード取得メソッド
void | SetIntCost (unsigned int ID, int cost)
| 整数型コスト設定メソッド
void | SetDoubleCost (unsigned int ID, double cost)
| 実数型コスト設定メソッド
int | GetIntCost (unsigned int ID)
| 整数型コスト参照メソッド
double | GetDoubleCost (unsigned int ID)
| 実数型コスト参照メソッド

## プロパティ

unsigned int | ID`[get]`
| ID 取得プロパティ
bool | DirectMode`[get]`
| 有無向取得プロパティ
bool | LengthMode`[get, set]`
| 辺長利用モードプロパティ
double | Length`[get]`
| 辺長参照プロパティ
fk_Color^ | Color`[set]`
| 色指定プロパティ

## 詳解

グラフ構造の辺を制御するクラス

このクラスは、グラフ構造における辺を制御する機能を提供します。

グラフ構造の詳細および利用方法についての詳細は、 fk_Graph のマニュアルを参照して下さい。 ここでは、グラフの辺に関する情報に特化して解説します。

本クラスのインスタンスは fk_Graph::MakeEdge() で自動的に生成されるものであり、 FK 利用者が直接インスタンスを生成することはありません。

参照
  fk_Graph, fk_GraphNode

## 関数詳解

## ◆ GetNode()

fk_GraphNode ^ FK_CLI::fk_GraphEdge::GetNode | ( | bool | mode | ) |

ノード取得メソッド

稜線の端点にあたるノードを取得します。

引数

  [in] | mode | true の場合始点を、false の場合終点を返します。

戻り値
  端点ノード

## ◆ SetIntCost()

void FK_CLI::fk_GraphEdge::SetIntCost | ( | unsigned int | ID,
|  | int | cost )

整数型コスト設定メソッド

辺の整数型コストを設定します。

引数

  [in] | ID | コスト ID
  [in] | cost | コスト値

参照
  GetIntCost(), SetDoubleCost()

## ◆ SetDoubleCost()

void FK_CLI::fk_GraphEdge::SetDoubleCost | ( | unsigned int | ID,
|  | double | cost )

実数型コスト設定メソッド

辺の実数型コストを設定します。

引数

  [in] | ID | コスト ID
  [in] | cost | コスト値

参照
  GetDoubleCost(), SetDoubleCost(), SetIntCost()

## ◆ GetIntCost()

int FK_CLI::fk_GraphEdge::GetIntCost | ( | unsigned int | ID | ) |

整数型コスト参照メソッド

辺の整数型コストを参照します。

引数

  [in] | ID | コスト ID

戻り値
  辺コスト

参照
  GetIntCost(), SetIntCost(), GetDoubleCost()

## ◆ GetDoubleCost()

double FK_CLI::fk_GraphEdge::GetDoubleCost | ( | unsigned int | ID | ) |

実数型コスト参照メソッド

辺の実数型コストを参照します。

引数

  [in] | ID | コスト ID

戻り値
  辺コスト

参照
  GetDoubleCost(), SetDoubleCost(), GetIntCost()

## プロパティ詳解

## ◆ ID

unsigned int FK_CLI::fk_GraphEdge::ID

get

ID 取得プロパティ

稜線の ID を取得します。

## ◆ DirectMode

bool FK_CLI::fk_GraphEdge::DirectMode

get

有無向取得プロパティ

辺の有向・無向情報を取得します。 無向の場合 true を、有向の場合 false となります。

## ◆ LengthMode

bool FK_CLI::fk_GraphEdge::LengthMode

getset

辺長利用モードプロパティ

辺長利用モードを設定・参照します。 辺長利用モードを有効とした場合、辺長が辺のコストとして設定されます。 この場合、コストの型は double 型として扱われます。 両端のいずれかのノードが移動するなどして辺の長さが変更となった場合、 辺のコストは自動的に更新されます。

true の場合辺長利用モードを有効とします。 false の場合無効とします。

参照
  Length

## ◆ Length

double FK_CLI::fk_GraphEdge::Length

get

辺長参照プロパティ

現在の辺長を参照します。 なお、本関数は「辺長利用モード」の状態が有効、無効のいずれであっても利用可能です。

参照
  LengthMode

## ◆ Color

fk_Color^ FK_CLI::fk_GraphEdge::Color

set

色指定プロパティ

辺の色を指定します。