org.volante.abm.models

Interface DemandModel

All Superinterfaces:

Displayable, Initialisable

All Known Implementing Classes:

RegionalDemandModel, StaticPerCellDemandModel

public interface DemandModel
extends Initialisable, Displayable

Models the allocation and satisfaction of demand

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DemandModel.DemandDisplay

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
DemandModel.DemandDisplay	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	updateSupply() Called after all agent changes have been done, and production has been updated.

Methods inherited from interface org.volante.abm.serialization.Initialisable

initialise

Method Detail

getDemand

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

Parameters:

c -

Returns:

demand map fro given cell

getDemand

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

Returns the level of demand for the Region

Returns:

demand map for entire region

getResidualDemand

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

The spatialised demand for a single cell

Parameters:

c -

Returns:

residual demand map for given cell

getResidualDemand

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

Returns the level of residual demand for the region

Returns:

residual demand map for entire region

getMarginalUtilities

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

Returns:

marginal utilities map

agentChange

void agentChange(Cell c)

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

Parameters:

c -

updateSupply

void updateSupply()

Called after all agent changes have been done, and production has been updated. A good place to recalculate residual demand etc.

getSupply

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

getDisplay

DemandModel.DemandDisplay getDisplay()

Specified by:

getDisplay in interface Displayable