Station

java.lang.Object
- com.TeamHEC.LocomotionCommotion.Map.MapObj
- - com.TeamHEC.LocomotionCommotion.Map.Station

```
public class Station
extends MapObj
```
Author:

Matthew Taylor , Elliot Bray

Field Summary

Fields
Modifier and Type Field and Description

double mindistance
- Fields inherited from class com.TeamHEC.LocomotionCommotion.Map.MapObj
  actor, connections, x, y

Fields
Modifier and Type	Field and Description
`double`	`mindistance`

Constructor Summary

Constructors
Constructor and Description
`Station(java.lang.String name, int baseValue, Resource resourceType, int baseFuelOut, Line[] line, int rentValue, float x, float y)`
`Station(java.lang.String name, int baseValue, Resource resourceType, int baseFuelOut, Line[] line, int rentValue, float x, float y, boolean locked)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLine(Line colour)`
`void`	`addRentValueMod(int add)`
`void`	`addResourceOutMod(int add)`
`void`	`addValueMod(int add)`
`boolean`	`equals(Station station)`
`void`	`fixFaulty()` fix the station
`int`	`getBaseRentValue()`
`int`	`getBaseResourceOut()`
`int`	`getBaseValue()`
`double`	`getFaultRate()`
`Line[]`	`getLineType()`
`Player`	`getOwner()`
`int`	`getRentValueMod()`
`int`	`getResourceOutMod()`
`java.lang.String`	`getResourceString()`
`Resource`	`getResourceType()`
`Station`	`getStation()`
`Game_Map_Station`	`getStationActor()`
`int`	`getTotalRent()`
`int`	`getTotalResourceOut()`
`int`	`getTotalValue()`
`int`	`getValueMod()`
`boolean`	`isFaulty()`
`void`	`makeFaulty()` makes the station faulty
`void`	`notifyStationPurchased(Station station, Player player)` Called when you want to notify listeners that a station has changed ownership, such as changing the texture on the map or setting the text of the players gold
`void`	`register(StationListener newListener)` Registers an object implementing the StationListener by adding it to the listeners array
`void`	`removeLine(Line colour)`
`void`	`setBaseRentValue(int newVal)`
`void`	`setBaseResourceOut(int newVal)`
`void`	`setBaseValue(int newVal)`
`void`	`setOwner(Player newOwner)` Changes the owner of this station and notifies listeners
`void`	`setRentValueMod(int value)`
`void`	`setResourceOutMod(int mod)`
`void`	`setResourceType(Resource newResourceType)`
`void`	`setValueMod(int value)`
`void`	`subRentValueMod(int sub)`
`void`	`subResourceOutMod(int sub)`
`void`	`subValueMod(int sub)`
`java.lang.String`	`toJSON()` Recursively generates a JSON of the Station instance
`void`	`unregister(StationListener s)` Removes object implementing StationListener so it no longer recieves updates

Methods inherited from class com.TeamHEC.LocomotionCommotion.Map.MapObj
getActor, getName, isLocked, lock, setName

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

- Field Detail
  - mindistance
```
public double mindistance
```
- Constructor Detail
  - Station
```
public Station(java.lang.String name,
       int baseValue,
       Resource resourceType,
       int baseFuelOut,
       Line[] line,
       int rentValue,
       float x,
       float y)
```
    Parameters:
    name -
    baseValue - The value of the station
    resourceType - The type of resource the station produces
    baseFuelOut - The amount of resource the station produces each turn, without up line bonuses
    line - Array of lines the station belongs to
    rentValue - How much it costs to rent
    x - Coordinate of position x on map
    y - Coordinate of position y on map
  - Station
```
public Station(java.lang.String name,
       int baseValue,
       Resource resourceType,
       int baseFuelOut,
       Line[] line,
       int rentValue,
       float x,
       float y,
       boolean locked)
```
- Method Detail
  - getStation
```
public Station getStation()
```
    Overrides:
    
    getStation in class MapObj
    
    Returns:
    station instance, used in MapObj and overwritten here
  - getStationActor
```
public Game_Map_Station getStationActor()
```
  - getResourceString
```
public java.lang.String getResourceString()
```
    Returns:
    The string of the fuelType used, can be used in player to deduct resources
  - getBaseValue
```
public int getBaseValue()
```
    Returns:
    the value of the station without mods
  - setBaseValue
```
public void setBaseValue(int newVal)
```
    Parameters:
    newVal - the new base value of the station
  - getValueMod
```
public int getValueMod()
```
    Returns:
    the value added onto baseValue from bonuses
  - setValueMod
```
public void setValueMod(int value)
```
  - addValueMod
```
public void addValueMod(int add)
```
  - subValueMod
