Territory

java.lang.Object
- starvationevasion.sim.Territory

Direct Known Subclasses:: Region

public class Territory
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

static MapConverter converter

Fields
Modifier and Type	Field and Description
`static MapConverter`	`converter`

Constructor Summary

Constructors
Constructor and Description

Territory(java.lang.String name)
Territory constructor

Constructors
Constructor and Description
`Territory(java.lang.String name)` Territory constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGeographicArea(GeographicArea area)`
`void`	`addLandTile(LandTile tile)`
`int`	`compareTo(java.lang.String territoryName)`
`boolean`	`containsMapPoint(MapPoint mapPoint)` Used to link land tiles to a country.
`MapPoint`	`getCapitolLocation()` returns the point representing the shipping location of that country. (!) note: this method can only be called after the Country's regions have been set.
`long`	`getCropBudget()` Get the total budget for all crops
`long`	`getCropBudget(EnumFood food)` Get the budget for the type of food
`EnumRegion`	`getGameRegion()`
`java.util.ArrayList<GeographicArea>`	`getGeographicBoundary()`
`float`	`getHumanDevelopmentIndex()`
`int`	`getLandFarm(int year)`
`java.util.Collection<LandTile>`	`getLandTiles()`
`int`	`getLandTotal()`
`java.lang.String`	`getName()`
`double`	`getNetCropAvailable(EnumFood crop)` Calculates net crop available using formula from p.
`double`	`getPenaltyValue()`
`int`	`getPopulation(int year)`
`double`	`getTotalCropNeed(int year, EnumFood crop)` Returns how many tons of crop country needs for specified year
`int`	`getUndernourished(int year)`
`void`	`setAverageConversionFactor(float acf)` This Method calculates the initial category adjustment factors along with setting the average conversion factor.
`void`	`setCropBudget(EnumFood food, long budget)`
`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`	`setLandFarm(int year, int squareKm)`
`void`	`setLandTotal(int squareKm)`
`void`	`setMethod(EnumFarmMethod method, int percentage)`
`void`	`setPenaltyValue(double penaltyValue)`
`void`	`setPopulation(int year, int n)`
`void`	`setUndernourished(int year, int people)`
`static java.util.ArrayList<Territory>`	`territoryLoader()` Constructor takes list of country objects that need data from csv file
`java.lang.String`	`toString()`
`void`	`updateYield()` Estimates the initial land used per food type, and the yield.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - converter
```
public static final MapConverter converter
```
- Constructor Detail
  - Territory
```
public Territory(java.lang.String name)
```
    Territory constructor
    
    Parameters:
    
    name - country name
- Method Detail
  - getName
```
public final java.lang.String getName()
```
    Returns:
    
    country name
  - getPopulation
```
public int getPopulation(int year)
```
    Parameters:
    
    year - year in question
    
    Returns:
    
    population in that year
  - getUndernourished
```
public final int getUndernourished(int year)
```
    Returns:
    
    % undernourished at end of the current year of the simulation.
  - getHumanDevelopmentIndex
```
public final float getHumanDevelopmentIndex()
```
    Returns:
    
    % human development index at end of the current year of the simulation.
  - getPenaltyValue
```
public final double getPenaltyValue()
```
  - setPenaltyValue
```
public final void setPenaltyValue(double penaltyValue)
```
  - setUndernourished
```
public final void setUndernourished(int year,
                                    int people)
```
  - setMethod
```
public final void setMethod(EnumFarmMethod method,
                            int percentage)
```
    Parameters:
    
    method - cultivation method (Conventional, Organic or GMO)
    
    percentage - percentage [0, 100] of land cultivated by the given method.
  - setCropNeedPerCapita
```
public void setCropNeedPerCapita(EnumFood crop,
                                 double tonsConsumed,
                                 double percentUndernourished)
```
    Method for calculating and setting crop need
    
    Parameters:
    
    crop - EnumFood
    
    tonsConsumed - 2014 production + imports - exports
    
    percentUndernourished - 2014 % of population undernourished
  - setCropNeedPerCapita
```
public void setCropNeedPerCapita(EnumFood crop,
                                 double tonPerPerson)
