org.volante.abm.data

Class Region

java.lang.Object

org.volante.abm.data.Region

All Implemented Interfaces:

Regions, PreTickAction, TickAction, Initialisable

public class Region
extends Object
implements Regions, PreTickAction

Constructor Summary

Constructors

Constructor and Description
Region()
Region(AllocationModel allocation, CompetitivenessModel competition, DemandModel demand, Set<PotentialAgent> potential, Cell... initialCells)
Region(Cell... initialCells)
Region(Collection<Cell> initialCells)

Method Summary

Modifier and Type	Method and Description
void	addCell(Cell c)
void	addPotentialAgents(Collection<PotentialAgent> agents)
void	cellsCreated() Called after all cells in the region have been created, to allow building a table of them
void	cleanupAgents()
boolean	doesRequireEffectiveCapitalData()
Collection<Agent>	getAgents()
Iterable<Agent>	getAllAgents()
Iterable<Cell>	getAllCells()
AllocationModel	getAllocationModel()
Iterable<PotentialAgent>	getAllPotentialAgents()
Iterable<Region>	getAllRegions()
Collection<Cell>	getAvailable()
Cell	getCell(int x, int y) Returns the cell with the given x and y coordinates.
Collection<Cell>	getCells()
CompetitivenessModel	getCompetitionModel() Deprecated.
double	getCompetitiveness(Cell c) Gets the competitiveness of the cell's current production for the current demand model and levels of demand
double	getCompetitiveness(PotentialAgent agent, Cell c) Gets the competitiveness of the given services on the given cell for the current demand model and level of demand
DemandModel	getDemandModel()
Extent	getExtent()
com.vividsolutions.jts.geom.GeometryFactory	getGeoFactory()
repast.simphony.space.gis.Geography<Object>	getGeography()
RegionHelper	getHelper(Object id)
String	getID()
InnovationRegistry	getInnovationRegistry()
Institutions	getInstitutions()
ModelData	getModelData()
de.cesr.more.basic.network.MoreNetwork<SocialAgent,de.cesr.more.basic.edge.MoreEdge<SocialAgent>>	getNetwork()
de.cesr.more.building.network.MoreNetworkService<SocialAgent,? extends de.cesr.more.basic.edge.MoreEdge<SocialAgent>>	getNetworkService()
int	getNumCells()
Map<String,String>	getPeristerContextExtra()
Collection<PotentialAgent>	getPotentialAgents()
RegionalRandom	getRandom()
RunInfo	getRinfo()
double	getUnadjustedCompetitiveness(Cell c) Just used for displays and checking, so see the effect without institutions
double	getUnadjustedCompetitiveness(PotentialAgent agent, Cell c) Just used for displays and checking to see the effect without institutions
double	getUnadjustedCompetitiveness(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)
boolean	hasCompetitivenessAdjustingInstitution()
boolean	hasInstitutions()
void	initialise(ModelData data, RunInfo info, Region r) Sets of the Region from a ModelData.
boolean	isSkipInitialAllocation()
void	makeUnmanagedCellsAvailable() Sets all of the unmanaged cells to be available.
void	perceiveSocialNetwork()
void	preTick()
RegionHelper	registerHelper(Object id, RegionHelper rHelper)
void	removeAgent(Agent a)
void	setAllocationModel(AllocationModel d)
void	setAvailable(Cell c) Deprecated.
void	setCompetitivenessModel(CompetitivenessModel d)
void	setDemandModel(DemandModel d)
void	setHasCompetitivenessAdjustingInstitution()
void	setID(String id)
void	setInitialOwnership(Agent a, Cell... cells) Similar to setOwnership, but doesn't assume that anything is working yet.
void	setInstitutions(Institutions inst)
void	setNetwork(de.cesr.more.basic.network.MoreNetwork<SocialAgent,de.cesr.more.basic.edge.MoreEdge<SocialAgent>> network)
void	setNetworkService(de.cesr.more.building.network.MoreNetworkService<SocialAgent,? extends de.cesr.more.basic.edge.MoreEdge<SocialAgent>> networkService) Sets the network service.
void	setOwnership(Agent a, Cell... cells) Sets the ownership of all the cells to the given agent Adds the agent to the region, removes any agents with no cells left
void	setRequiresEffectiveCapitalData()
void	setSkipInitialAllocation(boolean skipInitialAllocation)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Region

public Region()

Region

public Region(AllocationModel allocation,
              CompetitivenessModel competition,
              DemandModel demand,
              Set<PotentialAgent> potential,
              Cell... initialCells)

Region

public Region(Cell... initialCells)

Region

public Region(Collection<Cell> initialCells)

Method Detail

getInnovationRegistry

public InnovationRegistry getInnovationRegistry()

Returns:

the innovationRegistry

getRandom

public RegionalRandom getRandom()

Returns:

the random

getGeoFactory

public com.vividsolutions.jts.geom.GeometryFactory getGeoFactory()

Returns:

the geoFactory

getGeography

public repast.simphony.space.gis.Geography<Object> getGeography()

Returns:

the geography

getRinfo

public RunInfo getRinfo()

Returns:

the rinfo

getNetworkService

public de.cesr.more.building.network.MoreNetworkService<SocialAgent,? extends de.cesr.more.basic.edge.MoreEdge<SocialAgent>> getNetworkService()

Returns:

the networkService

setNetworkService

public void setNetworkService(de.cesr.more.building.network.MoreNetworkService<SocialAgent,? extends de.cesr.more.basic.edge.MoreEdge<SocialAgent>> networkService)

Sets the network service.

Parameters:

networkService - the networkService to set

getNetwork

