org.volante.abm.data

Class Cell

java.lang.Object

org.volante.abm.data.Cell

All Implemented Interfaces:

Initialisable

public class Cell
extends Object
implements Initialisable

A generic cell, with levels of baseCapitals, supply and demand for services and residual demand A cell is can be owned by an agent, or by the null agent.

Constructor Summary

Constructors

Constructor and Description
Cell()
Cell(int x, int y)

Method Summary

Modifier and Type	Method and Description
com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital>	getBaseCapitals()
com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital>	getEffectiveCapitals()
com.moseph.modelutils.fastdata.DoubleMap<Service>	getModifiableSupply() Allows for updating of the cell's supply without creating intermediate maps
Agent	getOwner()
String	getOwnerID()
Region	getRegion()
String	getRegionID()
com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service>	getSupply()
int	getX()
int	getY()
void	initEffectiveCapitals()
void	initialise(ModelData data, RunInfo info, Region region)
boolean	isInitialised()
void	registerCellCapitalObserver(CellCapitalObserver observer)
void	removeCellCapitalObserver(CellCapitalObserver observer)
void	resetSupply()
void	setBaseCapitals(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> c)
void	setEffectiveCapitals(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> c) NOTE: When using this method, call Region.setRequiresEffectiveCapitalData()!
void	setOwner(Agent o)
void	setSupply(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> s)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Cell

public Cell()

Cell

public Cell(int x,
            int y)

Method Detail

initialise

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

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

region - region the initialisable object belongs to

getEffectiveCapitals

public com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> getEffectiveCapitals()

getBaseCapitals

public com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> getBaseCapitals()

setBaseCapitals

public void setBaseCapitals(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> c)

setEffectiveCapitals

public void setEffectiveCapitals(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> c)

NOTE: When using this method, call Region.setRequiresEffectiveCapitalData()!

Parameters:

c -

initEffectiveCapitals

public void initEffectiveCapitals()

getOwner

public Agent getOwner()

setOwner

public void setOwner(Agent o)

getOwnerID

public String getOwnerID()

setSupply

public void setSupply(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> s)

getSupply

public com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> getSupply()

getModifiableSupply

public com.moseph.modelutils.fastdata.DoubleMap<Service> getModifiableSupply()

Allows for updating of the cell's supply without creating intermediate maps

Returns:

map of modifiable supply

toString

public String toString()

Overrides:

toString in class Object

resetSupply

public void resetSupply()

getX

public int getX()

getY

public int getY()

getRegionID

public String getRegionID()

getRegion

public Region getRegion()

isInitialised

public boolean isInitialised()

registerCellCapitalObserver

public void registerCellCapitalObserver(CellCapitalObserver observer)

removeCellCapitalObserver

public void removeCellCapitalObserver(CellCapitalObserver observer)