ICity (OpenPatricianModel 0.9.0-RC1 API)

All Known Implementing Classes:

City
```
public interface ICity
```
Model of a city.

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Sep 16, 2011

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBuildingPermission(IPlayer player)` Add the bulidng permission for that player in the city.
`void`	`build(IBuilding building)` Remove a building from the list of buildings in the city
`<T extends IBuilding> List<T>`	`findBuilding(Class<T> buildingClass, Optional<IPlayer> owner)` Find all matching buildings in a city.
`List<IBuilding>`	`getBuildings()` Retrieve a list of all buildings in the city.
`List<ICitizen>`	`getCitizen()` Retrieve the list of citizen in the city.
`CityState`	`getCityState()` Retrieve the city state.
`int`	`getContribution(IPlayer player, IWare ware)` Check out what the player contributed to the ware
`javafx.geometry.Point2D`	`getCoordinates()` Retrieve the coordinates of the city
`IWare[]`	`getEffectiveProduction()` Retrieve the wares that are produced efficiently
`List<IWare>`	`getImported()` Retrieve the subset list of wares that are produced but are actually imported.
`IWare[]`	`getIneffectiveProduction()` Retrieve the wares that are produced inefficiently
`EKontorType`	`getKontorType()` Retrieve the city type
`Map<IWare,java.time.LocalDateTime>`	`getMissingWares()` Retrieve the missing wares along with their times
`String`	`getName()` Retrieve the city name
`String`	`getNameTemplate()` Retrieve the non locale sepecific name template.
`double`	`getPercentageRoad()` Retrieve the amount of road in the city.
`int`	`getPopulation(EPopulationClass popclass)` Retrieve the current population of the city by class
`javafx.beans.binding.IntegerBinding`	`getPopulationBinding()` Retrieve the binding of the city's total population.
`javafx.beans.property.IntegerProperty`	`getPopulationProperty(EPopulationClass popclass)` Retrieve the population count for a class
`IReputation`	`getReputation(IPlayer player)` Retrieve the reputation of the player in the city
`List<IPlayer>`	`getResidentPlayers()` Retrieve all the players that have a office in this city.
`String`	`getUniqueID()` Retrieve the unique ID of the city.
`AmountablePrice<IWare>`	`getWare(IWare ware)` Retrieve the amount of ware in the city
`boolean`	`hasBuildingPermission(IPlayer player)` The player has building permission in this city.
`boolean`	`isRiverCity()` Check if the city is on a river instead of the open sea.
`int`	`move(IWare ware, int amount, ICitizen player)` Add or remove ware from the city.
`void`	`moveIn(IPlayer player, IReputation reputaion, Contributions contributions)` Add a player to the city
`void`	`setCityState(CityState state)`
`void`	`setPopulation(int population, EPopulationClass popClass)` Set the population by class
`void`	`tearDown(IBuilding building)` Add a new building to the city

- Method Detail
  - getUniqueID
```
String getUniqueID()
```
    Retrieve the unique ID of the city.
    
    Returns:
  - getKontorType
```
EKontorType getKontorType()
```
    Retrieve the city type
    
    Returns:
  - getName
```
String getName()
```
    Retrieve the city name
    
    Returns:
  - getPopulation
```
int getPopulation(EPopulationClass popclass)
```
    Retrieve the current population of the city by class
    
    Parameters:
    
    popclass -
    
    Returns:
  - setPopulation
```
void setPopulation(int population,
                   EPopulationClass popClass)
```
    Set the population by class
    
    Parameters:
    
    population -
    
    popClass -
  - move
```
int move(IWare ware,
         int amount,
         ICitizen player)
```
    Add or remove ware from the city. If the amount is negative it will be removed. If the full amount is not available only the available will be moved and returned. The amount is in the ware specific size.
    
    Parameters:
    
    ware - to be moved
    
    amount - of the ware that is moved
    
    player - that moved the ware
    
    Returns:
    
    amount moved
  - getIneffectiveProduction
```
IWare[] getIneffectiveProduction()
```
    Retrieve the wares that are produced inefficiently
    
    Returns:
  - getEffectiveProduction
```
IWare[] getEffectiveProduction()
```
    Retrieve the wares that are produced efficiently
    
    Returns:
  - getBuildings
```
List<IBuilding> getBuildings()
```
    Retrieve a list of all buildings in the city. The list is immutable
    
    Returns:
  - tearDown
```
void tearDown(IBuilding building)
```
    Add a new building to the city
    
    Parameters:
    
    building -
  - build
```
void build(IBuilding building)
```
    Remove a building from the list of buildings in the city
    
    Parameters:
    
    building -
  - getReputation
```
IReputation getReputation(IPlayer player)
```
    Retrieve the reputation of the player in the city
    
    Parameters:
    
    player -
    
    Returns:
  - moveIn
```
void moveIn(IPlayer player,
            IReputation reputaion,
            Contributions contributions)
