iso::flock::ParameterCombineBehavior Class Reference

combine several input parameters into single output parameter More...

#include <iso_flock_parameter_combine_behavior.h>

Inherits iso::flock::Behavior.

Inheritance diagram for iso::flock::ParameterCombineBehavior:

Inheritance graph
[legend]
Collaboration diagram for iso::flock::ParameterCombineBehavior:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ParameterCombineBehavior (const base::String &pInputParameterString, const base::String &pOutputParameterString)
 create behavior
 ParameterCombineBehavior (Agent *pAgent, const base::String &pBehaviorName, const base::String &pInputParameterString, const base::String &pOutputParameterString) throw (FlockException)
 create behavior
 ~ParameterCombineBehavior ()
 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 * mOutputPar

Detailed Description

combine several input parameters into single output parameter

input parameters into single output parameter

The behavior concatenations all input parameter values into a single output parameter.

Input Parameters:
type: InputParameter1 dim: nD neighbors: ignore
type: InputParameter2 dim: nD neighbors: ignore
etc

Output Parameter:
type: OutputParameter dim: the sum of the dimensions of all input parameters write: replace

Created by Daniel Bisig on 2/7/08.


Constructor & Destructor Documentation

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

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

ParameterCombineBehavior::~ParameterCombineBehavior (  ) 

destructor


Member Function Documentation

Behavior * ParameterCombineBehavior::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 * ParameterCombineBehavior::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 ParameterCombineBehavior::act (  )  [virtual]

perform behavior

Implements iso::flock::Behavior.


Member Data Documentation

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


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 15:28:03 2011 for iso_flock by  doxygen 1.5.1