ensemble.world

Class Law

java.lang.Object

ensemble.world.Law

All Implemented Interfaces:

LifeCycle

Direct Known Subclasses:

AudioLaw, MessageLaw, MovementLaw

public abstract class Law
extends java.lang.Object
implements LifeCycle

The Class Law.

Field Summary

Fields

Modifier and Type	Field and Description
protected Parameters	parameters The parameters.
protected java.lang.String	type The type.
protected World	world The world.

Constructor Summary

Constructors

Constructor and Description
Law()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	changeState(LawState oldState, double instant, LawState newState) Change state.
Parameters	getParameters() Returns all configured parameters.
java.lang.String	getType() Gets the type.
World	getWorld() Gets the world.
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.
void	setType(java.lang.String type) Sets the type.
void	setWorld(World world) Sets the world.
boolean	start() Framework-implemented initialization method.
boolean	stop() Framework-implemented finalization method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ensemble.LifeCycle

configure, finit, init

Field Detail

world

protected World world

The world.

type

protected java.lang.String type

The type.

parameters

protected Parameters parameters

The parameters.

Constructor Detail

Law

public Law()

Method Detail

setWorld

public void setWorld(World world)

Sets the world.

Parameters:

world - the new world

getWorld

public World getWorld()

Gets the world.

Returns:

the world

setType

public void setType(java.lang.String type)

Sets the type.

Parameters:

type - the new type

getType

public java.lang.String getType()

Gets the type.

Returns:

the type

setParameters

public void setParameters(Parameters parameters)

Description copied from interface: LifeCycle

Framework-implemented method that sets system and user parameters.

Specified by:

setParameters in interface LifeCycle

Parameters:

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

getParameters

public Parameters getParameters()

Description copied from interface: LifeCycle

Returns all configured parameters.

Specified by:

getParameters in interface LifeCycle

Returns:

a Parameters object with system and user parameters

start

public boolean start()

Description copied from interface: LifeCycle

Framework-implemented initialization method.

Specified by:

start in interface LifeCycle

Returns:

true, if successful

stop

public boolean stop()

Description copied from interface: LifeCycle

Framework-implemented finalization method.

Specified by:

stop in interface LifeCycle

Returns:

true, if successful

parameterUpdate

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

Description copied from interface: LifeCycle

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

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

changeState

public abstract void changeState(LawState oldState,
               double instant,
               LawState newState)

Change state.

Parameters:

oldState - the old state

instant - the instant

newState - the new state