teb_local_planner::EdgeVelocityObstacleRatio Class Reference

Edge defining the cost function for keeping a minimum distance from obstacles. More...

#include <edge_velocity_obstacle_ratio.h>

Inheritance diagram for teb_local_planner::EdgeVelocityObstacleRatio:

Public Member Functions
void	computeError ()
	Actual cost function. More...
	EdgeVelocityObstacleRatio ()
	Construct edge. More...
void	setObstacle (const Obstacle *obstacle)
	Set pointer to associated obstacle for the underlying cost function. More...
void	setParameters (const TebConfig &cfg, const BaseRobotFootprintModel *robot_model, const Obstacle *obstacle)
	Set all parameters at once. More...
void	setRobotModel (const BaseRobotFootprintModel *robot_model)
	Set pointer to the robot model. More...
Public Member Functions inherited from teb_local_planner::BaseTebMultiEdge< 2, const Obstacle *>
ErrorVector &	getError ()
	Compute and return error / cost value. More...
virtual bool	read (std::istream &is)
	Read values from input stream. More...
virtual void	resize (size_t size)
void	setTebConfig (const TebConfig &cfg)
	Assign the TebConfig class for parameters. More...
virtual bool	write (std::ostream &os) const
	Write values to an output stream. More...

Protected Attributes
const BaseRobotFootprintModel *	robot_model_
	Store pointer to robot_model. More...
Protected Attributes inherited from teb_local_planner::BaseTebMultiEdge< 2, const Obstacle *>
const TebConfig *	cfg_
	Store TebConfig class for parameters. More...

Detailed Description

Edge defining the cost function for keeping a minimum distance from obstacles.

The edge depends on a single vertex and minimizes:
.
dist2point denotes the minimum distance to the point obstacle.
weight can be set using setInformation().
penaltyBelow denotes the penalty function, see penaltyBoundFromBelow()

See also

TebOptimalPlanner::AddEdgesObstacles, TebOptimalPlanner::EdgeInflatedObstacle

Remarks

Do not forget to call setTebConfig() and setObstacle()

Definition at line 66 of file edge_velocity_obstacle_ratio.h.

Constructor & Destructor Documentation

EdgeVelocityObstacleRatio()

teb_local_planner::EdgeVelocityObstacleRatio::EdgeVelocityObstacleRatio ( )

inline

Construct edge.

Definition at line 73 of file edge_velocity_obstacle_ratio.h.

Member Function Documentation

computeError()

void teb_local_planner::EdgeVelocityObstacleRatio::computeError ( )

inline

Actual cost function.

Definition at line 83 of file edge_velocity_obstacle_ratio.h.

setObstacle()

void teb_local_planner::EdgeVelocityObstacleRatio::setObstacle ( const Obstacle *  obstacle )

inline

Set pointer to associated obstacle for the underlying cost function.

Parameters

obstacle

2D position vector containing the position of the obstacle

Definition at line 129 of file edge_velocity_obstacle_ratio.h.

setParameters()

void teb_local_planner::EdgeVelocityObstacleRatio::setParameters ( const TebConfig &  cfg, const BaseRobotFootprintModel *  robot_model, const Obstacle *  obstacle  )

inline

Set all parameters at once.

Parameters

cfg	TebConfig class
robot_model	Robot model required for distance calculation
obstacle	2D position vector containing the position of the obstacle

Definition at line 149 of file edge_velocity_obstacle_ratio.h.

setRobotModel()

void teb_local_planner::EdgeVelocityObstacleRatio::setRobotModel ( const BaseRobotFootprintModel *  robot_model )

inline

Set pointer to the robot model.

Parameters

robot_model

Robot model required for distance calculation

Definition at line 138 of file edge_velocity_obstacle_ratio.h.

Member Data Documentation

robot_model_

const BaseRobotFootprintModel* teb_local_planner::EdgeVelocityObstacleRatio::robot_model_

protected

Store pointer to robot_model.

Definition at line 158 of file edge_velocity_obstacle_ratio.h.

---

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

• edge_velocity_obstacle_ratio.h