org.volante.abm.institutions

Class Institutions

java.lang.Object

org.volante.abm.institutions.Institutions

All Implemented Interfaces:

Institution, PreTickAction, TickAction, Initialisable

public class Institutions
extends Object
implements Institution, PreTickAction

Constructor Summary

Constructors

Constructor and Description
Institutions()

Method Summary

Modifier and Type	Method and Description
void	addInstitution(Institution i)
void	adjustCapitals(Cell c) Allows the institution to adjust the effective capitals present in the cell
double	adjustCompetitiveness(PotentialAgent agent, Cell location, com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> provision, double competitiveness) When given an agent, a cell and the level of (potential) provision, adjusts the competitiveness level Must be able to deal with the agent being null if the cell is unoccupied.
void	initialise(ModelData data, RunInfo info, Region extent)
boolean	isAllowed(PotentialAgent a, Cell c) Determines whether this agent is forbidden from occupying that cell according to this institution
void	preTick()
void	update() Called at the start of each tick to allow this institution to perform any internal updates necessary.
void	updateCapitals()

Methods inherited from class java.lang.Object

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

Constructor Detail

Institutions

public Institutions()

Method Detail

addInstitution

public void addInstitution(Institution i)

isAllowed

public boolean isAllowed(PotentialAgent a,
                         Cell c)

Description copied from interface: Institution

Determines whether this agent is forbidden from occupying that cell according to this institution

Specified by:

isAllowed in interface Institution

Returns:

true if the agent is allowed to occupy the given cell

adjustCapitals

public void adjustCapitals(Cell c)

Description copied from interface: Institution

Allows the institution to adjust the effective capitals present in the cell

Specified by:

adjustCapitals in interface Institution

adjustCompetitiveness

public double adjustCompetitiveness(PotentialAgent agent,
                                    Cell location,
                                    com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> provision,
                                    double competitiveness)

Description copied from interface: Institution

When given an agent, a cell and the level of (potential) provision, adjusts the competitiveness level Must be able to deal with the agent being null if the cell is unoccupied.

Specified by:

adjustCompetitiveness in interface Institution

Returns:

adjusted competitiveness

See Also:

Institution.adjustCompetitiveness(org.volante.abm.agent.PotentialAgent, org.volante.abm.data.Cell, com.moseph.modelutils.fastdata.UnmodifiableNumberMap, double)

update

public void update()

Description copied from interface: Institution

Called at the start of each tick to allow this institution to perform any internal updates necessary.

Specified by:

update in interface Institution

updateCapitals

public void updateCapitals()

See Also:

DefaultSchedule.tick()

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

preTick

public void preTick()

Specified by:

preTick in interface PreTickAction

See Also:

PreTickAction.preTick()