Class PlannerMonitor

Class Documentation

class PlannerMonitor

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

Public Functions

PlannerMonitor(const PlannerMonitor&) = delete
PlannerMonitor &operator=(const PlannerMonitor&) = delete
inline 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.

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’.

inline ~PlannerMonitor()

Destructor.

void startMonitor()

Start the monitoring thread.

void stopMonitor()

Stop the monitoring thread (automatically stopped by the destructor).