FK::fk_GraphEdge クラス

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

#include <FK/GraphEdge.h>

FK::fk_GraphEdge の継承関係図

FK::fk_GraphEdge 連携図

公開メンバ関数
unsigned int	getID (void)
	ID 取得関数
fk_GraphNode *	getNode (bool mode)
	ノード取得関数
bool	getDirectMode (void)
	有無向取得関数
void	setLengthMode (bool mode)
	辺長利用モード設定関数
bool	getLengthMode (void)
	辺長利用モード参照関数
double	getLength (void)
	辺長参照関数
void	setIntCost (unsigned int ID, int cost)
	整数型コスト設定関数
void	setDoubleCost (unsigned int ID, double cost)
	実数型コスト設定関数
int	getIntCost (unsigned int ID)
	整数型コスト参照関数
double	getDoubleCost (unsigned int ID)
	実数型コスト参照関数
void	setColor (fk_Color col)
	色指定関数1
void	setColor (fk_Color *col)
	色指定関数2
基底クラス FK::fk_BaseObject に属する継承公開メンバ関数
	fk_BaseObject (fk_Type type=fk_Type::BASEOBJECT)
	コンストラクタ
fk_Type	getObjectType (void) const
	タイプ取得関数

詳解

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

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

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

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

参照

fk_Graph, fk_GraphNode

関数詳解

getID()

unsigned int FK::fk_GraphEdge::getID

(

void

)

ID 取得関数

辺の ID を取得します。

戻り値

ID

getNode()

fk_GraphNode * FK::fk_GraphEdge::getNode

(

bool

mode

)

ノード取得関数

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

引数

[in]

mode

true の場合始点を、false の場合終点を返します。

戻り値

端点ノード

getDirectMode()

bool FK::fk_GraphEdge::getDirectMode

(

void

)

有無向取得関数

辺が有向か無向かを取得します。

戻り値

無向の場合 true を、有向の場合 false を返します。

setLengthMode()

void FK::fk_GraphEdge::setLengthMode

(

bool

mode

)

辺長利用モード設定関数

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

引数

[in]

mode

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

参照

getLengthMode(void), getLength(void)

getLengthMode()

bool FK::fk_GraphEdge::getLengthMode

(

void

)

辺長利用モード参照関数

現在の辺長利用モードを参照します。

戻り値

辺長利用モードが有効な場合 true を、無効な場合 false を返します。

参照

setLengthMode(void), getLength(void)

getLength()

double FK::fk_GraphEdge::getLength

(

void

)

辺長参照関数

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

戻り値

辺長値

参照

setLengthMode(void), getLengthMode(void)

setIntCost()

void FK::fk_GraphEdge::setIntCost	(	unsigned int	ID,
		int	cost
	)

整数型コスト設定関数

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

引数

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

参照

getIntCost(), setDoubleCost()

setDoubleCost()

void FK::fk_GraphEdge::setDoubleCost	(	unsigned int	ID,
		double	cost
	)

実数型コスト設定関数

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

引数

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

参照

getDoubleCost(), setDoubleCost(), setIntCost()

getIntCost()

int FK::fk_GraphEdge::getIntCost

(

unsigned int

ID

)

整数型コスト参照関数

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

引数

[in]

ID

コスト ID

戻り値

辺コスト

参照

getIntCost(), setIntCost(), getDoubleCost()

getDoubleCost()

double FK::fk_GraphEdge::getDoubleCost

(

unsigned int

ID

)

実数型コスト参照関数

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

引数

[in]

ID

コスト ID

戻り値

辺コスト

参照

getDoubleCost(), setDoubleCost(), getIntCost()

setColor() [1/2]

void FK::fk_GraphEdge::setColor

(

fk_Color

col

)

色指定関数1

辺の色を指定します。

引数

[in]

col

色値

setColor() [2/2]

void FK::fk_GraphEdge::setColor

(

fk_Color *

col

)

色指定関数2

辺の色を指定します。

引数

[in]

col

色値