iso::flock::GridAvgBehavior Class Reference

add grid value at Agent position to output parameter More...

#include <iso_flock_grid_avg_behavior.h>

Inherits iso::flock::Behavior.

Inheritance diagram for iso::flock::GridAvgBehavior:

[legend]Collaboration diagram for iso::flock::GridAvgBehavior:

[legend]List of all members.

Public Member Functions
	GridAvgBehavior (const base::String &pInputParameterString, const base::String &pOutputParameterString)
	create behavior
	GridAvgBehavior (Agent *pAgent, const base::String &pBehaviorName, const base::String &pInputParameterString, const base::String &pOutputParameterString) throw (FlockException)
	create behavior
	~GridAvgBehavior ()
	destructor
virtual Behavior *	create (const base::String &pBehaviorName, Agent *pAgent) const throw (FlockException)
	create copy of behavior
virtual Behavior *	create (const base::String &pInputParameterString, const base::String &pOutputParameterString) const
	create copy of behavior
void	act ()
	perform behavior
Protected Attributes
Parameter *	mParIn
Parameter *	mParOut
	input parameter (input)
Parameter *	mMinDistPar
	output parameter (output)
Parameter *	mMaxDistPar
	mininum distance parameter (internal)
Parameter *	mAmountPar
	maximum distance parameter (internal)
space::NeighborGroup *	mGridValues
	behavior amount parameter (internal)
math::Vector< real >	mTmpValueOut
	grid values

---

Detailed Description

add grid value at Agent position to output parameter

value at Agent position to output parameter

The Behavior adds grid value at Agent position to output parameter
The grid value is linearly interpolated.

Input Parameter:
type: position dim: nD neighbors: required

Output Parameter:
type: output dim: nD write: add

Internal Parameter:
name: xxx_minDist dim: 1D defaultValue: 0.0
name: xxx_maxDist dim: 1D defaultValue: 1.0
name: xxx_amount dim: 1D defaultValue: 1.0
name: xxx_active dim: 1D defaultValue: 0.1

Created by Daniel Bisig on 5/24/07.

---

Constructor & Destructor Documentation

GridAvgBehavior::GridAvgBehavior	(	const base::String &	pInputParameterString,
		const base::String &	pOutputParameterString
	)

create behavior

Parameters:

	pInputParameterString	input parameter string (parameters are space separated)
	pOutputParameterString	output paramaters are space separated)

GridAvgBehavior::GridAvgBehavior	(	Agent *	pAgent,
		const base::String &	pBehaviorName,
		const base::String &	pInputParameterString,
		const base::String &	pOutputParameterString
	)			throw (FlockException)

create behavior

Parameters:

	pAgent	agent this behavior belongs to
	pBehaviorName	name of behavior
	pInputParameterString	input parameter string (parameters are space separated)
	pOutputParameterString	output paramaters are space separated)

Exceptions:

FlockException

wrong number of type of parameters

GridAvgBehavior::~GridAvgBehavior

(

)

destructor

---

Member Function Documentation

Behavior * GridAvgBehavior::create	(	const base::String &	pBehaviorName,
		Agent *	pAgent
	)			const throw (FlockException) [virtual]

create copy of behavior

Parameters:

	pAgent	agent this behavior belongs to
	pBehaviorName	name of behavior

Returns:

new behavior

Exceptions:

FlockException

wrong number of type of parameters

Implements iso::flock::Behavior.

Behavior * GridAvgBehavior::create	(	const base::String &	pInputParameterString,
		const base::String &	pOutputParameterString
	)			const [virtual]

create copy of behavior

Parameters:

	pInputParameterString	input parameter string
	pOutputParameterString	output parameter string

Returns:

new behavior

Implements iso::flock::Behavior.

void GridAvgBehavior::act

(

)

[virtual]

perform behavior

Implements iso::flock::Behavior.

---

Member Data Documentation

Parameter* iso::flock::GridAvgBehavior::mParIn [protected]

Parameter* iso::flock::GridAvgBehavior::mParOut [protected]

input parameter (input)

Parameter* iso::flock::GridAvgBehavior::mMinDistPar [protected]

output parameter (output)

Parameter* iso::flock::GridAvgBehavior::mMaxDistPar [protected]

mininum distance parameter (internal)

Parameter* iso::flock::GridAvgBehavior::mAmountPar [protected]

maximum distance parameter (internal)

space::NeighborGroup* iso::flock::GridAvgBehavior::mGridValues [protected]

behavior amount parameter (internal)

math::Vector<real> iso::flock::GridAvgBehavior::mTmpValueOut [protected]

grid values

---

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

• /Users/dbisig/programming/swarms/trunk/flock/trunk/code/behavior/iso_flock_grid_avg_behavior.h
• /Users/dbisig/programming/swarms/trunk/flock/trunk/code/behavior/iso_flock_grid_avg_behavior.cpp

---