vigir_footstep_planning::HeuristicPlugin Class Reference

#include <heuristic_plugin.h>

List of all members.

Public Types
typedef boost::shared_ptr < const HeuristicPlugin >	ConstPtr
typedef boost::shared_ptr < HeuristicPlugin >	Ptr
Public Member Functions
virtual double	getHeuristicValue (const State &from, const State &to, const State &start, const State &goal) const =0
	HeuristicPlugin (const std::string &name)
bool	isUnique () const final
bool	loadParams (const vigir_generic_params::ParameterSet &params=vigir_generic_params::ParameterSet()) override
virtual void	reset ()
	Resets the plugin to initial state.
virtual	~HeuristicPlugin ()
Protected Attributes
double	max_heuristic_value_

---

Detailed Description

Definition at line 42 of file heuristic_plugin.h.

---

Member Typedef Documentation

typedef boost::shared_ptr<const HeuristicPlugin> vigir_footstep_planning::HeuristicPlugin::ConstPtr

Definition at line 48 of file heuristic_plugin.h.

typedef boost::shared_ptr<HeuristicPlugin> vigir_footstep_planning::HeuristicPlugin::Ptr

Definition at line 47 of file heuristic_plugin.h.

---

Constructor & Destructor Documentation

vigir_footstep_planning::HeuristicPlugin::HeuristicPlugin

(

const std::string &

name

)

Definition at line 7 of file heuristic_plugin.cpp.

vigir_footstep_planning::HeuristicPlugin::~HeuristicPlugin

(

)

[virtual]

Definition at line 12 of file heuristic_plugin.cpp.

---

Member Function Documentation

virtual double vigir_footstep_planning::HeuristicPlugin::getHeuristicValue	(	const State &	from,
		const State &	to,
		const State &	start,
		const State &	goal
	)		const [pure virtual]

bool vigir_footstep_planning::HeuristicPlugin::isUnique

(

)

const

Definition at line 16 of file heuristic_plugin.cpp.

bool vigir_footstep_planning::HeuristicPlugin::loadParams

(

const vigir_generic_params::ParameterSet &

params = vigir_generic_params::ParameterSet()

)

[override]

Definition at line 21 of file heuristic_plugin.cpp.

virtual void vigir_footstep_planning::HeuristicPlugin::reset

(

)

[inline, virtual]

Resets the plugin to initial state.

Definition at line 56 of file heuristic_plugin.h.

---

Member Data Documentation

double vigir_footstep_planning::HeuristicPlugin::max_heuristic_value_ [protected]

Definition at line 65 of file heuristic_plugin.h.

---

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

• heuristic_plugin.h
• heuristic_plugin.cpp