ch.sahits.game.openpatrician.model.city.impl

Class CityState

java.lang.Object

ch.sahits.game.openpatrician.model.city.impl.CityState

@Component
 @Scope(value="prototype")
public class CityState
extends Object

This class encapsulates state information used by CityEngine about one city. This class i player private since it should not be used by any other class than CityEngine.

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Nov 29, 2011

Field Summary

Fields

Modifier and Type	Field and Description
private IBuildingProduction	buildingProduction
private ICity	city Reference to the city model that is driven by this engine
private CityWall	cityWall
private PopulationConsume	consume Provider for the consume numbers
private Map<IWare,Double>	consumed Map of consumed wares, since only whole units can be consumed we need to store the fractions
private org.apache.logging.log4j.Logger	logger
private DependentPropertyInitializer	propertyInitializer
private Random	rnd
private IShipyard	shipyardState Ship yard state fos the city
private double	surplusThreshold
private TavernState	tavernState Tavern state for this city

Constructor Summary

Constructors

Constructor and Description
CityState(ICity city, IShipyard shipard, TavernState tavern)

Method Summary

Modifier and Type	Method and Description
Set<Map.Entry<IWare,Double>>	consumedEntries() Get the consumed entries as a set.
Optional<IWare>	findMostNeededWare() Find the ware which is consumed the most and which is missing for the longest time.
Optional<IWare>	findWareWithMostSurplus() Find the ware that the city sells near the minimal price.
double	getConsumedAmount(EWare ware) Retrieve the amount that is consumed so far.
(package private) Map<IWare,Integer>	getSortedWareAvailabilityMap() Find the wares and order them in the amount of their availability.
private void	initCity()
void	replaceConsumedAmount(IWare ware, double amount) Set the amount of the ware that is consumed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private final org.apache.logging.log4j.Logger logger

rnd

@Autowired
private Random rnd

surplusThreshold

@DependentValue(value="ware.surplus.treshold")
private double surplusThreshold

city

private ICity city

Reference to the city model that is driven by this engine

consumed

private Map<IWare,Double> consumed

Map of consumed wares, since only whole units can be consumed we need to store the fractions

tavernState

private TavernState tavernState

Tavern state for this city

shipyardState

private IShipyard shipyardState

Ship yard state fos the city

consume

@Autowired
private PopulationConsume consume

Provider for the consume numbers

buildingProduction

@Autowired
private IBuildingProduction buildingProduction

propertyInitializer

@Autowired
private DependentPropertyInitializer propertyInitializer

cityWall

@Autowired
private CityWall cityWall

Constructor Detail

CityState

public CityState(ICity city,
                 IShipyard shipard,
                 TavernState tavern)

Method Detail

initCity

@PostConstruct
private void initCity()

consumedEntries

public Set<Map.Entry<IWare,Double>> consumedEntries()

Get the consumed entries as a set.

Returns:

replaceConsumedAmount

public void replaceConsumedAmount(IWare ware,
                                  double amount)

Set the amount of the ware that is consumed. If there is already an amount stored for the ware it is overidden.

Parameters:

ware - to be consumed

amount - to be consumed

getConsumedAmount

public double getConsumedAmount(EWare ware)

Retrieve the amount that is consumed so far.

Parameters:

ware - which should be checked for consumption.

Returns:

consumed amount.

findMostNeededWare

public Optional<IWare> findMostNeededWare()

Find the ware which is consumed the most and which is missing for the longest time.

Returns:

findWareWithMostSurplus

public Optional<IWare> findWareWithMostSurplus()

Find the ware that the city sells near the minimal price.

Returns:

getSortedWareAvailabilityMap

Map<IWare,Integer> getSortedWareAvailabilityMap()

Find the wares and order them in the amount of their availability. If there is a ware with the same availability, only one is added to the map.

Returns: