base_local_planner::TrajectoryCostFunction Class Reference

Provides an interface for critics of trajectories During each sampling run, a batch of many trajectories will be scored using such a cost function. The prepare method is called before each batch run, and then for each trajectory of the sampling set, score_trajectory may be called. More...

#include <trajectory_cost_function.h>

Inheritance diagram for base_local_planner::TrajectoryCostFunction:

Public Member Functions
double	getScale ()
virtual bool	prepare ()=0
virtual double	scoreTrajectory (Trajectory &traj)=0
void	setScale (double scale)
virtual	~TrajectoryCostFunction ()

Protected Member Functions
	TrajectoryCostFunction (double scale=1.0)

Private Attributes
double	scale_

Detailed Description

Provides an interface for critics of trajectories During each sampling run, a batch of many trajectories will be scored using such a cost function. The prepare method is called before each batch run, and then for each trajectory of the sampling set, score_trajectory may be called.

Definition at line 87 of file trajectory_cost_function.h.

Constructor & Destructor Documentation

~TrajectoryCostFunction()

virtual base_local_planner::TrajectoryCostFunction::~TrajectoryCostFunction ( )

inlinevirtual

Definition at line 110 of file trajectory_cost_function.h.

TrajectoryCostFunction()

base_local_planner::TrajectoryCostFunction::TrajectoryCostFunction ( double  scale = 1.0 )

inlineprotected

Definition at line 113 of file trajectory_cost_function.h.

Member Function Documentation

getScale()

double base_local_planner::TrajectoryCostFunction::getScale ( )

inline

Definition at line 102 of file trajectory_cost_function.h.

prepare()

virtual bool base_local_planner::TrajectoryCostFunction::prepare ( )

pure virtual

General updating of context values if required. Subclasses may overwrite. Return false in case there is any error.

Implemented in base_local_planner::MapGridCostFunction, base_local_planner::TwirlingCostFunction, base_local_planner::ObstacleCostFunction, base_local_planner::OscillationCostFunction, and base_local_planner::PreferForwardCostFunction.

scoreTrajectory()

virtual double base_local_planner::TrajectoryCostFunction::scoreTrajectory ( Trajectory &  traj )

pure virtual

return a score for trajectory traj

Implemented in base_local_planner::MapGridCostFunction, base_local_planner::ObstacleCostFunction, base_local_planner::TwirlingCostFunction, base_local_planner::OscillationCostFunction, and base_local_planner::PreferForwardCostFunction.

setScale()

void base_local_planner::TrajectoryCostFunction::setScale ( double  scale )

inline

Definition at line 106 of file trajectory_cost_function.h.

Member Data Documentation

scale_

double base_local_planner::TrajectoryCostFunction::scale_

private

Definition at line 116 of file trajectory_cost_function.h.

---

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

• trajectory_cost_function.h