#include <iso_flock_boundary_wrap_behavior.h>
Inherits iso::flock::Behavior.
Inheritance diagram for iso::flock::BoundaryWrapBehavior:
Public Member Functions | |
BoundaryWrapBehavior (const base::String &pInputParameterString, const base::String &pOutputParameterString) | |
create behavior | |
BoundaryWrapBehavior (Agent *pAgent, const base::String &pBehaviorName, const base::String &pInputParameterString, const base::String &pOutputParameterString) throw (FlockException) | |
create behavior | |
~BoundaryWrapBehavior () | |
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 * | mPositionInPar |
Parameter * | mPositionOutPar |
position parameter (input) | |
Parameter * | mLowerBoundaryPar |
position parameter (output) | |
Parameter * | mUpperBoundaryPar |
lower boundary parameter (internal) |
boundary for Agent 's position
Behavior creates periodic boundary for Agent 's position.
The behavior is normally meant to restrict an Agent 's position to a cubic region
by mirroring the position to the opposite site of the cube whenever it exceeds the cube's boundaries.
Input Parameter:
type: position dim: nD neighbors: ignore
Output Parameter:
type: position dim: nD write: replace
Internal Parameter:
name: xxx_lowerBoundary dim: nD defaultValue: -1.0
name: xxx_upperBoundary dim: nD defaultValue: 1.0
name: xxx_active dim: 1D defaultValue: 1.0
Created by Daniel Bisig on 8/31/07.
BoundaryWrapBehavior::BoundaryWrapBehavior | ( | const base::String & | pInputParameterString, | |
const base::String & | pOutputParameterString | |||
) |
create behavior
pInputParameterString | input parameter string (parameters are space separated) | |
pOutputParameterString | output paramaters are space separated) |
BoundaryWrapBehavior::BoundaryWrapBehavior | ( | Agent * | pAgent, | |
const base::String & | pBehaviorName, | |||
const base::String & | pInputParameterString, | |||
const base::String & | pOutputParameterString | |||
) | throw (FlockException) |
create behavior
pAgent | agent this behavior belongs to | |
pBehaviorName | name of behavior | |
pInputParameterString | input parameter string (parameters are space separated) | |
pOutputParameterString | output paramaters are space separated) |
FlockException | wrong number of type of parameters |
BoundaryWrapBehavior::~BoundaryWrapBehavior | ( | ) |
destructor
Behavior * BoundaryWrapBehavior::create | ( | const base::String & | pBehaviorName, | |
Agent * | pAgent | |||
) | const throw (FlockException) [virtual] |
create copy of behavior
pAgent | agent this behavior belongs to | |
pBehaviorName | name of behavior |
FlockException | wrong number of type of parameters |
Implements iso::flock::Behavior.
Behavior * BoundaryWrapBehavior::create | ( | const base::String & | pInputParameterString, | |
const base::String & | pOutputParameterString | |||
) | const [virtual] |
create copy of behavior
pInputParameterString | input parameter string | |
pOutputParameterString | output parameter string |
Implements iso::flock::Behavior.
void BoundaryWrapBehavior::act | ( | ) | [virtual] |
position parameter (input)
position parameter (output)
lower boundary parameter (internal)