TELEKYB_NAMESPACE::PotentialFunction Class Reference

#include <PotentialFunction.hpp>

Inheritance diagram for TELEKYB_NAMESPACE::PotentialFunction:

List of all members.

Public Member Functions
PotentialFunctionOptions &	getOptions ()
double	getPotential (double d) const
virtual double	getPotentialImpl (double d) const =0
PotentialFunctionType	getType () const
virtual void	optionDidChange (const Option< double > *option_)
	PotentialFunction (const std::string &potentialFunctionName_, PotentialFunctionType type_)
	PotentialFunction (const std::string &potentialFunctionName_, PotentialFunctionType type_, double tPotFuncZeroD_, double tPotFuncInfD_, double tPotFuncSatValue_, double tPotFuncGain_)
virtual	~PotentialFunction ()
Protected Member Functions
void	updateBoundsValues ()
Protected Attributes
PotentialFunctionOptions	options
PotentialFunctionType	type
Private Member Functions
void	registerOptionListeners ()

---

Detailed Description

Definition at line 17 of file PotentialFunction.hpp.

---

Constructor & Destructor Documentation

TELEKYB_NAMESPACE::PotentialFunction::PotentialFunction	(	const std::string &	potentialFunctionName_,
		PotentialFunctionType	type_
	)

Definition at line 16 of file PotentialFunction.cpp.

TELEKYB_NAMESPACE::PotentialFunction::PotentialFunction	(	const std::string &	potentialFunctionName_,
		PotentialFunctionType	type_,
		double	tPotFuncZeroD_,
		double	tPotFuncInfD_,
		double	tPotFuncSatValue_,
		double	tPotFuncGain_
	)

Definition at line 41 of file PotentialFunction.cpp.

TELEKYB_NAMESPACE::PotentialFunction::~PotentialFunction

(

)

[virtual]

Definition at line 59 of file PotentialFunction.cpp.

---

Member Function Documentation

PotentialFunctionOptions & TELEKYB_NAMESPACE::PotentialFunction::getOptions

(

)

Definition at line 100 of file PotentialFunction.cpp.

double TELEKYB_NAMESPACE::PotentialFunction::getPotential

(

double

d

)

const

Definition at line 104 of file PotentialFunction.cpp.

virtual double TELEKYB_NAMESPACE::PotentialFunction::getPotentialImpl

(

double

d

)

const [pure virtual]

Implemented in TELEKYB_NAMESPACE::CoTanAttractiveGradient, and TELEKYB_NAMESPACE::CoTanRepulsiveGradient.

PotentialFunctionType TELEKYB_NAMESPACE::PotentialFunction::getType

(

)

const

Definition at line 96 of file PotentialFunction.cpp.

void TELEKYB_NAMESPACE::PotentialFunction::optionDidChange

(

const Option< double > *

option_

)

[virtual]

Reimplemented from TELEKYB_NAMESPACE::OptionListener< double >.

Definition at line 127 of file PotentialFunction.cpp.

void TELEKYB_NAMESPACE::PotentialFunction::registerOptionListeners

(

)

[private]

Definition at line 66 of file PotentialFunction.cpp.

void TELEKYB_NAMESPACE::PotentialFunction::updateBoundsValues

(

)

[protected]

Definition at line 73 of file PotentialFunction.cpp.

---

Member Data Documentation

PotentialFunctionOptions TELEKYB_NAMESPACE::PotentialFunction::options [protected]

Definition at line 22 of file PotentialFunction.hpp.

PotentialFunctionType TELEKYB_NAMESPACE::PotentialFunction::type [protected]

Definition at line 24 of file PotentialFunction.hpp.

---

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

• PotentialFunction.hpp
• PotentialFunction.cpp