ArtPotentialFormCtrlPar Class Reference
[Formation control algorithms]

Parameters for the artificial potential formation control algorithms. More...

#include <FormationControl.h>

Inheritance diagram for ArtPotentialFormCtrlPar:

List of all members.

Public Member Functions
	ArtPotentialFormCtrlPar (Decimal attrMaxDist=3.0, Decimal attractGain=1.0, Decimal repulMaxDist=2.0, Decimal repulMinDist=0.3, Decimal repulGain=1.0, Time virtPointLifeTime=Time(0.1))
	Default constructor.
	ArtPotentialFormCtrlPar (const ArtPotentialFormCtrlPar &p)
	Copy constructor.
ArtPotentialFormCtrlPar &	operator= (const ArtPotentialFormCtrlPar &rhs)
	Assignment operator.
Decimal	attrMaxDist ()
	Gets the max distance of the attractive potential.
Decimal	attrGain ()
	Gets the gain of the attractive potential.
Decimal	repulMinDist ()
	Gets the max distance of the repulsive potential.
Decimal	repulMaxDist ()
	Gets the max distance of the repulsive potential.
Decimal	repulGain ()
	Gets the gain of the repulsive potential.
Time	virtPointLifeTime ()
	Gets the life time of a received virtual point.
string	getObjectName () const
	Gets the name.

---

Detailed Description

Parameters for the artificial potential formation control algorithms.

---

Constructor & Destructor Documentation

ArtPotentialFormCtrlPar::ArtPotentialFormCtrlPar	(	Decimal	attrMaxDist = 3.0,
		Decimal	attractGain = 1.0,
		Decimal	repulMaxDist = 2.0,
		Decimal	repulMinDist = 0.3,
		Decimal	repulGain = 1.0,
		Time	virtPointLifeTime = Time(0.1)
	)

Default constructor.

Parameters:

[in]	attrMaxDist	.
[in]	attractGain	.
[in]	repulMinDist	.
[in]	repulGain	.
[in]	virtPointLifeTime	L=ife time of a received virtual point.

ArtPotentialFormCtrlPar::ArtPotentialFormCtrlPar

(

const ArtPotentialFormCtrlPar &

p

)

Copy constructor.

---

Member Function Documentation

ArtPotentialFormCtrlPar & ArtPotentialFormCtrlPar::operator=

(

const ArtPotentialFormCtrlPar &

rhs

)

Assignment operator.

Decimal ArtPotentialFormCtrlPar::attrMaxDist

(

)

Gets the max distance of the attractive potential.

Returns:

Max distance of the attractive potential.

Decimal ArtPotentialFormCtrlPar::attrGain

(

)

Gets the gain of the attractive potential.

Returns:

Gain of the attractive potential.

Decimal ArtPotentialFormCtrlPar::repulMinDist

(

)

Gets the max distance of the repulsive potential.

Returns:

Max distance of the repulsive potential.

Decimal ArtPotentialFormCtrlPar::repulMaxDist

(

)

Gets the max distance of the repulsive potential.

Returns:

Max distance of the repulsive potential.

Decimal ArtPotentialFormCtrlPar::repulGain

(

)

Gets the gain of the repulsive potential.

Returns:

Gain of the repulsive potential.

Time ArtPotentialFormCtrlPar::virtPointLifeTime

(

)

Gets the life time of a received virtual point.

Returns:

Life time of a received virtual point.

string ArtPotentialFormCtrlPar::getObjectName

(

)

const [inline, virtual]

Gets the name.

Implements MIPObject.

---

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

• algorithms/FormationControl/FormationControl.h
• algorithms/FormationControl/FormationControl.cpp