starvationevasion.common

Class RegionData

java.lang.Object

starvationevasion.common.RegionData

All Implemented Interfaces:

java.io.Serializable, JSON, Sendable

public class RegionData
extends java.lang.Object
implements Sendable

This structure contains all data of a particular region that the simulator shares with each client via the Server.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface starvationevasion.server.io.JSON

JSON.Parser

Field Summary

Fields

Modifier and Type	Field and Description
int	ethanolProducerTaxCredit This region's current ethanol producer tax credit as an integer percentage from [0 through 100].
int[]	farmArea This region's land area (in square kilometers) being used for farm production of each crop type at the end of the current year.
long[]	foodExported This region's food exported (in metric tons) of each foodType during the current year indexed by EnumFood.ordinal().
long[]	foodImported This region's food exported (in metric tons) of each foodType during the current year indexed by EnumFood.ordinal().
int[]	foodIncome This is the farm income in millions of dollars from to the region's production of each foodType during the past turn (3 years). This includes farm income for food consumed as well as income from exported foods. Note: foodProduced*foodPrice for a given food is the gross income.
long[]	foodProduced This region's production (in metric tons) of each foodType during the past turn (3 years). Index by EnumFood.ordinal()
double	humanDevelopmentIndex This region's Human Development Index at the start of the current year.
int	landArea This region's total land area (in square kilometers).
int	population This region's population (in thousands of people) during the current year.
EnumRegion	region
int	revenueBalance This field is zero for non-player regions.
double	undernourished This region's percent of undernourished people at start of the current year.

Constructor Summary

Constructors

Constructor and Description
RegionData(EnumRegion region)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
void	fromJSON(java.lang.Object doc) Convert String into JSON
java.lang.String	getType()
void	setType(java.lang.String type)
JSONDocument	toJSON() Convert class into json
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

region

public EnumRegion region

revenueBalance

public int revenueBalance

This field is zero for non-player regions. Total player revenue in millions of dollars for the current simulation year. This is the past year's revenue balance plus new taxes earned during the current turn of three years, minus expenses during the current turn of three years.

population

public int population

This region's population (in thousands of people) during the current year.

undernourished

public double undernourished

This region's percent of undernourished people at start of the current year.

humanDevelopmentIndex

public double humanDevelopmentIndex

This region's Human Development Index at the start of the current year.

foodProduced

public long[] foodProduced

This region's production (in metric tons) of each foodType during the past turn (3 years).

Index by EnumFood.ordinal()

foodIncome

public int[] foodIncome

This is the farm income in millions of dollars from to the region's production of each foodType during the past turn (3 years).

This includes farm income for food consumed as well as income from exported foods.

Note: foodProduced*foodPrice for a given food is the gross income. Gross income will always be greater than this field with is the profet (gross less expenses). Note also that different regions have different efficiency levels depending on the crop, climate, infrastructure, tax breaks, and other factors.

Index by EnumFood.ordinal()

foodImported

public long[] foodImported

This region's food exported (in metric tons) of each foodType during the current year indexed by EnumFood.ordinal(). Positive indicates export, negative indicates import.

The region's consumption of for each foodType is:
foodProduced[i]+@link #foodImported}[i]-foodExported[i]

foodExported

public long[] foodExported

This region's food exported (in metric tons) of each foodType during the current year indexed by EnumFood.ordinal(). Positive indicates export, negative indicates import.

The region's consumption of for each foodType is:
foodProduced[i]+@link #foodImported}[i]-foodExported[i]

ethanolProducerTaxCredit

public int ethanolProducerTaxCredit

This region's current ethanol producer tax credit as an integer percentage from [0 through 100]. This percentage of all profits earned by farmers in this region for sale of farm products used in ethanol production is tax deductible.

landArea

public int landArea

This region's total land area (in square kilometers).

farmArea

public int[] farmArea

This region's land area (in square kilometers) being used for farm production of each crop type at the end of the current year.

Constructor Detail

RegionData

public RegionData(EnumRegion region)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Data stored in this structure as a formatted String.

toJSON

public JSONDocument toJSON()

Description copied from interface: JSON

Convert class into json

Specified by:

toJSON in interface JSON

Returns:

JSON representation of class

fromJSON

public void fromJSON(java.lang.Object doc)

Description copied from interface: JSON

Convert String into JSON

Specified by:

fromJSON in interface JSON

Parameters:

doc - object to be converted

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

setType

public void setType(java.lang.String type)

Specified by:

setType in interface Sendable

getType

public java.lang.String getType()

Specified by:

getType in interface Sendable