```
    Method for setting crop need when already known (e.g., when copying).
    
    Parameters:
    
    crop - EnumFood
    
    tonPerPerson - 2014 ton/person
  - getTotalCropNeed
```
public double getTotalCropNeed(int year,
                               EnumFood crop)
```
    Returns how many tons of crop country needs for specified year
    
    Parameters:
    
    year - year in question
    
    crop - crop in question
    
    Returns:
    
    total tons needed to meet population's need
  - getNetCropAvailable
```
public final double getNetCropAvailable(EnumFood crop)
```
    Calculates net crop available using formula from p. 15 of spec 1.7
    
    Parameters:
    
    crop - crop in question
    
    Returns:
    
    metric tons available
  - setAverageConversionFactor
```
public void setAverageConversionFactor(float acf)
```
    This Method calculates the initial category adjustment factors along with setting the average conversion factor.
    
    Parameters:
    
    acf -
  - setPopulation
```
public void setPopulation(int year,
                          int n)
```
    Parameters:
    
    year - year in question
    
    n - population in that year
  - getGameRegion
```
public EnumRegion getGameRegion()
```
    Returns:
    
    Sets the game region for this unit.
  - updateYield
```
public void updateYield()
```
    Estimates the initial land used per food type, and the yield.
  - setCropBudget
```
public void setCropBudget(EnumFood food,
                          long budget)
```
  - getCropBudget
```
public long getCropBudget(EnumFood food)
```
    Get the budget for the type of food
    
    Parameters:
    
    food - EnumFood
    
    Returns:
    
    current budget of the food
  - getCropBudget
```
public long getCropBudget()
```
    Get the total budget for all crops
    
    Returns:
    
    total budget of all crops for the territory
  - getLandTotal
```
public int getLandTotal()
```
  - setLandTotal
```
public void setLandTotal(int squareKm)
```
  - getLandFarm
```
public int getLandFarm(int year)
```
  - setLandFarm
```
public void setLandFarm(int year,
                        int squareKm)
```
  - getLandTiles
```
public final java.util.Collection<LandTile> getLandTiles()
```
    Returns:
    
    country's collection of 100km2 tiles
  - addLandTile
```
public final void addLandTile(LandTile tile)
```
    Parameters:
    
    tile - LandTile to add to country
  - getCapitolLocation
```
public MapPoint getCapitolLocation()
```
    returns the point representing the shipping location of that country.
    (!) note: this method can only be called after the Country's regions have been set.
    
    Returns:
    
    map point representing the lat and lon location of the Country's capitol.
  - containsMapPoint
```
public boolean containsMapPoint(MapPoint mapPoint)
```
    Used to link land tiles to a country.
    
    Parameters:
    
    mapPoint - mapPoint that is being testing for inclusing
    
    Returns:
    
    true is mapPoint is found inside country.
  - addGeographicArea
```
public void addGeographicArea(GeographicArea area)
```
  - getGeographicBoundary
```
public java.util.ArrayList<GeographicArea> getGeographicBoundary()
```
    Returns:
    
    regions
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(java.lang.String territoryName)
```
  - territoryLoader
```
public static java.util.ArrayList<Territory> territoryLoader()
```
    Constructor takes list of country objects that need data from csv file

Class Territory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

converter

Constructor Detail

Territory

Method Detail

getName

getPopulation

getUndernourished

getHumanDevelopmentIndex

getPenaltyValue

setPenaltyValue

setUndernourished

setMethod

setCropNeedPerCapita

setCropNeedPerCapita

getTotalCropNeed

getNetCropAvailable

setAverageConversionFactor

setPopulation

getGameRegion

updateYield

setCropBudget

getCropBudget

getCropBudget

getLandTotal

setLandTotal

getLandFarm

setLandFarm

getLandTiles

addLandTile

getCapitolLocation

containsMapPoint

addGeographicArea

getGeographicBoundary

toString

compareTo

territoryLoader