shawn::PerfectDistanceEstimate Class Reference
#include <perfect_distance_estimate.h>
Inheritance diagram for shawn::PerfectDistanceEstimate:
Collaboration diagram for shawn::PerfectDistanceEstimate:
Public Member Functions | |
| PerfectDistanceEstimate () | |
| virtual | ~PerfectDistanceEstimate () |
| virtual bool | estimate_distance (const Node &source, const Node &target, double &result) const throw () |
| virtual std::string | name (void) const throw () |
| virtual std::string | description (void) const throw () |
Constructor & Destructor Documentation
| shawn::PerfectDistanceEstimate::PerfectDistanceEstimate | ( | ) |
| virtual shawn::PerfectDistanceEstimate::~PerfectDistanceEstimate | ( | ) | [virtual] |
Member Function Documentation
| virtual bool shawn::PerfectDistanceEstimate::estimate_distance | ( | const Node & | source, | |
| const Node & | target, | |||
| double & | result | |||
| ) | const throw () [virtual] |
Estimates the distance between two nodes source and target.
- Parameters:
-
source The source node for the estimation target The destination node for the estimation result The result of the estimation will be placed here ONLY IF true is returned
- Returns:
- true if a distance could be estimated between the two nodes, false otherwise
Implements shawn::NodeDistanceEstimate.
| virtual std::string shawn::PerfectDistanceEstimate::name | ( | void | ) | const throw () [virtual] |
Implements shawn::KeeperManaged.
| virtual std::string shawn::PerfectDistanceEstimate::description | ( | void | ) | const throw () [virtual] |
Implements shawn::KeeperManaged.
The documentation for this class was generated from the following file:
- src/sys/distance_estimates/perfect_distance_estimate.h
