Animal

java.lang.Object
- model.Animal

Direct Known Subclasses:

Carnivore, Herbivore
```
public abstract class Animal
extends java.lang.Object
```
This is the superclass of all animal classes. It holds common methods needed by all animals.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`age`
`protected int`	`attemptedMovesThisTurn`
`protected int`	`energy`
`protected int`	`exhaustion`
`protected int`	`generation`
`protected Genome`	`genome`
`protected int`	`gestationPeriod`
`protected int`	`IDnumber`
`protected boolean`	`isAlive`
`protected int`	`movesThisTurn`
`protected int`	`offspring`
`protected int`	`parent`
`protected java.util.Random`	`random`
`protected OccupantType`	`type`
`protected int`	`x`
`protected int`	`y`

Constructor Summary

Constructors
Constructor and Description
`Animal(int setID, OccupantType myType, Genome newGenome, int myGeneration, int setX, int setY, int setEnergy, int parentID)` The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeEnergy(int amount)` Change the energy level of this animal.
`int[]`	`closestSearch(OccupantType type)` Search for the inputed object within the line of sight.
`void`	`exhaust(int e)`
`int`	`getAge()`
`Direction`	`getDirection(int xpos, int ypos)` In which direction are the given coordinates relative to this animal?
`int`	`getDistance(int xpos, int ypos)` How many steps are needed to get to the specified position?
`int`	`getEnergy()`
`int`	`getGeneration()`
`Genome`	`getGenome()`
`long`	`getID()`
`java.util.HashMap<java.lang.String,java.lang.Integer>`	`getInfo()` Return a hash map containing all the information about this animal.
`int[]`	`getNeighbouringField(Direction dir)` Calculate the neighbouring square in the specified direction (return null if out of bounds)
`int`	`getOffspring()`
`int`	`getParent()`
`OccupantType`	`getType()`
`int`	`getX()`
`int`	`getY()`
`boolean`	`isAlive()`
`int[]`	`mixedSearch(OccupantType type)` Search for the inputed object within the line of sight.
`boolean`	`move(Direction dir)` The animal moves in the specified direction.
`int[]`	`randomizedSearch(OccupantType type)` Search for the inputed object within the line of sight.
`void`	`reproduce()` The animal reproduces, setting down a child on a neighbouring square
`int[]`	`search(OccupantType type)` Search for the inputed object within the line of sight.
`void`	`setAge(int newAge)`
`void`	`setEnergy(int newEnergy)`
`void`	`setPosition(int newX, int newY)`
`void`	`update()` This method has to be called by every species.

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

Field Detail

IDnumber
```
protected int IDnumber
```

parent
```
protected int parent
```

genome
```
protected Genome genome
```

generation
```
protected int generation
```

offspring
```
protected int offspring
```

type
```
protected OccupantType type
```

x
```
protected int x
```

y
```
protected int y
```

age
```
protected int age
```

energy
```
protected int energy
```

movesThisTurn
```
protected int movesThisTurn
```

attemptedMovesThisTurn
```
protected int attemptedMovesThisTurn
```

exhaustion
```
protected int exhaustion
```

gestationPeriod
```
protected int gestationPeriod
```

isAlive
```
protected boolean isAlive
```

random
```
protected java.util.Random random
```

Constructor Detail

Animal

public Animal(int setID,
              OccupantType myType,
              Genome newGenome,
              int myGeneration,
              int setX,
              int setY,
              int setEnergy,
              int parentID)

The constructor.

Parameters:: setID -; myType -; newGenome -; myGeneration -; setX -; setY -; setEnergy -; parentID -

Method Detail
- update
```
public void update()
```
  This method has to be called by every species.
- reproduce
```
public void reproduce()
```
  The animal reproduces, setting down a child on a neighbouring square
- move
```
public boolean move(Direction dir)
```
  The animal moves in the specified direction.
  
  Returns:
  
  success
- search
```
public int[] search(OccupantType type)
```
  Search for the inputed object within the line of sight.
- randomizedSearch
```
public int[] randomizedSearch(OccupantType type)
```
  Search for the inputed object within the line of sight. The returned coordinates are chosen at random from a list of eligible ones.
- closestSearch
```
public int[] closestSearch(OccupantType type)
```
  Search for the inputed object within the line of sight. Finds the object closest to the individual.
- mixedSearch
```
public int[] mixedSearch(OccupantType type)
```
  Search for the inputed object within the line of sight. A random target is chosen out of a list of targets closest to the individual.
- getNeighbouringField
```
public int[] getNeighbouringField(Direction dir)
```
  Calculate the neighbouring square in the specified direction (return null if out of bounds)
- getDirection
```
public Direction getDirection(int xpos,
                              int ypos)
```
  In which direction are the given coordinates relative to this animal?
  
  Parameters:
  
  xpos -
  
  ypos -
  
  Returns:
  
  Direction
- getDistance
```
public int getDistance(int xpos,
                       int ypos)
```
  How many steps are needed to get to the specified position?
- getInfo
```
public java.util.HashMap<java.lang.String,java.lang.Integer> getInfo()
```
  Return a hash map containing all the information about this animal.
- isAlive
```
public boolean isAlive()
```
- getID
```
public long getID()
```
- getGenome
```
public Genome getGenome()
```
- getGeneration
```
public int getGeneration()
```
- getParent
```
public int getParent()
```
- getOffspring
```
public int getOffspring()
```
- getType
```
public OccupantType getType()
```
- getX
```
public int getX()
```
- getY
```
public int getY()
```
- getAge
```
public int getAge()
```
- getEnergy
```
public int getEnergy()
```
- changeEnergy
```
public void changeEnergy(int amount)
```
  Change the energy level of this animal. If it dips to <= 0, the animal dies and is removed. This is a convenience wrapper method around setEnergy().
  
  Parameters:
  
  amount -
- setEnergy
```
public void setEnergy(int newEnergy)
```
- setAge
```
public void setAge(int newAge)
```
- setPosition
```
public void setPosition(int newX,
                        int newY)
```
- exhaust
```
public void exhaust(int e)
```

Class Animal

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IDnumber

parent

genome

generation

offspring

type

x

y

age

energy

movesThisTurn

attemptedMovesThisTurn

exhaustion

gestationPeriod

isAlive

random

Constructor Detail

Animal

Method Detail

update

reproduce

move

search

randomizedSearch

closestSearch

mixedSearch

getNeighbouringField

getDirection

getDistance

getInfo

isAlive

getID

getGenome

getGeneration

getParent

getOffspring

getType

getX

getY

getAge

getEnergy

changeEnergy

setEnergy

setAge

setPosition

exhaust