---

OSCAR::ArtificialPotentialF Class Reference
[ObstacleAvoidance]

A function to calculate artificial potential field (APF). More...

#include <ScaleInverseF.hpp>

Inheritance diagram for OSCAR::ArtificialPotentialF:

[legend]List of all members.

Public Methods
virtual	~ArtificialPotentialF ()
virtual double	operator() (const double d) const=0
virtual double	Derivative (const double d) const=0

---

Detailed Description

The function class is used to calculate the artificial potential field given the distance between objects. It's an abstract class meant to be derived so that different means of calculating APF can be supplied. This function class is used in several performance criteria and criteria functions.

---

Constructor & Destructor Documentation

virtual OSCAR::ArtificialPotentialF::~ArtificialPotentialF (    )  [inline, virtual]

Virtual destructor.

---

Member Function Documentation

virtual double OSCAR::ArtificialPotentialF::Derivative (  const double    d )  const [pure virtual]

Compute the derivative of the APF wrt distance. Parameters: d  Distance between objects Returns: Derivative of APF wrt distance Implemented in OSCAR::ScaleInverseF, and OSCAR::ScaleInverseVanishF.

virtual double OSCAR::ArtificialPotentialF::operator() (  const double    d )  const [pure virtual]

Computes that strength (magnitude of force) of the APF. Parameters: d  Distance between objects Returns: Magnitude of force Implemented in OSCAR::ScaleInverseF, and OSCAR::ScaleInverseVanishF.

---

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

• ScaleInverseF.hpp

RRG Homepage

OSCAR Overview

OSCAR Tutorials

Simulations