```
    Add a player to the city
    
    Parameters:
    
    player - that is added to the city
    
    reputaion - of that player in the city
    
    contributions - contibutions of that player in the city.
  - getContribution
```
int getContribution(IPlayer player,
                    IWare ware)
```
    Check out what the player contributed to the ware
    
    Parameters:
    
    player - whose contribution is to be checked
    
    ware - that is checked for contribution
    
    Returns:
    
    amount of the contribution may also be negative
  - getMissingWares
```
Map<IWare,java.time.LocalDateTime> getMissingWares()
```
    Retrieve the missing wares along with their times
    
    Returns:
  - getCoordinates
```
javafx.geometry.Point2D getCoordinates()
```
    Retrieve the coordinates of the city
    
    Returns:
  - getResidentPlayers
```
List<IPlayer> getResidentPlayers()
```
    Retrieve all the players that have a office in this city.
    
    Returns:
    
    immutable list
  - getCityState
```
CityState getCityState()
```
    Retrieve the city state.
    
    Returns:
  - setCityState
```
void setCityState(CityState state)
```
  - getWare
```
AmountablePrice<IWare> getWare(IWare ware)
```
    Retrieve the amount of ware in the city
    
    Parameters:
    
    ware -
    
    Returns:
  - getPopulationProperty
```
javafx.beans.property.IntegerProperty getPopulationProperty(EPopulationClass popclass)
```
    Retrieve the population count for a class
    
    Parameters:
    
    popclass - population class
    
    Returns:
  - getPopulationBinding
```
javafx.beans.binding.IntegerBinding getPopulationBinding()
```
    Retrieve the binding of the city's total population.
    
    Returns:
  - getCitizen
```
List<ICitizen> getCitizen()
```
    Retrieve the list of citizen in the city. This list contains various player as well as some instances used by the AI to govern the city.
    
    Returns:
  - findBuilding
```
<T extends IBuilding> List<T> findBuilding(Class<T> buildingClass,
                                           Optional<IPlayer> owner)
```
    Find all matching buildings in a city.
    
    Parameters:
    
    buildingClass - class of the building
    
    owner - search can be restricted to a player.
    
    Returns:
    
    List of buildings of type T
  - getNameTemplate
```
String getNameTemplate()
```
    Retrieve the non locale sepecific name template.
    
    Returns:
  - isRiverCity
```
boolean isRiverCity()
```
    Check if the city is on a river instead of the open sea.
    
    Returns:
  - getImported
```
List<IWare> getImported()
```
    Retrieve the subset list of wares that are produced but are actually imported.
    
    Returns:
  - hasBuildingPermission
```
boolean hasBuildingPermission(IPlayer player)
```
    The player has building permission in this city.
    
    Parameters:
    
    player -
    
    Returns:
  - addBuildingPermission
```
void addBuildingPermission(IPlayer player)
```
    Add the bulidng permission for that player in the city.
    
    Parameters:
    
    player -
  - getPercentageRoad
```
double getPercentageRoad()
```
    Retrieve the amount of road in the city. The amount is the value of number road tiles versus the population.
    
    Returns:

Interface ICity

Method Summary

Method Detail

getUniqueID

getKontorType

getName

getPopulation

setPopulation

move

getIneffectiveProduction

getEffectiveProduction

getBuildings

tearDown

build

getReputation

moveIn

getContribution

getMissingWares

getCoordinates

getResidentPlayers

getCityState

setCityState

getWare

getPopulationProperty

getPopulationBinding

getCitizen

findBuilding

getNameTemplate

isRiverCity

getImported

hasBuildingPermission

addBuildingPermission

getPercentageRoad