MipAlgorithms::AntiSimmetryVars Class Reference
[Anti-Simmetry Control]

Variables class for the anti-simmetry control algorithm. More...

#include <AntiSimmetry.h>

List of all members.

Public Member Functions
	AntiSimmetryVars (AntiSimmetryParams &par)
	Parametrical constructor.
Position	getCentroid ()
	Gets the entroid of the formation.
void	setCentroid (Position &value)
	Sets the centroid of the formation.
Position	getCenteredFormation (int index)
	Gets an element of the centered formation.
void	getCenteredFormation (vector< Position > &ceForm)
	Gets the formation centered in the centroid.
int	getCenteredFormationSize ()
	Gets the size of the centered formation.
void	setCenteredFormation (int index, Position &value)
	Sets an element of the centered formation.
void	setCenteredFormationSize (int value)
	Sets the size of the centered formation .
vector< Decimal >	getSimmetryFunction ()
	Gets the simmetry function.
Decimal	getSimmetryFunction (int index)
	Gets an element of the simmetry function.
int	getSimmetryFunctionSize ()
	Gets the size of the simmetry function.
void	setSimmetryFunction (int index, Decimal value)
	Sets an element of the simmetry function.
int	getMinSimmetryFunctionRange ()
	Gets the minimum range of the simmetry function.
int	getMaxSimmetryFunctionRange ()
	Gets the maximum range of the simmetry function.
void	setSimmetryFunctionRange (int min, int max)
	Sets the range of the simmetry function.
Decimal	getMinSimmetryFunction ()
	Gets the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.
void	setMinSimmetryFunction (Decimal min)
	Sets the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.
int	getMinSimmetryFunctionIndex ()
	Gets the index of the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.
void	setMinSimmetryFunctionIndex (int minInd)
	Sets the index of the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.
void	getClosestRotatedFormation (vector< Position > &clForm)
	Gets the closest rotated formation computed during the last execution.
void	setClosestRotatedFormation (vector< Position > &clForm)
	Sets the closest rotated formation computed during the last execution.
string	print ()
	Print function.

---

Detailed Description

Variables class for the anti-simmetry control algorithm.

Author:

Paolo Stegagno

---

Constructor & Destructor Documentation

MipAlgorithms::AntiSimmetryVars::AntiSimmetryVars

(

AntiSimmetryParams &

par

)

Parametrical constructor.

Parameters:

[in]

&par

Parameters.

---

Member Function Documentation

Position MipAlgorithms::AntiSimmetryVars::getCentroid

(

)

Gets the entroid of the formation.

Returns:

Value of the centroid.

void MipAlgorithms::AntiSimmetryVars::setCentroid

(

Position &

value

)

Sets the centroid of the formation.

Parameters:

[in]

&value

Value to set.

Position MipAlgorithms::AntiSimmetryVars::getCenteredFormation

(

int

index

)

Gets an element of the centered formation.

Parameters:

[in]

index

Index of the requested element.

Returns:

Value of the requested element.

void MipAlgorithms::AntiSimmetryVars::getCenteredFormation

(

vector< Position > &

ceForm

)

Gets the formation centered in the centroid.

Parameters:

[out]

&ceForm

Writes in this field the requested value.

int MipAlgorithms::AntiSimmetryVars::getCenteredFormationSize

(

)

Gets the size of the centered formation.

Returns:

Value of the requested size.

void MipAlgorithms::AntiSimmetryVars::setCenteredFormation	(	int	index,
		Position &	value
	)

Sets an element of the centered formation.

Parameters:

[in]	index	Index of the element to set.
[in]	&value	Value to set.

void MipAlgorithms::AntiSimmetryVars::setCenteredFormationSize

(

int

value

)

Sets the size of the centered formation .

Parameters:

[in]

value

Value to set.

vector< Decimal > MipAlgorithms::AntiSimmetryVars::getSimmetryFunction

(

)

Gets the simmetry function.

Returns:

Value of the requested element.

Decimal MipAlgorithms::AntiSimmetryVars::getSimmetryFunction

(

int

index

)

Gets an element of the simmetry function.

Parameters:

[in]

index

Index of the requested element.

Returns:

Value of the requested element.

int MipAlgorithms::AntiSimmetryVars::getSimmetryFunctionSize

(

)

Gets the size of the simmetry function.

Returns:

Value of the requested size.

void MipAlgorithms::AntiSimmetryVars::setSimmetryFunction	(	int	index,
		Decimal	value
	)

Sets an element of the simmetry function.

Parameters:

[in]	index	Index of the element to set.
[in]	value	Value to set.

int MipAlgorithms::AntiSimmetryVars::getMinSimmetryFunctionRange

(

)

Gets the minimum range of the simmetry function.

Returns:

Value of the requested field.

int MipAlgorithms::AntiSimmetryVars::getMaxSimmetryFunctionRange

(

)

Gets the maximum range of the simmetry function.

Returns:

Value of the requested field.

void MipAlgorithms::AntiSimmetryVars::setSimmetryFunctionRange	(	int	min,
		int	max
	)

Sets the range of the simmetry function.

Parameters:

[in]	min	Value to set as minimum range.
[in]	max	Value to set as maximum range.

Decimal MipAlgorithms::AntiSimmetryVars::getMinSimmetryFunction

(

)

Gets the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.

Returns:

Value of the requested field.

void MipAlgorithms::AntiSimmetryVars::setMinSimmetryFunction

(

Decimal

min

)

Sets the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.

Parameters:

[in]

min

Value to be set.

int MipAlgorithms::AntiSimmetryVars::getMinSimmetryFunctionIndex

(

)

Gets the index of the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.

Returns:

Value of the requested field.

void MipAlgorithms::AntiSimmetryVars::setMinSimmetryFunctionIndex

(

int

minInd

)

Sets the index of the minimum of the simmetry function in the range given by the getSimmetryFunctionRange methods.

Parameters:

[in]

minInd

Value to be set.

void MipAlgorithms::AntiSimmetryVars::getClosestRotatedFormation

(

vector< Position > &

clForm

)

Gets the closest rotated formation computed during the last execution.

Parameters:

[out]

&clForm

Writes in this field the requested value.

void MipAlgorithms::AntiSimmetryVars::setClosestRotatedFormation

(

vector< Position > &

clForm

)

Sets the closest rotated formation computed during the last execution.

Parameters:

[in]

&clForm

The closest rotatedFormation is set at this value.

string MipAlgorithms::AntiSimmetryVars::print

(

)

Print function.

Returns:

A printable string.

---

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

• algorithms/AntiSimmetry/AntiSimmetry.h
• algorithms/AntiSimmetry/AntiSimmetry.cpp