経路計画アルゴリズム基底クラス More...

#include <Algorithm.h>

Inheritance diagram for PathEngine::Algorithm:

Public Member Functions
	Algorithm (PathPlanner *planner)
	コンストラクタ More...

virtual bool	calcPath ()=0
	経路計画を実行する More...

const std::vector< Configuration > &	getPath ()
	結果を取得する More...

void	getProperties (std::vector< std::string > &names, std::vector< std::string > &values)
	プロパティ一覧を取得する More...

RoadmapPtr	getRoadmap ()
	ロードマップを取得する More...

void	ignoreCollisionAtGoal (bool b)
	ゴールでの干渉を許容する場合はtrue、それ以外の場合はfalseを設定する。初期状態では許容しない。 More...

void	ignoreCollisionAtStart (bool b)
	スタートでの干渉を許容する場合はtrue、それ以外の場合はfalseを設定する。初期状態では許容しない。 More...

bool	preparePlanning ()
	経路計画の準備をし、初期位置と目標位置が有効なものであることをチェックする More...

void	setGoalConfiguration (const Configuration &pos)
	終了位置を設定する More...

void	setProperties (const std::map< std::string, std::string > &properties)
	アルゴリズムに対して各種情報を設定する More...

void	setProperty (const std::string &key, const std::string &value)

void	setStartConfiguration (const Configuration &pos)
	初期位置を設定する More...

void	stopPlanning ()
	計算を止める More...

bool	tryDirectConnection ()
	初期位置と終了位置を直接結べないか検査する More...

void	verbose (bool b)
	デバッグ出力の制御 More...

virtual	~Algorithm ()
	デストラクタ More...

Protected Attributes
Configuration	goal_
	終了位置 More...

bool	ignoreCollisionAtGoal_

bool	ignoreCollisionAtStart_

bool	isRunning_
	計算中フラグ More...

std::vector< Configuration >	path_
	計画された経路 More...

PathPlanner *	planner_
	計画経路エンジン More...

std::map< std::string, std::string >	properties_
	プロパティ More...

RoadmapPtr	roadmap_
	ロードマップ More...

Configuration	start_
	開始位置 More...

bool	verbose_
	デバッグ出力の制御 More...

Detailed Description

経路計画アルゴリズム基底クラス

経路計画アルゴリズムを実装する際の基底クラス。新たな経路計画アルゴリズムを実装する場合、このクラスを継承して以下のメソッドを実装する。

calcPath()

Definition at line 23 of file Algorithm.h.

Constructor & Destructor Documentation

◆ Algorithm()

Algorithm::Algorithm ( PathPlanner * planner )

コンストラクタ

Parameters

planner PathPlannerへのポインタ

Definition at line 9 of file Algorithm.cpp.

◆ ~Algorithm()

Algorithm::~Algorithm ( )

virtual

デストラクタ

Definition at line 18 of file Algorithm.cpp.

Member Function Documentation

◆ calcPath()

virtual bool PathEngine::Algorithm::calcPath ( )

pure virtual

経路計画を実行する

以下の条件を満たすように実装する。

start_からgoal_に到達する経路を計画する
計算途中でisRunning_フラグがfalseになった場合は計算を中断する
経路を発見した場合はそれをpath_にセットし、計算を終了する

Implemented in PathEngine::RRT, and PathEngine::PRM.

◆ getPath()

const std::vector<Configuration>& PathEngine::Algorithm::getPath ( )

inline

結果を取得する

Returns: 結果の姿勢列

Definition at line 153 of file Algorithm.h.

◆ getProperties()

void Algorithm::getProperties	(	std::vector< std::string > &	names,
		std::vector< std::string > &	values
	)

プロパティ一覧を取得する

Parameters

names	プロパティ名のリスト
values	プロパティ値のリスト

Definition at line 37 of file Algorithm.cpp.

◆ getRoadmap()

RoadmapPtr PathEngine::Algorithm::getRoadmap ( )

inline

ロードマップを取得する

Returns: ロードマップ

Definition at line 159 of file Algorithm.h.

◆ ignoreCollisionAtGoal()

void PathEngine::Algorithm::ignoreCollisionAtGoal ( bool b )

inline

ゴールでの干渉を許容する場合はtrue、それ以外の場合はfalseを設定する。初期状態では許容しない。

Definition at line 176 of file Algorithm.h.

◆ ignoreCollisionAtStart()

void PathEngine::Algorithm::ignoreCollisionAtStart ( bool b )

inline

スタートでの干渉を許容する場合はtrue、それ以外の場合はfalseを設定する。初期状態では許容しない。

