org.volante.abm.institutions

Class DefaultInstitution

java.lang.Object

org.volante.abm.institutions.AbstractInstitution

org.volante.abm.institutions.DefaultInstitution

All Implemented Interfaces:

Institution, Initialisable

public class DefaultInstitution
extends AbstractInstitution

Field Summary

Fields inherited from class org.volante.abm.institutions.AbstractInstitution

modelData, region, rInfo

Constructor Summary

Constructors

Constructor and Description
DefaultInstitution()

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.
void	initialise(ModelData data, RunInfo info, Region extent)
boolean	isAllowed(PotentialAgent agent, Cell location) Determines whether this agent is forbidden from occupying that cell according to this institution
void	setAdjustment(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> s)
void	setSubsidies(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> s)
void	setSubsidy(PotentialAgent a, double value)

Methods inherited from class org.volante.abm.institutions.AbstractInstitution

update

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInstitution

public DefaultInstitution()

Method Detail

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

Overrides:

adjustCapitals in class AbstractInstitution

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

Overrides:

adjustCompetitiveness in class AbstractInstitution

Returns:

adjusted competitiveness

isAllowed

public boolean isAllowed(PotentialAgent agent,
                         Cell location)

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

Overrides:

isAllowed in class AbstractInstitution

Returns:

true if the agent is allowed to occupy the given cell

setAdjustment

public void setAdjustment(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Capital> s)

setSubsidies

public void setSubsidies(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> s)

setSubsidy

public void setSubsidy(PotentialAgent a,
                       double value)

initialise

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

Specified by:

initialise in interface Initialisable

Overrides:

initialise in class AbstractInstitution

Parameters:

data - model data

info - run information

extent - region the initialisable object belongs to

Throws:

Exception