World

java.lang.Object
- controller.World

```
public class World
extends java.lang.Object
```
The World class acts as a communicator between the model and the view packages. It receives the current status of the simulation from model and passes it on to view. Conversely, user input from view is forwarded to model. It also stores all simulation settings.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Integer>>`	`animals`
`private int`	`autorun`
`private int`	`averageGrassDensity`
`private int`	`carnivoreCounter`
`private int`	`herbivoreCounter`
`private int`	`highestGeneration`
`private Humidity`	`humidity`
`private java.util.ArrayList<java.lang.String>`	`news`
`private int`	`nextID`
`private boolean`	`running`
`private int[]`	`size`
`private int`	`startEnergyCarnivores`
`private int`	`startEnergyHerbivores`
`private int`	`startGrassDensity`
`private int`	`startNoCarnivores`
`private int`	`startNoHerbivores`
`private int`	`stopAt`
`private int`	`timelapse`
`private int`	`turn`
`private int`	`waterTiles`
`private static World`	`world`

Constructor Summary

Constructors
Modifier Constructor and Description

private World()
This class implements Singleton, therefore the constructor is private.

Constructors
Modifier	Constructor and Description
`private`	`World()` This class implements Singleton, therefore the constructor is private.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.ArrayList<java.lang.String>`	`collectNews()`
`java.util.HashMap<java.lang.String,java.lang.Integer>`	`getAnimalInfo(int x, int y)` Return information about the animal at the given position as a hash map
`int`	`getAutorun()`
`int`	`getAverageGrassDensity()`
`int`	`getCarnivoreCount()`
`java.util.HashMap<java.lang.String,java.lang.Integer>`	`getDefaultGenome(OccupantType type)` Return a hash map holding all the genome values
`java.util.HashMap<java.lang.String,java.lang.Integer>`	`getFieldInfo(int x, int y)` Return information about the map field at the given position as a hash map
`int`	`getGeneration()`
`int`	`getHerbivoreCount()`
`Humidity`	`getHumidity()`
`static World`	`getInstance()` The Singleton method.
`int`	`getNextID()` Get the next unique animal ID number and increment the counter.
`int[]`	`getSize()`
`int`	`getStartEnergyCarnivores()`
`int`	`getStartEnergyHerbivores()`
`int`	`getStartGrassDensity()`
`int`	`getStartNoCarnivores()`
`int`	`getStartNoHerbivores()`
`int`	`getStopAt()`
`int`	`getTimelapse()`
`int`	`getTurn()`
`int`	`getWaterTiles()`
`void`	`giveNews(java.lang.String message)` Display a news item - calling with null as a parameter resets the news list
`void`	`incGeneration(int n)` Increment the generation counter as necessary.
`void`	`incrementTurn()` Increment the turn variable by one.
`boolean`	`isRunning()`
`void`	`readConfigFile(java.lang.String filename)` Read and parse a config file.
`void`	`reset()` Reset the world run-time variables, ready for a new run.
`void`	`setAnimals(java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Integer>> animalInfo)`
`void`	`setAutorun(int autorun)`
`void`	`setAverageGrassDensity(int averageGrassDensity)`
`void`	`setCarnivoreCount(int carnivoreCounter)`
`void`	`setDefaultGenome(OccupantType type, int mutationRate, int speed, int stamina, int sight, int metabolism, int ageLimit, int strength, int reproductiveEnergy, int maturityAge, int gestation, int reproductionRate)` Interface for the Genome method
`void`	`setHerbivoreCount(int herbivoreCounter)`
`void`	`setHumidity(Humidity humidity)`
`void`	`setRunning(boolean running)`
`void`	`setSize(int[] size)`
`void`	`setStartEnergyCarnivores(int startEnergyCarnivores)`
`void`	`setStartEnergyHerbivores(int startEnergyHerbivores)`
`void`	`setStartGrassDensity(int startGrassDensity)`
`void`	`setStartNoCarnivores(int startNoCarnivores)`
`void`	`setStartNoHerbivores(int startNoHerbivores)`
`void`	`setStartNoWaterTiles(int startNoWaterTiles)`
`void`	`setStopAt(int stopAt)`
`void`	`setTimelapse(int timelapse)`

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

Field Detail

world
```
private static World world
```

size
```
private int[] size
```

timelapse
```
private int timelapse
```

stopAt
```
private int stopAt
```

autorun
```
private int autorun
```

humidity
```
private Humidity humidity
```

startGrassDensity
```
private int startGrassDensity
```

waterTiles
```
private int waterTiles
```

startNoCarnivores
```
private int startNoCarnivores
```

startNoHerbivores
```
private int startNoHerbivores
```

startEnergyCarnivores
```
private int startEnergyCarnivores
```

startEnergyHerbivores
```
private int startEnergyHerbivores
```

running
```
private boolean running
```

turn
```
private int turn
```

nextID
```
private int nextID
```

herbivoreCounter
```
private int herbivoreCounter
```

carnivoreCounter
```
private int carnivoreCounter
```

highestGeneration
```
private int highestGeneration
```

averageGrassDensity
```
private int averageGrassDensity
```

animals

private java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Integer>> animals

news

private java.util.ArrayList<java.lang.String> news

Constructor Detail
- World
```
private World()
```
  This class implements Singleton, therefore the constructor is private.

Method Detail

getInstance
```
public static World getInstance()
```
The Singleton method.

