iso::flock::ParameterScaleBehavior Class Reference

scale parameter values More...

#include <iso_flock_parameter_scale_behavior.h>

Inherits iso::flock::Behavior.

Inheritance diagram for iso::flock::ParameterScaleBehavior:

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

[legend]List of all members.

Public Member Functions
	ParameterScaleBehavior (const base::String &pInputParameterString, const base::String &pOutputParameterString)
	create behavior
	ParameterScaleBehavior (Agent *pAgent, const base::String &pBehaviorName, const base::String &pInputParameterString, const base::String &pOutputParameterString) throw (FlockException)
	create behavior
	~ParameterScaleBehavior ()
	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 *	mInputPar
Parameter *	mOutputPar
	input parameter
Parameter *	mMinInPar
	output parameter
Parameter *	mMaxInPar
	minimum input value parameter (internal)
Parameter *	mMinOutPar
	maximum input value parameter (internal)
Parameter *	mMaxOutPar
	minimum output value parameter (internal)

---

Detailed Description

scale parameter values

values

The Behavior scales parameter values
It copies the scaled values into an output parameter

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

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

Internal Parameter:
name: xxx_minInput dim: nD defaultValue: 0.0
name: xxx_maxInput dim: nD defaultValue: 1.0
name: xxx_minOutput dim: nD defaultValue: 0.0
name: xxx_maxOutput dim: nD defaultValue: 1.0
name: xxx_active dim: 1D defaultValue: 0.1

Created by Daniel Bisig on 4/5/08.

---

Constructor & Destructor Documentation

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

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

ParameterScaleBehavior::~ParameterScaleBehavior

(

)

destructor

---

Member Function Documentation

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

(

)

[virtual]

perform behavior

Implements iso::flock::Behavior.

---

Member Data Documentation

Parameter* iso::flock::ParameterScaleBehavior::mInputPar [protected]

Parameter* iso::flock::ParameterScaleBehavior::mOutputPar [protected]

input parameter

Parameter* iso::flock::ParameterScaleBehavior::mMinInPar [protected]

output parameter

Parameter* iso::flock::ParameterScaleBehavior::mMaxInPar [protected]

minimum input value parameter (internal)

Parameter* iso::flock::ParameterScaleBehavior::mMinOutPar [protected]

maximum input value parameter (internal)

Parameter* iso::flock::ParameterScaleBehavior::mMaxOutPar [protected]

minimum output value parameter (internal)

---

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

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

---