org.volante.abm.institutions

Interface Institution

All Superinterfaces:

Initialisable

All Known Implementing Classes:

AbstractInstitution, CapitalDynamicsInstitution, DefaultInstitution, InnovativeInstitution, Institutions, RepeatingInnovativeInstitution

public interface Institution
extends Initialisable

Method Summary

Modifier and Type	Method and Description
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.
boolean	isAllowed(PotentialAgent agent, Cell location) Determines whether this agent is forbidden from occupying that cell according to this institution
void	update() Called at the start of each tick to allow this institution to perform any internal updates necessary.

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

initialise

Method Detail

adjustCapitals

void adjustCapitals(Cell c)

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

Parameters:

c -

adjustCompetitiveness

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.

Parameters:

agent -

location -

provision -

competitiveness -

Returns:

adjusted competitiveness

isAllowed

boolean isAllowed(PotentialAgent agent,
                  Cell location)

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

Parameters:

agent -

location -

Returns:

true if the agent is allowed to occupy the given cell

update

void update()

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