rescuecore2.score

Class CompositeScoreFunction

java.lang.Object

rescuecore2.score.AbstractScoreFunction

rescuecore2.score.CompositeScoreFunction

All Implemented Interfaces:

ScoreFunction

Direct Known Subclasses:

CumulativeScoreFunction, MultiplicativeScoreFunction, WeightedScoreFunction

public abstract class CompositeScoreFunction
extends AbstractScoreFunction

A score function that applies some function to the scores of a set of child score functions.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<ScoreFunction>	children The child score functions.

Constructor Summary

Constructors

Constructor and Description
CompositeScoreFunction(java.lang.String name) Create a CompositeScoreFunction with no children.
CompositeScoreFunction(java.lang.String name, java.util.Collection<ScoreFunction> c) Create a CompositeScoreFunction with a collection of children.
CompositeScoreFunction(java.lang.String name, ScoreFunction... c) Create a CompositeScoreFunction with a collection of children.

Method Summary

Modifier and Type	Method and Description
void	addChildFunction(ScoreFunction child) Add a child score function.
void	addChildFunctions(java.util.Collection<ScoreFunction> c) Add a collection of child score functions.
void	addChildFunctions(ScoreFunction... c) Add a collection of child score functions.
java.util.Set<ScoreFunction>	getChildFunctions() Get all the child functions.
void	initialise(WorldModel<? extends Entity> world, Config config) Initialise this score function.
void	removeChildFunction(ScoreFunction child) Remove a child score function.
void	removeChildFunctions(java.util.Collection<ScoreFunction> c) Remove a collection of child score functions.
void	removeChildFunctions(ScoreFunction... c) Remove a collection of child score functions.

Methods inherited from class rescuecore2.score.AbstractScoreFunction

getName, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface rescuecore2.score.ScoreFunction

score

Field Detail

children

protected java.util.Set<ScoreFunction> children

The child score functions.

Constructor Detail

CompositeScoreFunction

public CompositeScoreFunction(java.lang.String name)

Create a CompositeScoreFunction with no children.

Parameters:

name - The name of this function.

CompositeScoreFunction

public CompositeScoreFunction(java.lang.String name,
                              java.util.Collection<ScoreFunction> c)

Create a CompositeScoreFunction with a collection of children.

Parameters:

name - The name of this function.

c - The child score functions.

CompositeScoreFunction

public CompositeScoreFunction(java.lang.String name,
                              ScoreFunction... c)

Create a CompositeScoreFunction with a collection of children.

Parameters:

name - The name of this function.

c - The child score functions.

Method Detail

addChildFunction

public void addChildFunction(ScoreFunction child)

Add a child score function.

Parameters:

child - The child function to add.

addChildFunctions

public final void addChildFunctions(java.util.Collection<ScoreFunction> c)

Add a collection of child score functions.

Parameters:

c - The child functions to add.

addChildFunctions

public final void addChildFunctions(ScoreFunction... c)

Add a collection of child score functions.

Parameters:

c - The child functions to add.

removeChildFunction

public void removeChildFunction(ScoreFunction child)

Remove a child score function.

Parameters:

child - The child function to remove.

removeChildFunctions

public final void removeChildFunctions(java.util.Collection<ScoreFunction> c)

Remove a collection of child score functions.

Parameters:

c - The child functions to remove.

removeChildFunctions

public final void removeChildFunctions(ScoreFunction... c)

Remove a collection of child score functions.

Parameters:

c - The child functions to remove.

initialise

public void initialise(WorldModel<? extends Entity> world,
                       Config config)

Description copied from interface: ScoreFunction

Initialise this score function.

Specified by:

initialise in interface ScoreFunction

Overrides:

initialise in class AbstractScoreFunction

Parameters:

world - The state of the world at the start of the simulation.

config - The system configuration.

getChildFunctions

public java.util.Set<ScoreFunction> getChildFunctions()

Get all the child functions.

Returns:

All child functions.