readConfigFile
```
public void readConfigFile(java.lang.String filename)
```
Read and parse a config file. XXX This is really messy, but it works.

reset
```
public void reset()
```
Reset the world run-time variables, ready for a new run. This method should only be called from the Ecologia main class!

giveNews
```
public void giveNews(java.lang.String message)
```
Display a news item - calling with null as a parameter resets the news list

Parameters:

news -

getAnimalInfo

public java.util.HashMap<java.lang.String,java.lang.Integer> getAnimalInfo(int x,
                                                                           int y)

Return information about the animal at the given position as a hash map

Parameters:: x, - y
Returns:: HashMap, or null if no animal at the specified location

getFieldInfo

public java.util.HashMap<java.lang.String,java.lang.Integer> getFieldInfo(int x,
                                                                          int y)

Return information about the map field at the given position as a hash map

Parameters:: x, - y
Returns:: HashMap, or null if out of bounds

getDefaultGenome

public java.util.HashMap<java.lang.String,java.lang.Integer> getDefaultGenome(OccupantType type)

Return a hash map holding all the genome values

setDefaultGenome

public void setDefaultGenome(OccupantType type,
                             int mutationRate,
                             int speed,
                             int stamina,
                             int sight,
                             int metabolism,
                             int ageLimit,
                             int strength,
                             int reproductiveEnergy,
                             int maturityAge,
                             int gestation,
                             int reproductionRate)

Interface for the Genome method

getSize
```
public int[] getSize()
```

setSize
```
public void setSize(int[] size)
```

getTimelapse
```
public int getTimelapse()
```

setTimelapse

public void setTimelapse(int timelapse)

getStopAt
```
public int getStopAt()
```

setStopAt
```
public void setStopAt(int stopAt)
```

getAutorun
```
public int getAutorun()
```

setAutorun
```
public void setAutorun(int autorun)
```

getHumidity
```
public Humidity getHumidity()
```

setHumidity

public void setHumidity(Humidity humidity)

getStartGrassDensity
```
public int getStartGrassDensity()
```

setStartGrassDensity

public void setStartGrassDensity(int startGrassDensity)

getWaterTiles
```
public int getWaterTiles()
```

setStartNoWaterTiles

public void setStartNoWaterTiles(int startNoWaterTiles)

getStartNoCarnivores
```
public int getStartNoCarnivores()
```

setStartNoCarnivores

public void setStartNoCarnivores(int startNoCarnivores)

getStartNoHerbivores
```
public int getStartNoHerbivores()
```

setStartNoHerbivores

public void setStartNoHerbivores(int startNoHerbivores)

getStartEnergyCarnivores
```
public int getStartEnergyCarnivores()
```

setStartEnergyCarnivores

public void setStartEnergyCarnivores(int startEnergyCarnivores)

getStartEnergyHerbivores
```
public int getStartEnergyHerbivores()
```

setStartEnergyHerbivores

public void setStartEnergyHerbivores(int startEnergyHerbivores)

getHerbivoreCount
```
public int getHerbivoreCount()
```

setHerbivoreCount

public void setHerbivoreCount(int herbivoreCounter)

getCarnivoreCount
```
public int getCarnivoreCount()
```

setCarnivoreCount

public void setCarnivoreCount(int carnivoreCounter)

getAverageGrassDensity
```
public int getAverageGrassDensity()
```

setAverageGrassDensity

public void setAverageGrassDensity(int averageGrassDensity)

isRunning
```
public boolean isRunning()
```

setRunning

public void setRunning(boolean running)

getTurn
```
public int getTurn()
```

incrementTurn
```
public void incrementTurn()
```
Increment the turn variable by one.

getNextID
```
public int getNextID()
```
Get the next unique animal ID number and increment the counter.

incGeneration
```
public void incGeneration(int n)
```
Increment the generation counter as necessary.

getGeneration
```
public int getGeneration()
```

setAnimals

public void setAnimals(java.util.ArrayList<java.util.HashMap<java.lang.String,java.lang.Integer>> animalInfo)

collectNews

public java.util.ArrayList<java.lang.String> collectNews()

Class World

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

world

size

timelapse

stopAt

autorun

humidity

startGrassDensity

waterTiles

startNoCarnivores

startNoHerbivores

startEnergyCarnivores

startEnergyHerbivores

running

turn

nextID

herbivoreCounter

carnivoreCounter

highestGeneration

averageGrassDensity

animals

news

Constructor Detail

World

Method Detail

getInstance

readConfigFile

reset

giveNews

getAnimalInfo

getFieldInfo

getDefaultGenome

setDefaultGenome

getSize

setSize

getTimelapse

setTimelapse

getStopAt

setStopAt

getAutorun

setAutorun

getHumidity

setHumidity

getStartGrassDensity

setStartGrassDensity

getWaterTiles

setStartNoWaterTiles

getStartNoCarnivores

setStartNoCarnivores

getStartNoHerbivores

setStartNoHerbivores

getStartEnergyCarnivores

setStartEnergyCarnivores

getStartEnergyHerbivores

setStartEnergyHerbivores

getHerbivoreCount

setHerbivoreCount

getCarnivoreCount

setCarnivoreCount

getAverageGrassDensity

setAverageGrassDensity

isRunning

setRunning

getTurn

incrementTurn

getNextID

incGeneration

getGeneration

setAnimals

collectNews