rescuecore2.score

Class AbstractScoreFunction

java.lang.Object

rescuecore2.score.AbstractScoreFunction

All Implemented Interfaces:

ScoreFunction

Direct Known Subclasses:

BuildingDamageScoreFunction, CiviliansAliveScoreFunction, CompositeScoreFunction, ConstantScoreFunction, DelegatingScoreFunction, DiscoveryScoreFunction, DistanceTravelledScoreFunction, HealthScoreFunction

public abstract class AbstractScoreFunction
extends java.lang.Object
implements ScoreFunction

Abstract base class for a score function.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScoreFunction(java.lang.String name) Construct an AbstractScoreFunction.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of this score function.
void	initialise(WorldModel<? extends Entity> world, Config config) Initialise this score function.
void	setName(java.lang.String newName) Change the name of this score function.
java.lang.String	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

Constructor Detail

AbstractScoreFunction

protected AbstractScoreFunction(java.lang.String name)

Construct an AbstractScoreFunction.

Parameters:

name - The name of this function.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ScoreFunction

Get the name of this score function.

Specified by:

getName in interface ScoreFunction

Returns:

The name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

Parameters:

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

config - The system configuration.

setName

public void setName(java.lang.String newName)

Change the name of this score function.

Parameters:

newName - The new name.