A class to run a planner for a specific number of iterations. Casts to a PTC for use with Planner::solve. More...
#include <ompl/base/terminationconditions/IterationTerminationCondition.h>
Public Member Functions | |
IterationTerminationCondition (unsigned int numIterations) | |
Construct a termination condition that can be evaluated numIterations times before returning true. | |
bool | eval () |
Increment the number of times eval has been called and check if the planner should now terminate. | |
void | reset () |
Reset the number of times the IterationTeriminationCondition has been called. | |
operator PlannerTerminationCondition () | |
Cast to a PlannerTerminationCondition. | |
unsigned int | getTimesCalled () const |
Detailed Description
A class to run a planner for a specific number of iterations. Casts to a PTC for use with Planner::solve.
Definition at line 48 of file IterationTerminationCondition.h.
Constructor & Destructor Documentation
◆ IterationTerminationCondition()
ompl::base::IterationTerminationCondition::IterationTerminationCondition | ( | unsigned int | numIterations | ) |
Construct a termination condition that can be evaluated numIterations times before returning true.
Definition at line 39 of file IterationTerminationCondition.cpp.
Member Function Documentation
◆ eval()
bool ompl::base::IterationTerminationCondition::eval | ( | ) |
Increment the number of times eval has been called and check if the planner should now terminate.
Definition at line 44 of file IterationTerminationCondition.cpp.
◆ getTimesCalled()
|
inline |
Definition at line 65 of file IterationTerminationCondition.h.
◆ reset()
void ompl::base::IterationTerminationCondition::reset | ( | ) |
Reset the number of times the IterationTeriminationCondition has been called.
Definition at line 51 of file IterationTerminationCondition.cpp.
The documentation for this class was generated from the following files:
- ompl/base/terminationconditions/IterationTerminationCondition.h
- ompl/base/terminationconditions/src/IterationTerminationCondition.cpp