org.volante.abm.example

Class StaticPerCellDemandModel

java.lang.Object

org.volante.abm.example.StaticPerCellDemandModel

All Implemented Interfaces:

DemandModel, Initialisable, Displayable

public class StaticPerCellDemandModel
extends Object
implements DemandModel

Keeps maps for demands and residuals with keys for each cell.

Nested Class Summary

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

DemandModel.DemandDisplay

Constructor Summary

Constructors

Constructor and Description
StaticPerCellDemandModel()

Method Summary

Modifier and Type	Method and Description
void	agentChange(Cell c) Called when an agent changes on a cell, to allow updating on agent changes i.e.
com.moseph.modelutils.fastdata.DoubleMap<Service>	getDemand() Returns the level of demand for the Region
com.moseph.modelutils.fastdata.DoubleMap<Service>	getDemand(Cell c) Should be called to get the level of demand in a particular cell This can include any regional demand
StaticPerCellDemandDisplay	getDisplay()
com.moseph.modelutils.fastdata.DoubleMap<Service>	getMarginalUtilities() Gets the marginal utility of producing a unit of each service at the current supply levels Uses the competitiveness model, but ignores cell/agent adjustments
com.moseph.modelutils.fastdata.DoubleMap<Service>	getResidualDemand() Returns the level of residual demand for the region
com.moseph.modelutils.fastdata.DoubleMap<Service>	getResidualDemand(Cell c) The spatialised demand for a single cell
com.moseph.modelutils.fastdata.DoubleMap<Service>	getSupply()
void	initialise(ModelData data, RunInfo info, Region r)
void	setDemand(Cell c, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> dem)
void	setResidual(Cell c, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> res)
void	updateSupply() Do nothing
void	updateSupply(Cell c)

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticPerCellDemandModel

public StaticPerCellDemandModel()

Method Detail

initialise

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

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

r - region the initialisable object belongs to

getDemand

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

Description copied from interface: DemandModel

Returns the level of demand for the Region

Specified by:

getDemand in interface DemandModel

Returns:

demand map for entire region

getSupply

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

Specified by:

getSupply in interface DemandModel

getMarginalUtilities

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

Description copied from interface: DemandModel

Gets the marginal utility of producing a unit of each service at the current supply levels Uses the competitiveness model, but ignores cell/agent adjustments

Specified by:

getMarginalUtilities in interface DemandModel

Returns:

marginal utilities map

getResidualDemand

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

Description copied from interface: DemandModel

Returns the level of residual demand for the region

Specified by:

getResidualDemand in interface DemandModel

Returns:

residual demand map for entire region

getDemand

public com.moseph.modelutils.fastdata.DoubleMap<Service> getDemand(Cell c)

Description copied from interface: DemandModel

Should be called to get the level of demand in a particular cell This can include any regional demand

Specified by:

getDemand in interface DemandModel

Returns:

demand map fro given cell

getResidualDemand

public com.moseph.modelutils.fastdata.DoubleMap<Service> getResidualDemand(Cell c)

Description copied from interface: DemandModel

The spatialised demand for a single cell

Specified by:

getResidualDemand in interface DemandModel

Returns:

residual demand map for given cell

agentChange

public void agentChange(Cell c)

Description copied from interface: DemandModel

Called when an agent changes on a cell, to allow updating on agent changes i.e. as demand gets satisfied through agent change

Specified by:

agentChange in interface DemandModel

setResidual

public void setResidual(Cell c,
                        com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> res)

setDemand

public void setDemand(Cell c,
                      com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> dem)

updateSupply

public void updateSupply(Cell c)

updateSupply

public void updateSupply()

Do nothing

Specified by:

updateSupply in interface DemandModel

getDisplay

public StaticPerCellDemandDisplay getDisplay()

Specified by:

getDisplay in interface DemandModel

Specified by:

getDisplay in interface Displayable