public de.cesr.more.basic.network.MoreNetwork<SocialAgent,de.cesr.more.basic.edge.MoreEdge<SocialAgent>> getNetwork()

Returns:

the network

setNetwork

public void setNetwork(de.cesr.more.basic.network.MoreNetwork<SocialAgent,de.cesr.more.basic.edge.MoreEdge<SocialAgent>> network)

Parameters:

network - the network to set

perceiveSocialNetwork

public void perceiveSocialNetwork()

initialise

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

Sets of the Region from a ModelData. Currently just initialises each cell in the region

Specified by:

initialise in interface Initialisable

Parameters:

data -

info - run information

r - region the initialisable object belongs to

Throws:

Exception

getAllocationModel

public AllocationModel getAllocationModel()

getCompetitionModel

@Deprecated
public CompetitivenessModel getCompetitionModel()

Deprecated.

getDemandModel

public DemandModel getDemandModel()

setDemandModel

public void setDemandModel(DemandModel d)

setAllocationModel

public void setAllocationModel(AllocationModel d)

setCompetitivenessModel

public void setCompetitivenessModel(CompetitivenessModel d)

addPotentialAgents

public void addPotentialAgents(Collection<PotentialAgent> agents)

addCell

public void addCell(Cell c)

getCells

public Collection<Cell> getCells()

getAvailable

public Collection<Cell> getAvailable()

setAvailable

@Deprecated
public void setAvailable(Cell c)

Deprecated.

getAgents

public Collection<Agent> getAgents()

getPotentialAgents

public Collection<PotentialAgent> getPotentialAgents()

removeAgent

public void removeAgent(Agent a)

cleanupAgents

public void cleanupAgents()

getAllRegions

public Iterable<Region> getAllRegions()

Specified by:

getAllRegions in interface Regions

getAllAgents

public Iterable<Agent> getAllAgents()

Specified by:

getAllAgents in interface Regions

getAllCells

public Iterable<Cell> getAllCells()

Specified by:

getAllCells in interface Regions

getAllPotentialAgents

public Iterable<PotentialAgent> getAllPotentialAgents()

Specified by:

getAllPotentialAgents in interface Regions

getCompetitiveness

public double getCompetitiveness(PotentialAgent agent,
                                 Cell c)

Gets the competitiveness of the given services on the given cell for the current demand model and level of demand

Parameters:

agent -

c -

Returns:

competitiveness for the given potential agent on the given cell

getUnadjustedCompetitiveness

public double getUnadjustedCompetitiveness(PotentialAgent agent,
                                           Cell c)

Just used for displays and checking to see the effect without institutions

Parameters:

agent -

c -

Returns:

unadjusted competitiveness for the given potential agent on the given cell

getCompetitiveness

public double getCompetitiveness(Cell c)

Gets the competitiveness of the cell's current production for the current demand model and levels of demand

Parameters:

c -

Returns:

get competitiveness of given cell

getUnadjustedCompetitiveness

public double getUnadjustedCompetitiveness(Cell c)

Just used for displays and checking, so see the effect without institutions

Parameters:

c -

Returns:

unadjusted competitiveness for the given cell

getUnadjustedCompetitiveness

public double getUnadjustedCompetitiveness(com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply)

setOwnership

public void setOwnership(Agent a,
                         Cell... cells)

Sets the ownership of all the cells to the given agent Adds the agent to the region, removes any agents with no cells left

Parameters:

a -

cells -

setInitialOwnership

public void setInitialOwnership(Agent a,
                                Cell... cells)

Similar to setOwnership, but doesn't assume that anything is working yet. Useful for adding an initial population of agents

Parameters:

a -

cells -

makeUnmanagedCellsAvailable

public void makeUnmanagedCellsAvailable()

Sets all of the unmanaged cells to be available. Bit of a hack

getID

public String getID()

Specified by:

getID in interface Regions

setID

public void setID(String id)

getExtent

public Extent getExtent()

Specified by:

getExtent in interface Regions

cellsCreated

public void cellsCreated()

Called after all cells in the region have been created, to allow building a table of them

getCell

public Cell getCell(int x,
                    int y)

Returns the cell with the given x and y coordinates. Returns null if no cells are present or the table has not been built yet.

Parameters:

x -

y -

Returns:

cell of given coordinates

getNumCells

public int getNumCells()

Specified by:

getNumCells in interface Regions

hasInstitutions

public boolean hasInstitutions()

doesRequireEffectiveCapitalData

public boolean doesRequireEffectiveCapitalData()

hasCompetitivenessAdjustingInstitution

public boolean hasCompetitivenessAdjustingInstitution()

setRequiresEffectiveCapitalData

public void setRequiresEffectiveCapitalData()

setHasCompetitivenessAdjustingInstitution

public void setHasCompetitivenessAdjustingInstitution()

getInstitutions

public Institutions getInstitutions()

setInstitutions

public void setInstitutions(Institutions inst)

getModelData

public ModelData getModelData()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

preTick

public void preTick()

Specified by:

preTick in interface PreTickAction

See Also:

PreTickAction.preTick()

registerHelper

public RegionHelper registerHelper(Object id,
                                   RegionHelper rHelper)

Parameters:

id -

rHelper -

Returns:

see HashMap.put(Object, Object)

getHelper

public RegionHelper getHelper(Object id)

Parameters:

id -

Returns:

region helper with given ID

getPeristerContextExtra

public Map<String,String> getPeristerContextExtra()

isSkipInitialAllocation

public boolean isSkipInitialAllocation()

setSkipInitialAllocation

public void setSkipInitialAllocation(boolean skipInitialAllocation)