occupancy_grid_utils::TerminationCondition Struct Reference

Termination condition for shortest path search max_dist is a distance such that as soon as we see a cell with greater than this distance, we stop. Note that, confusingly, max_dist is in cells though shortest path returns meters by default. Currently, we warn if use_cells is set to true below. In future (H-turtle), this api will actually change to only allow meters. goals is a set such that once we've expanded all the cells in this set, we stop. More...

#include <shortest_path.h>

List of all members.

Public Member Functions
	TerminationCondition (const Cells &goals, const double max_distance, bool use_cells=true)
	TerminationCondition (const Cells &goals)
	TerminationCondition (double max_distance, bool use_cells=true)
	TerminationCondition ()
Public Attributes
boost::optional< std::set< Cell > >	goals_
boost::optional< double >	max_distance_
bool	use_cells_

---

Detailed Description

Termination condition for shortest path search max_dist is a distance such that as soon as we see a cell with greater than this distance, we stop. Note that, confusingly, max_dist is in cells though shortest path returns meters by default. Currently, we warn if use_cells is set to true below. In future (H-turtle), this api will actually change to only allow meters. goals is a set such that once we've expanded all the cells in this set, we stop.

Definition at line 86 of file shortest_path.h.

---

Constructor & Destructor Documentation

occupancy_grid_utils::TerminationCondition::TerminationCondition

(

)

Definition at line 54 of file shortest_path.cpp.

occupancy_grid_utils::TerminationCondition::TerminationCondition	(	double	max_distance,
		bool	use_cells = true
	)

Definition at line 57 of file shortest_path.cpp.

occupancy_grid_utils::TerminationCondition::TerminationCondition

(

const Cells &

goals

)

Definition at line 67 of file shortest_path.cpp.

occupancy_grid_utils::TerminationCondition::TerminationCondition	(	const Cells &	goals,
		const double	max_distance,
		bool	use_cells = true
	)

Definition at line 72 of file shortest_path.cpp.

---

Member Data Documentation

boost::optional<std::set<Cell> > occupancy_grid_utils::TerminationCondition::goals_

Definition at line 95 of file shortest_path.h.

boost::optional<double> occupancy_grid_utils::TerminationCondition::max_distance_

Definition at line 94 of file shortest_path.h.

bool occupancy_grid_utils::TerminationCondition::use_cells_

Definition at line 96 of file shortest_path.h.

---

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

• shortest_path.h
• shortest_path.cpp