org.volante.abm.example

Class GiveUpGiveInAllocationModel

java.lang.Object

org.volante.abm.example.SimpleAllocationModel

org.volante.abm.example.GiveUpGiveInAllocationModel

All Implemented Interfaces:

AllocationModel, CellVolatilityMessenger, GivingInStatisticsMessenger, TakeoverMessenger, Initialisable, Displayable

Direct Known Subclasses:

BestProductionFirstGiveUpGiveInAllocationModel

public class GiveUpGiveInAllocationModel
extends SimpleAllocationModel
implements TakeoverMessenger, GivingInStatisticsMessenger

A very simple kind of allocation. Any abandoned cells get the most competitive agent assigned to them.

Nested Class Summary

Nested classes/interfaces inherited from interface org.volante.abm.models.AllocationModel

AllocationModel.AllocationDisplay

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelData	data
String	numCells The number of cells a single agent (type) can search over to find maximum competitiveness
protected int	numSearchedCells
String	numTakeovers The number of times an agent (type) is selected for a take over (i.e.
int	numTakeoversDerived
String	percentageCells Alternative to numCells: specify the percentage of entire cells in the region a single agent (type) searches over.
String	percentageTakeOvers Alternative to numTakeovers: specify the percentage of take overs per single agent (type).
protected Cell	perfectCell
int	probabilityExponent
protected Set<GivingInStatisticsObserver>	statisticsObserver
protected Set<TakeoverObserver>	takeoverObserver
AllocationTryToComeInMode	tryToComeInMode

Fields inherited from class org.volante.abm.example.SimpleAllocationModel

cellVolatilityObserver, networkNullErrorOccurred

Constructor Summary

Constructors

Constructor and Description
GiveUpGiveInAllocationModel()

Method Summary

Modifier and Type	Method and Description
void	allocateLand(Region r) Creates a copy of the best performing potential agent on each empty cell
void	initialise(ModelData data, RunInfo info, Region r)
void	registerGivingInStatisticOberserver(GivingInStatisticsObserver observer)
void	registerTakeoverOberserver(TakeoverObserver observer)
void	tryToComeIn(PotentialAgent a, Region r) Tries to create one of the given agents if it can take over a cell

Methods inherited from class org.volante.abm.example.SimpleAllocationModel

getDisplay, registerCellVolatilityOberserver

Methods inherited from class java.lang.Object

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

Field Detail

numCells

public String numCells

The number of cells a single agent (type) can search over to find maximum competitiveness

numSearchedCells

protected int numSearchedCells

percentageCells

public String percentageCells

Alternative to numCells: specify the percentage of entire cells in the region a single agent (type) searches over.

numTakeovers

public String numTakeovers

The number of times an agent (type) is selected for a take over (i.e. performing the above no. of searches for a cell)

tryToComeInMode

public AllocationTryToComeInMode tryToComeInMode

percentageTakeOvers

public String percentageTakeOvers

Alternative to numTakeovers: specify the percentage of take overs per single agent (type).

numTakeoversDerived

public int numTakeoversDerived

probabilityExponent

public int probabilityExponent

perfectCell

protected Cell perfectCell

data

protected ModelData data

takeoverObserver

protected Set<TakeoverObserver> takeoverObserver

statisticsObserver

protected Set<GivingInStatisticsObserver> statisticsObserver

Constructor Detail

GiveUpGiveInAllocationModel

public GiveUpGiveInAllocationModel()

Method Detail

initialise

public void initialise(ModelData data,
                       RunInfo info,
                       Region r)

Specified by:

initialise in interface Initialisable

Overrides:

initialise in class SimpleAllocationModel

Parameters:

data - model data

info - run information

r - region the initialisable object belongs to

allocateLand

public void allocateLand(Region r)

Creates a copy of the best performing potential agent on each empty cell

Specified by:

allocateLand in interface AllocationModel

Overrides:

allocateLand in class SimpleAllocationModel

tryToComeIn

public void tryToComeIn(PotentialAgent a,
                        Region r)

Tries to create one of the given agents if it can take over a cell

Parameters:

a -

r -

registerTakeoverOberserver

public void registerTakeoverOberserver(TakeoverObserver observer)

Specified by:

registerTakeoverOberserver in interface TakeoverMessenger

registerGivingInStatisticOberserver

public void registerGivingInStatisticOberserver(GivingInStatisticsObserver observer)

Specified by:

registerGivingInStatisticOberserver in interface GivingInStatisticsMessenger