org.volante.abm.institutions

Class AbstractInstitution

java.lang.Object

org.volante.abm.institutions.AbstractInstitution

All Implemented Interfaces:

Institution, Initialisable

Direct Known Subclasses:

CapitalDynamicsInstitution, DefaultInstitution, InnovativeInstitution

public class AbstractInstitution
extends Object
implements Institution

AbstractInstitution - provides null implementations of all methods to provide a base for creating new institutions when only some methods are necessary

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelData	modelData
protected Region	region
protected RunInfo	rInfo

Constructor Summary

Constructors

Constructor and Description
AbstractInstitution()

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	update() Called at the start of each tick to allow this institution to perform any internal updates necessary.

Methods inherited from class java.lang.Object

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

Field Detail

modelData

protected ModelData modelData

rInfo

protected RunInfo rInfo

region

protected Region region

Constructor Detail

AbstractInstitution

public AbstractInstitution()

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

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

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

Returns:

true if the agent is allowed to occupy the given cell

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

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