org.volante.abm.example

Class RegionalDemandModel

java.lang.Object

org.volante.abm.example.RegionalDemandModel

All Implemented Interfaces:

DemandModel, PostTickAction, PreTickAction, TickAction, Initialisable, Displayable

public class RegionalDemandModel
extends Object
implements DemandModel, PreTickAction, PostTickAction

Model demand entirely at a regional level. Demand is averaged across all cells in the region. When a cell changes, calculate new demand based on the difference from new to old

Nested Class Summary

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

DemandModel.DemandDisplay

Constructor Summary

Constructors

Constructor and Description
RegionalDemandModel()

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
RegionalDemandDisplay	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	postTick()
void	preTick()
void	recalculateResidual() Assigns each cell an equal share of total demand.
void	setDemand(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> dem)
void	updateSupply() Called after all agent changes have been done, and production has been updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionalDemandModel

public RegionalDemandModel()

Method Detail

initialise

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

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

r - region the initialisable object belongs to

Throws:

Exception

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()

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

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

getSupply

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

Specified by:

getSupply in interface DemandModel

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

setDemand

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

updateSupply

public void updateSupply()

Description copied from interface: DemandModel

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

Specified by:

updateSupply in interface DemandModel

recalculateResidual

public void recalculateResidual()

Assigns each cell an equal share of total demand. Calculates total residual and per cell residual by subtracting totalSupply from demand.

preTick

public void preTick()

Specified by:

preTick in interface PreTickAction

postTick

public void postTick()

Specified by:

postTick in interface PostTickAction

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

getDisplay

public RegionalDemandDisplay getDisplay()

Specified by:

getDisplay in interface DemandModel

Specified by:

getDisplay in interface Displayable