org.volante.abm.example

Class SimpleCompetitivenessModel

java.lang.Object

org.volante.abm.example.SimpleCompetitivenessModel

All Implemented Interfaces:

CompetitivenessModel, Initialisable, Displayable

public class SimpleCompetitivenessModel
extends Object
implements CompetitivenessModel

A simple model of competitiveness

Nested Class Summary

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

CompetitivenessModel.CompetitivenessDisplay

Constructor Summary

Constructors

Constructor and Description
SimpleCompetitivenessModel()

Method Summary

Modifier and Type	Method and Description
double	addUpMarginalUtilities(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> residual, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)
double	getCompetitiveness(DemandModel demand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)
double	getCompetitiveness(DemandModel demand, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply, Cell cell)
CompetitivenessModel.CompetitivenessDisplay	getDisplay()
void	initialise(ModelData data, RunInfo info, Region extent)
boolean	isRemoveCurrentLevel()
boolean	isRemoveNegative()
void	setRemoveCurrentLevel(boolean removeCurrentLevel)
void	setRemoveNegative(boolean removeNegative)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCompetitivenessModel

public SimpleCompetitivenessModel()

Method Detail

initialise

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

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

extent - region the initialisable object belongs to

Throws:

Exception

getCompetitiveness

public double getCompetitiveness(DemandModel demand,
                                 com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)

Specified by:

getCompetitiveness in interface CompetitivenessModel

getCompetitiveness

public double getCompetitiveness(DemandModel demand,
                                 com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply,
                                 Cell cell)

Specified by:

getCompetitiveness in interface CompetitivenessModel

addUpMarginalUtilities

public double addUpMarginalUtilities(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> residual,
                                     com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)

Specified by:

addUpMarginalUtilities in interface CompetitivenessModel

isRemoveCurrentLevel

public boolean isRemoveCurrentLevel()

setRemoveCurrentLevel

public void setRemoveCurrentLevel(boolean removeCurrentLevel)

isRemoveNegative

public boolean isRemoveNegative()

setRemoveNegative

public void setRemoveNegative(boolean removeNegative)

getDisplay

public CompetitivenessModel.CompetitivenessDisplay getDisplay()

Specified by:

getDisplay in interface CompetitivenessModel

Specified by:

getDisplay in interface Displayable