Public Member Functions | Private Attributes | List of all members
multi_robot_router::PotentialCalculator Class Reference

#include <potential_calculator.h>

Public Member Functions

float CalculatePotential (const Vertex &_vertex) const
 calculates the potential for a vertex More...
 
float CalculatePotential (const Segment &_segment) const
 calculates the potential for a segment More...
 
 PotentialCalculator ()
 constructor More...
 
 PotentialCalculator (const float &_multiplier)
 constructor More...
 
void SetMultiplier (const float &_multiplier)
 sets the Potential multiplier More...
 

Private Attributes

float multiplier_
 

Detailed Description

Definition at line 36 of file potential_calculator.h.

Constructor & Destructor Documentation

multi_robot_router::PotentialCalculator::PotentialCalculator ( )

constructor

Definition at line 33 of file potential_calculator.cpp.

multi_robot_router::PotentialCalculator::PotentialCalculator ( const float &  _multiplier)

constructor

Parameters
_multiplierthe multiplier used to multiply the potential with (used for reducing robots speeds)

Definition at line 37 of file potential_calculator.cpp.

Member Function Documentation

float multi_robot_router::PotentialCalculator::CalculatePotential ( const Vertex _vertex) const

calculates the potential for a vertex

Parameters
_vertexthe vertext used for the calculation
Returns
the calculated Potential

Definition at line 41 of file potential_calculator.cpp.

float multi_robot_router::PotentialCalculator::CalculatePotential ( const Segment _segment) const

calculates the potential for a segment

Parameters
_segmentthe segment used for the calculation
Returns
the calculated Potential

Definition at line 46 of file potential_calculator.cpp.

void multi_robot_router::PotentialCalculator::SetMultiplier ( const float &  _multiplier)

sets the Potential multiplier

Parameters
_multiplierthe multiplier used to multiply the potential with (used for reducing robots speeds)

Definition at line 51 of file potential_calculator.cpp.

Member Data Documentation

float multi_robot_router::PotentialCalculator::multiplier_
private

Definition at line 67 of file potential_calculator.h.


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


tuw_multi_robot_router
Author(s): Benjamin Binder
autogenerated on Mon Jun 10 2019 15:42:49