estar::AlgorithmOptions Class Reference

#include <Facade.hpp>

List of all members.

Public Member Functions
	AlgorithmOptions ()
	Default: no special propagator checks, no automatic resets or flushing.
	AlgorithmOptions (bool check_upwind, bool check_local_consistency, bool check_queue_key, bool auto_reset, bool auto_flush)
Public Attributes
bool	check_upwind
	Whether to check the upwind structure when computing the propagator set of a node.
bool	check_local_consistency
	Whether to check for local consistency (rhs==value) when computing the propagator set of a node.
bool	check_queue_key
	Whether to check if a neighbor lies below the wavefront when computing the propagator set of a node.
bool	auto_reset
	Whether to automatically reset the whole E* computations when meta information changes.
bool	auto_flush
	Whether to automatically propagate until the entire queue has been emptied each time you call Algorithm::ComputeOne() or Facade::ComputeOne() or similar.

---

Constructor & Destructor Documentation

estar::AlgorithmOptions::AlgorithmOptions

(

)

Default: no special propagator checks, no automatic resets or flushing.

estar::AlgorithmOptions::AlgorithmOptions	(	bool	check_upwind,
		bool	check_local_consistency,
		bool	check_queue_key,
		bool	auto_reset,
		bool	auto_flush
	)

---

Member Data Documentation

bool estar::AlgorithmOptions::check_upwind

Whether to check the upwind structure when computing the propagator set of a node.

Passed to PropagatorFactory ctor via Algorithm ctor. Use false to mimic old behavior.

bool estar::AlgorithmOptions::check_local_consistency

Whether to check for local consistency (rhs==value) when computing the propagator set of a node.

Passed to PropagatorFactory ctor via Algorithm ctor. Use false to mimic old behavior.

bool estar::AlgorithmOptions::check_queue_key

Whether to check if a neighbor lies below the wavefront when computing the propagator set of a node.

Passed to PropagatorFactory ctor via Algorithm ctor. Use false to mimic old behavior

bool estar::AlgorithmOptions::auto_reset

Whether to automatically reset the whole E* computations when meta information changes.

This is usually not needed, as the algorithm is designed to copy with exactly that, but this flag makes it easy to verify that the propagation result is the same. Passed to Algorithm ctor. Use false unless you have a good reason for wasting processing power.

bool estar::AlgorithmOptions::auto_flush

Whether to automatically propagate until the entire queue has been emptied each time you call Algorithm::ComputeOne() or Facade::ComputeOne() or similar.

This is usually a waste of resources, because you only need to propagate until the wavefront has passed over the robot's current location, which can be checked by calling Facade::GetStatus(). Use false unless you have a good reason for wasting processing power

---

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

• estar/Facade.hpp
• estar/Facade.cpp

---

E* Interpolated Graph Replanner Wed Dec 12 18:55:50 2007