Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
global_planner::PotentialCalculator Class Reference

#include <potential_calculator.h>

Inheritance diagram for global_planner::PotentialCalculator:
Inheritance graph
[legend]

Public Member Functions

virtual float calculatePotential (float *potential, unsigned char cost, int n, float prev_potential=-1)
 
 PotentialCalculator (int nx, int ny)
 
virtual void setSize (int nx, int ny)
 Sets or resets the size of the map. More...
 

Protected Member Functions

int toIndex (int x, int y)
 

Protected Attributes

int ns_
 
int nx_
 
int ny_
 

Detailed Description

Definition at line 45 of file potential_calculator.h.

Constructor & Destructor Documentation

◆ PotentialCalculator()

global_planner::PotentialCalculator::PotentialCalculator ( int  nx,
int  ny 
)
inline

Definition at line 47 of file potential_calculator.h.

Member Function Documentation

◆ calculatePotential()

virtual float global_planner::PotentialCalculator::calculatePotential ( float *  potential,
unsigned char  cost,
int  n,
float  prev_potential = -1 
)
inlinevirtual

Reimplemented in global_planner::QuadraticCalculator.

Definition at line 51 of file potential_calculator.h.

◆ setSize()

virtual void global_planner::PotentialCalculator::setSize ( int  nx,
int  ny 
)
inlinevirtual

Sets or resets the size of the map.

Parameters
nxThe x size of the map
nyThe y size of the mapsets or resets the size of the map

Definition at line 67 of file potential_calculator.h.

◆ toIndex()

int global_planner::PotentialCalculator::toIndex ( int  x,
int  y 
)
inlineprotected

Definition at line 74 of file potential_calculator.h.

Member Data Documentation

◆ ns_

int global_planner::PotentialCalculator::ns_
protected

size of grid, in pixels

Definition at line 78 of file potential_calculator.h.

◆ nx_

int global_planner::PotentialCalculator::nx_
protected

Definition at line 78 of file potential_calculator.h.

◆ ny_

int global_planner::PotentialCalculator::ny_
protected

Definition at line 78 of file potential_calculator.h.


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


global_planner
Author(s): David Lu!!
autogenerated on Wed Jun 22 2022 02:07:21