starvationevasion.sim

Class Region

java.lang.Object

starvationevasion.sim.Territory

starvationevasion.sim.Region

public class Region
extends Territory

Region class extends AbstractAgriculturalUnit, includes methods for accessing its fields.

Field Summary

Fields

Modifier and Type	Field and Description
int	ethanolProducerTaxCredit

Fields inherited from class starvationevasion.sim.Territory

converter

Constructor Summary

Constructors

Constructor and Description
Region(EnumRegion region) Territory constructor

Method Summary

Modifier and Type	Method and Description
void	addProduction(int year, EnumFood food, long imports, long exports, long production, long consumption, long area)
void	addTerritory(Territory territory)
void	aggregateTerritoryData(int year) Each region is composed of 1 or more territories.
boolean	containsMapPoint(MapPoint mapPoint) Used to link land tiles to a country.
void	estimateInitialBudget(java.util.List<CropZoneData> cropData) Estimates the initial crop budget for a all of the territoryList in the region by multiplying the territory consumption of the crop by its cost.
void	estimateInitialCropLandArea(java.util.List<CropZoneData> cropData)
void	estimateInitialUSYield() Estimates the initial yield of all US states the US bookkeeping region.
void	estimateInitialYield() Estimates the initial yield of all territoryList in the region.
MapPoint	getCenter()
long	getCropExport(int year, EnumFood food)
long	getCropImport(int year, EnumFood food)
long	getCropProduction(int year, EnumFood food)
EnumRegion	getRegionEnum()
int	getRevenue()
java.util.ArrayList<Territory>	getTerritoryList()
void	setCropNeedPerCapita(EnumFood crop, double tonPerPerson) Method for setting crop need when already known (e.g., when copying).
void	setCropNeedPerCapita(EnumFood crop, double tonsConsumed, double percentUndernourished) Method for calculating and setting crop need
void	updateCropNeed(int year)
void	updateYield(int year) Updates the yield of all territoryList in the region and aggregates the values for the entire region.

Methods inherited from class starvationevasion.sim.Territory

addGeographicArea, addLandTile, compareTo, getCapitolLocation, getCropBudget, getCropBudget, getGameRegion, getGeographicBoundary, getHumanDevelopmentIndex, getLandFarm, getLandTiles, getLandTotal, getName, getNetCropAvailable, getPenaltyValue, getPopulation, getTotalCropNeed, getUndernourished, setAverageConversionFactor, setCropBudget, setLandFarm, setLandTotal, setMethod, setPenaltyValue, setPopulation, setUndernourished, territoryLoader, toString, updateYield

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ethanolProducerTaxCredit

public int ethanolProducerTaxCredit

Constructor Detail

Region

public Region(EnumRegion region)

Territory constructor

Parameters:

region -

Method Detail

addProduction

public void addProduction(int year,
                          EnumFood food,
                          long imports,
                          long exports,
                          long production,
                          long consumption,
                          long area)

getCropProduction

public long getCropProduction(int year,
                              EnumFood food)

getCropImport

public long getCropImport(int year,
                          EnumFood food)

getCropExport

public long getCropExport(int year,
                          EnumFood food)

aggregateTerritoryData

public void aggregateTerritoryData(int year)

Each region is composed of 1 or more territories. This method sets this regions data by aggregating all the region's data. For some data items, such as population, the aggregate is the sum. For other data items the aggregate is weighted average.

getRegionEnum

public EnumRegion getRegionEnum()

getRevenue

public int getRevenue()

addTerritory

public void addTerritory(Territory territory)

Parameters:

territory - Territory to add to region

containsMapPoint

public boolean containsMapPoint(MapPoint mapPoint)

Used to link land tiles to a country.

Overrides:

containsMapPoint in class Territory

Parameters:

mapPoint - mapPoint that is being testing for inclusing

Returns:

true is mapPoint is found inside country.

getTerritoryList

public java.util.ArrayList<Territory> getTerritoryList()

Returns:

regions

estimateInitialUSYield

public void estimateInitialUSYield()

Estimates the initial yield of all US states the US bookkeeping region.

estimateInitialYield

public void estimateInitialYield()

Estimates the initial yield of all territoryList in the region.

updateYield

public void updateYield(int year)

Updates the yield of all territoryList in the region and aggregates the values for the entire region.

updateCropNeed

public void updateCropNeed(int year)

estimateInitialBudget

public void estimateInitialBudget(java.util.List<CropZoneData> cropData)

Estimates the initial crop budget for a all of the territoryList in the region by multiplying the territory consumption of the crop by its cost.

Parameters:

cropData - crop data loaded from "/data/sim/CropData.csv"

estimateInitialCropLandArea

public void estimateInitialCropLandArea(java.util.List<CropZoneData> cropData)

setCropNeedPerCapita

public void setCropNeedPerCapita(EnumFood crop,
                                 double tonsConsumed,
                                 double percentUndernourished)

Method for calculating and setting crop need

Overrides:

setCropNeedPerCapita in class Territory

Parameters:

crop - EnumFood

tonsConsumed - 2014 production + imports - exports

percentUndernourished - 2014 percent of population undernourished

setCropNeedPerCapita

public void setCropNeedPerCapita(EnumFood crop,
                                 double tonPerPerson)

Method for setting crop need when already known (e.g., when copying).

Overrides:

setCropNeedPerCapita in class Territory

Parameters:

crop - EnumFood

tonPerPerson - 2014 ton/person

getCenter

public MapPoint getCenter()