SpawnConditions

About the SpawnConditions class

The WaveBlocks Project

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012 R. Bourquin @license: Modified BSD License

Class documentation

The WaveBlocks Project

This file contains some spawning conditions (‘oracles’) which can be used to trigger spawning of wavepackets.

All oracles O get called with 3 parameters:

O(packet, component, environment)

where ‘packet’ is the packet we currectly focus on and ‘component’ is the component we investigate for spawning. The third parameter ‘environment’ is the ‘Spawn*Propagator’ instance calling the oracle. This allows access to further data.

To use a certain oracle just write

spawn_condition = ‘oracle_class_name’

in the simulation configuration file.

@author: R. Bourquin @copyright: Copyright (C) 2011, 2012 R. Bourquin @license: Modified BSD License

class SpawnConditions.SpawnCondition(parameters, env)

This class in the base class for all spawn conditions.

check_condition(packet, component, env)

The condition to check. Subclasses have to implement the condition in this method.

Parameters:

• packet (A Wavepacket instance.) – The wavepacket containing the data.
• component (An integer.) – The component we analyze.
• env (A Propagator subclass instance.) – The caller environment.