ensemble

Interface LifeCycle

All Known Implementing Classes:

Actuator, AmbisonicsAudioEventServer, AmbisonicsAudioOutputReasoning, AudioEventServer, AudioFileInputReasoning, AudioFileInputStateReasoning, AudioFileInputToMemoryReasoning, AudioFileOutputReasoning, AudioFileReasoning, AudioLaw, AudioMemory, AvatarAgent, Comm, CommDirect, CommMessage, CP_Reasoning, DummyEventServer, DummyReasoning, DummySensor, Earscript_Reasoning, EG_Reasoning, EnsembleAgent, EnvironmentAgent, EventHandler, EventMemory, EventServer, GeneratorActuator, JackInputDelayReasoning, JACKInputOnlyReasoning, JackInputPitchDetectionReasoning, JACKInputReasoning, JACKInputToMemoryReasoning, JACKOutputReasoning, JavaInputReasoning, JavaOutputReasoning, KnowledgeBase, Law, ListenerAgent, LM_EnergyEventServer, LM_Environment, LM_FoodActuator, LM_FoodSensor, LM_LifeCycleEventServer, LM_MovementActuator, LM_MovementEventServer, LM_MusicalAgent, LM_Reasoning, LM_SoundActuator, LM_SoundEventServer, LM_SoundSensor, LM_TentacleSensor, LM_World, Memory, MessageEventServer, MessageLaw, MovementEventServer, MovementLaw, MovementReasoning, MultichannelAudioMemory, MusicalAgent, MusicalAgentComponent, PAInputReasoning, PAOutputReasoning, PlayerAgent, PP_FilterZoneReasoning, PP_IntegratedMInstReasoning, PP_IntegratedMInstrumentReasoning, PP_IntPitchTrackingReasoning, PP_ListenerReasoning, PP_MInstrumentReasoning, PP_MovementReasoning, PP_OscMovementReasoning, PP_PeakReasoning, PP_PitchTrackingReasoning, PP_QuadrantReasoning, PP_Reasoning, PP_RecPlayReasoning, PP_SampleReasoning, PP_SingleFilterReasoning, Reasoning, Sensor, World

public interface LifeCycle

The Interface LifeCycle.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure() User-implemented method that configures the component, setting up user parameters and essential properties.
boolean	finit() User-implemented finalization method, called by stop().
Parameters	getParameters() Returns all configured parameters.
boolean	init() User-implemented initialization method, called by start().
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
void	setParameters(Parameters parameters) Framework-implemented method that sets system and user parameters.
boolean	start() Framework-implemented initialization method.
boolean	stop() Framework-implemented finalization method.

Method Detail

configure

boolean configure()

User-implemented method that configures the component, setting up user parameters and essential properties.

Returns:

true, if successful

start

boolean start()

Framework-implemented initialization method.

Returns:

true, if successful

init

boolean init()

User-implemented initialization method, called by start().

Returns:

true, if successful

parameterUpdate

boolean parameterUpdate(java.lang.String name,
                      java.lang.String newValue)

User-implement method called when a parameter has been updated.

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

finit

boolean finit()

User-implemented finalization method, called by stop().

Returns:

true, if successful

stop

boolean stop()

Framework-implemented finalization method.

Returns:

true, if successful

setParameters

void setParameters(Parameters parameters)

Framework-implemented method that sets system and user parameters.

Parameters:

parameters - a Parameters object with all user and system Parameters for this object

getParameters

Parameters getParameters()

Returns all configured parameters.

Returns:

a Parameters object with system and user parameters