Public Member Functions | List of all members
ompl::tools::PlannerMonitor Class Reference

Monitor the properties a planner exposes, as the planner is running. Dump the planner properties to a stream, periodically. More...

#include <ompl/tools/debug/PlannerMonitor.h>

Public Member Functions

 PlannerMonitor (const PlannerMonitor &)=delete
 
PlannerMonitor & operator= (const PlannerMonitor &)=delete
 
 PlannerMonitor (base::PlannerPtr planner, std::ostream &out, double period=0.5, bool autoStart=true)
 Monitor a planner instance, and dump its properties to a specified stream, periodically. More...
 
 ~PlannerMonitor ()
 Destructor.
 
void startMonitor ()
 Start the monitoring thread.
 
void stopMonitor ()
 Stop the monitoring thread (automatically stopped by the destructor).
 

Detailed Description

Monitor the properties a planner exposes, as the planner is running. Dump the planner properties to a stream, periodically.

Definition at line 117 of file PlannerMonitor.h.

Constructor & Destructor Documentation

◆ PlannerMonitor()

ompl::tools::PlannerMonitor::PlannerMonitor ( base::PlannerPtr  planner,
std::ostream &  out,
double  period = 0.5,
bool  autoStart = true 
)
inline

Monitor a planner instance, and dump its properties to a specified stream, periodically.

Every time the properties are dumped, the stream offset is set to 0. It is often useful to have the stream be a file, and then issue commands such as 'watch cat filename'.

Definition at line 160 of file PlannerMonitor.h.

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