iso::flock::ParameterMagBehavior Class Reference

stores magnitude of input parameter in output parameter More...

#include <iso_flock_parameter_mag_behavior.h>

Inherits iso::flock::Behavior.

Inheritance diagram for iso::flock::ParameterMagBehavior:

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

[legend]List of all members.

Public Member Functions
	ParameterMagBehavior (const base::String &pInputParameterString, const base::String &pOutputParameterString)
	create behavior
	ParameterMagBehavior (Agent *pAgent, const base::String &pBehaviorName, const base::String &pInputParameterString, const base::String &pOutputParameterString) throw (FlockException)
	create behavior
	~ParameterMagBehavior ()
	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 *	mParameter
Parameter *	mMagParameter
	parameter (input)

---

Detailed Description

stores magnitude of input parameter in output parameter

of input parameter in output parameter

Input Parameter:
type: any dim: nD neighbors: ignored

Output Parameter:
type: magnitude dim: 1D write: replace

Internal Parameter:

Created by Daniel Bisig on 09/11/09.

---

Constructor & Destructor Documentation

ParameterMagBehavior::ParameterMagBehavior	(	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)

ParameterMagBehavior::ParameterMagBehavior	(	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

ParameterMagBehavior::~ParameterMagBehavior

(

)

destructor

---

Member Function Documentation

Behavior * ParameterMagBehavior::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 * ParameterMagBehavior::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 ParameterMagBehavior::act

(

)

[virtual]

perform behavior

Implements iso::flock::Behavior.

---

Member Data Documentation

Parameter* iso::flock::ParameterMagBehavior::mParameter [protected]

Parameter* iso::flock::ParameterMagBehavior::mMagParameter [protected]

parameter (input)

---

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

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

---