Definition at line 181 of file Algorithm.h.

◆ preparePlanning()

bool Algorithm::preparePlanning ( )

経路計画の準備をし、初期位置と目標位置が有効なものであることをチェックする

Returns: 初期位置もしくは目標位置が無効なものであった場合false、それ以外true

Definition at line 64 of file Algorithm.cpp.

◆ setGoalConfiguration()

void PathEngine::Algorithm::setGoalConfiguration ( const Configuration & pos )

inline

終了位置を設定する

Parameters

pos 終了位置

Definition at line 126 of file Algorithm.h.

◆ setProperties()

void Algorithm::setProperties ( const std::map< std::string, std::string > & properties )

アルゴリズムに対して各種情報を設定する

Parameters

properties name-valueの組

Definition at line 27 of file Algorithm.cpp.

◆ setProperty()

void Algorithm::setProperty	(	const std::string &	key,
		const std::string &	value
	)

Definition at line 22 of file Algorithm.cpp.

◆ setStartConfiguration()

void PathEngine::Algorithm::setStartConfiguration ( const Configuration & pos )

inline

初期位置を設定する

Parameters

pos 初期位置

Definition at line 120 of file Algorithm.h.

◆ stopPlanning()

void PathEngine::Algorithm::stopPlanning ( )

inline

計算を止める

Definition at line 147 of file Algorithm.h.

◆ tryDirectConnection()

bool Algorithm::tryDirectConnection ( )

初期位置と終了位置を直接結べないか検査する

Returns: 結べた場合はtrue, それ以外はfalse

Definition at line 51 of file Algorithm.cpp.

◆ verbose()

void PathEngine::Algorithm::verbose ( bool b )

inline

デバッグ出力の制御

Parameters

b	trueで出力が有効

Definition at line 171 of file Algorithm.h.

Member Data Documentation

◆ goal_

Configuration PathEngine::Algorithm::goal_

protected

終了位置

setGoalConfiguration()によってセットされる。

Definition at line 37 of file Algorithm.h.

◆ ignoreCollisionAtGoal_

bool PathEngine::Algorithm::ignoreCollisionAtGoal_

protected

ゴールでの干渉を許容するか否か

Definition at line 86 of file Algorithm.h.

◆ ignoreCollisionAtStart_

bool PathEngine::Algorithm::ignoreCollisionAtStart_

protected

スタートでの干渉を許容するか否か

Definition at line 81 of file Algorithm.h.

◆ isRunning_

bool PathEngine::Algorithm::isRunning_

protected

計算中フラグ

calcPath()はこのフラグがfalseとなった場合は計算を中断するように実装する

Definition at line 51 of file Algorithm.h.

◆ path_

std::vector<Configuration> PathEngine::Algorithm::path_

protected

計画された経路

姿勢を並べたベクトルで表される列。ここにセットしたものがgetPath()で読み出される。

Definition at line 58 of file Algorithm.h.

◆ planner_

PathPlanner* PathEngine::Algorithm::planner_

protected

計画経路エンジン

コンストラクタによってセットされる。干渉検出などのインターフェースを提供する。

Definition at line 66 of file Algorithm.h.

◆ properties_

std::map<std::string, std::string> PathEngine::Algorithm::properties_

protected

プロパティ

string-stringで名-値関係をなす。

Definition at line 44 of file Algorithm.h.

◆ roadmap_

RoadmapPtr PathEngine::Algorithm::roadmap_

protected

ロードマップ

Definition at line 71 of file Algorithm.h.

◆ start_

Configuration PathEngine::Algorithm::start_

protected

開始位置

setStartConfiguration()によってセットされる。

Definition at line 30 of file Algorithm.h.

◆ verbose_

bool PathEngine::Algorithm::verbose_

protected

デバッグ出力の制御

Definition at line 76 of file Algorithm.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Algorithm()

◆ ~Algorithm()

Member Function Documentation

◆ calcPath()

◆ getPath()

◆ getProperties()

◆ getRoadmap()

◆ ignoreCollisionAtGoal()

◆ ignoreCollisionAtStart()

◆ preparePlanning()

◆ setGoalConfiguration()

◆ setProperties()

◆ setProperty()

◆ setStartConfiguration()

◆ stopPlanning()

◆ tryDirectConnection()

◆ verbose()

Member Data Documentation

◆ goal_

◆ ignoreCollisionAtGoal_

◆ ignoreCollisionAtStart_

◆ isRunning_

◆ path_

◆ planner_

◆ properties_

◆ roadmap_

◆ start_

◆ verbose_