Public Member Functions | Private Attributes | List of all members
base_local_planner::PreferForwardCostFunction Class Reference

#include <prefer_forward_cost_function.h>

Inheritance diagram for base_local_planner::PreferForwardCostFunction:
Inheritance graph
[legend]

Public Member Functions

 PreferForwardCostFunction (double penalty)
 
bool prepare ()
 
double scoreTrajectory (Trajectory &traj)
 
void setPenalty (double penalty)
 
 ~PreferForwardCostFunction ()
 
- Public Member Functions inherited from base_local_planner::TrajectoryCostFunction
double getScale ()
 
void setScale (double scale)
 
virtual ~TrajectoryCostFunction ()
 

Private Attributes

double penalty_
 

Additional Inherited Members

- Protected Member Functions inherited from base_local_planner::TrajectoryCostFunction
 TrajectoryCostFunction (double scale=1.0)
 

Detailed Description

Definition at line 80 of file prefer_forward_cost_function.h.

Constructor & Destructor Documentation

◆ PreferForwardCostFunction()

base_local_planner::PreferForwardCostFunction::PreferForwardCostFunction ( double  penalty)
inline

Definition at line 118 of file prefer_forward_cost_function.h.

◆ ~PreferForwardCostFunction()

base_local_planner::PreferForwardCostFunction::~PreferForwardCostFunction ( )
inline

Definition at line 119 of file prefer_forward_cost_function.h.

Member Function Documentation

◆ prepare()

bool base_local_planner::PreferForwardCostFunction::prepare ( )
inlinevirtual

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

Implements base_local_planner::TrajectoryCostFunction.

Definition at line 123 of file prefer_forward_cost_function.h.

◆ scoreTrajectory()

double base_local_planner::PreferForwardCostFunction::scoreTrajectory ( Trajectory traj)
virtual

return a score for trajectory traj

Implements base_local_planner::TrajectoryCostFunction.

Definition at line 15 of file prefer_forward_cost_function.cpp.

◆ setPenalty()

void base_local_planner::PreferForwardCostFunction::setPenalty ( double  penalty)
inline

Definition at line 125 of file prefer_forward_cost_function.h.

Member Data Documentation

◆ penalty_

double base_local_planner::PreferForwardCostFunction::penalty_
private

Definition at line 130 of file prefer_forward_cost_function.h.


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


base_local_planner
Author(s): Eitan Marder-Eppstein, Eric Perko, contradict@gmail.com
autogenerated on Mon Mar 6 2023 03:50:24