Representation of a benchmark request. More...

#include <ompl/tools/benchmark/Benchmark.h>

Public Member Functions
	Request (double maxTime=5.0, double maxMem=4096.0, unsigned int runCount=100, double timeBetweenUpdates=0.05, bool displayProgress=true, bool saveConsoleOutput=true, bool simplify=true)
	Constructor that provides default values for all members.

Public Attributes
double	maxTime
	the maximum amount of time a planner is allowed to run (seconds); 5.0 by default
double	maxMem
	the maximum amount of memory a planner is allowed to use (MB); 4096.0 by default
unsigned int	runCount
	the number of times to run each planner; 100 by default If set to 0, then run each planner as many times as possible with maxTime total time limit
double	timeBetweenUpdates
	When collecting time-varying data from a planner during its execution, the planner's progress will be queried every `timeBetweenUpdates` seconds.
bool	displayProgress
	flag indicating whether progress is to be displayed or not; true by default
bool	saveConsoleOutput
	flag indicating whether console output is saved (in an automatically generated filename); true by default
bool	simplify
	flag indicating whether simplification should be applied to path; true by default

Detailed Description

Representation of a benchmark request.

Definition at line 151 of file Benchmark.h.

Constructor & Destructor Documentation

◆ Request()

ompl::tools::Benchmark::Request::Request	(	double	maxTime = 5.0,
		double	maxMem = 4096.0,
		unsigned int	runCount = 100,
		double	timeBetweenUpdates = 0.05,
		bool	displayProgress = true,
		bool	saveConsoleOutput = true,
		bool	simplify = true )

inline

Constructor that provides default values for all members.

Definition at line 154 of file Benchmark.h.

Member Data Documentation

◆ displayProgress

bool ompl::tools::Benchmark::Request::displayProgress

flag indicating whether progress is to be displayed or not; true by default

Definition at line 182 of file Benchmark.h.

◆ maxMem

double ompl::tools::Benchmark::Request::maxMem

the maximum amount of memory a planner is allowed to use (MB); 4096.0 by default

Definition at line 171 of file Benchmark.h.

◆ maxTime

double ompl::tools::Benchmark::Request::maxTime

the maximum amount of time a planner is allowed to run (seconds); 5.0 by default

Definition at line 168 of file Benchmark.h.

◆ runCount

unsigned int ompl::tools::Benchmark::Request::runCount

the number of times to run each planner; 100 by default If set to 0, then run each planner as many times as possible with maxTime total time limit

Definition at line 175 of file Benchmark.h.

◆ saveConsoleOutput

bool ompl::tools::Benchmark::Request::saveConsoleOutput

flag indicating whether console output is saved (in an automatically generated filename); true by default

Definition at line 186 of file Benchmark.h.

◆ simplify

bool ompl::tools::Benchmark::Request::simplify

flag indicating whether simplification should be applied to path; true by default

Definition at line 189 of file Benchmark.h.

◆ timeBetweenUpdates

double ompl::tools::Benchmark::Request::timeBetweenUpdates

When collecting time-varying data from a planner during its execution, the planner's progress will be queried every timeBetweenUpdates seconds.

Definition at line 179 of file Benchmark.h.

The documentation for this struct was generated from the following file:

ompl/tools/benchmark/Benchmark.h

Public Member Functions

Public Attributes