org.volante.abm.data

Class RegionSet

java.lang.Object

org.volante.abm.data.RegionSet

All Implemented Interfaces:

Regions, Initialisable

public class RegionSet
extends Object
implements Regions

Generic set of regions, allowing for multi-scale representation

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Regions>	regions

Constructor Summary

Constructors

Constructor and Description
RegionSet()
RegionSet(Region... regions)

Method Summary

Modifier and Type	Method and Description
void	addRegion(Region r)
Iterable<Agent>	getAllAgents()
Iterable<Cell>	getAllCells()
Iterable<PotentialAgent>	getAllPotentialAgents()
Iterable<Region>	getAllRegions()
Extent	getExtent()
String	getID()
int	getNumCells()
Collection<Regions>	getRegions()
void	initialise(ModelData data, RunInfo info, Region region) Initialisation: Initialises regions and updates extent.
void	setID(String id)

Methods inherited from class java.lang.Object

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

Field Detail

regions

protected Set<Regions> regions

Constructor Detail

RegionSet

public RegionSet()

RegionSet

public RegionSet(Region... regions)

Parameters:

regions - one or several regions

Method Detail

initialise

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

Initialisation: Initialises regions and updates extent.

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

region - region the initialisable object belongs to

Throws:

Exception

See Also:

Initialisable.initialise(org.volante.abm.data.ModelData, org.volante.abm.schedule.RunInfo, org.volante.abm.data.Region)

getAllRegions

public Iterable<Region> getAllRegions()

Specified by:

getAllRegions in interface Regions

See Also:

Regions.getAllRegions()

getAllAgents

public Iterable<Agent> getAllAgents()

Specified by:

getAllAgents in interface Regions

See Also:

Regions.getAllAgents()

getAllCells

public Iterable<Cell> getAllCells()

Specified by:

getAllCells in interface Regions

See Also:

Regions.getAllCells()

getAllPotentialAgents

public Iterable<PotentialAgent> getAllPotentialAgents()

Specified by:

getAllPotentialAgents in interface Regions

See Also:

Regions.getAllPotentialAgents()

addRegion

public void addRegion(Region r)

Parameters:

r -

getRegions

public Collection<Regions> getRegions()

Returns:

getExtent

public Extent getExtent()

Specified by:

getExtent in interface Regions

See Also:

Regions.getExtent()

getID

public String getID()

Specified by:

getID in interface Regions

See Also:

Regions.getID()

setID

public void setID(String id)

Parameters:

id -

getNumCells

public int getNumCells()

Specified by:

getNumCells in interface Regions

See Also:

Regions.getNumCells()