```
public void subValueMod(int sub)
```
  - getTotalValue
```
public int getTotalValue()
```
    Returns:
    the total value of the station with mods (Base + Mod)
  - getResourceType
```
public Resource getResourceType()
```
    Returns:
    returns the resource Type as a type
  - setResourceType
```
public void setResourceType(Resource newResourceType)
```
  - getBaseResourceOut
```
public int getBaseResourceOut()
```
    Returns:
    returns the base amount of resources produced by the station
  - setBaseResourceOut
```
public void setBaseResourceOut(int newVal)
```
  - getResourceOutMod
```
public int getResourceOutMod()
```
    Returns:
    the amount of resources added to base from bonuses
  - setResourceOutMod
```
public void setResourceOutMod(int mod)
```
    Parameters:
    mod - the amount resourceOut will be increased by, Total = Base + Mod
  - addResourceOutMod
```
public void addResourceOutMod(int add)
```
  - subResourceOutMod
```
public void subResourceOutMod(int sub)
```
  - getTotalResourceOut
```
public int getTotalResourceOut()
```
    Returns:
    the total output of fuel or gold resources the station produces
  - getBaseRentValue
```
public int getBaseRentValue()
```
    Returns:
    the base amount of rent a player will be charged for using an opponents station
  - setBaseRentValue
```
public void setBaseRentValue(int newVal)
```
    Parameters:
    newVal - the new rent value
  - getRentValueMod
```
public int getRentValueMod()
```
    Returns:
    the amount the base rent value is increased by
  - setRentValueMod
```
public void setRentValueMod(int value)
```
  - addRentValueMod
```
public void addRentValueMod(int add)
```
  - subRentValueMod
```
public void subRentValueMod(int sub)
```
  - getTotalRent
```
public int getTotalRent()
```
    Returns:
    the total rent value of the station with bonuses
  - getOwner
```
public Player getOwner()
```
    Returns:
    The current owner of the station
  - setOwner
```
public void setOwner(Player newOwner)
```
    Changes the owner of this station and notifies listeners
    
    Parameters:
    newOwner -
  - getLineType
```
public Line[] getLineType()
```
    Returns:
    the array of lines the station is on
  - addLine
```
public void addLine(Line colour)
```
  - removeLine
```
public void removeLine(Line colour)
```
  - register
```
public void register(StationListener newListener)
```
    Registers an object implementing the StationListener by adding it to the listeners array
    
    Parameters:
    newListener - the object to be added
  - unregister
```
public void unregister(StationListener s)
```
    Removes object implementing StationListener so it no longer recieves updates
    
    Parameters:
    s - the object to be removed
  - notifyStationPurchased
```
public void notifyStationPurchased(Station station,
                          Player player)
```
    Called when you want to notify listeners that a station has changed ownership, such as changing the texture on the map or setting the text of the players gold
    
    Parameters:
    station -
    player -
  - isFaulty
```
public boolean isFaulty()
```
    Returns:
    true if station is broken
  - makeFaulty
```
public void makeFaulty()
```
    makes the station faulty
  - fixFaulty
```
public void fixFaulty()
```
    fix the station
  - getFaultRate
```
public double getFaultRate()
```
    Returns:
    fault rate for the station fault rate is the chance that a particular station will go faulty in a particular move
  - equals
```
public boolean equals(Station station)
```
    Parameters:
    different - station
    
    Returns:
    true if station parameter is equal to station instance
  - toJSON
```
public java.lang.String toJSON()
```
    Recursively generates a JSON of the Station instance
    
    Overrides:
    
    toJSON in class MapObj
    
    Returns:
    JSON of the Station instance

Class Station

Field Summary

Fields inherited from class com.TeamHEC.LocomotionCommotion.Map.MapObj

Constructor Summary

Method Summary

Methods inherited from class com.TeamHEC.LocomotionCommotion.Map.MapObj

Methods inherited from class java.lang.Object

Field Detail

mindistance

Constructor Detail

Station

Station

Method Detail

getStation

getStationActor

getResourceString

getBaseValue

setBaseValue

getValueMod

setValueMod

addValueMod

subValueMod

getTotalValue

getResourceType

setResourceType

getBaseResourceOut

setBaseResourceOut

getResourceOutMod

setResourceOutMod

addResourceOutMod

subResourceOutMod

getTotalResourceOut

getBaseRentValue

setBaseRentValue

getRentValueMod

setRentValueMod

addRentValueMod

subRentValueMod

getTotalRent

getOwner

setOwner

getLineType

addLine

removeLine

register

unregister

notifyStationPurchased

isFaulty

makeFaulty

fixFaulty

getFaultRate

equals

toJSON