org.mars_sim.msp.core.structure
Class Settlement

java.lang.Object
  org.mars_sim.msp.core.Unit
      org.mars_sim.msp.core.structure.Structure
          org.mars_sim.msp.core.structure.Settlement

All Implemented Interfaces:

Serializable, Comparable<Unit>, LifeSupport, Malfunctionable

public class Settlement
extends Structure
implements Malfunctionable, LifeSupport

The Settlement class represents a settlement unit on virtual Mars. It contains information related to the state of the settlement.

See Also:

Serialized Form

Field Summary

static String	ADD_ASSOCIATED_PERSON_EVENT
protected BuildingManager	buildingManager
protected ConstructionManager	constructionManager
protected GoodsManager	goodsManager
protected MalfunctionManager	malfunctionManager
protected PowerGrid	powerGrid
static String	REMOVE_ASSOCIATED_PERSON_EVENT

Fields inherited from class org.mars_sim.msp.core.Unit

CONTAINER_UNIT_EVENT, DESCRIPTION_EVENT, LOCATION_EVENT, MASS_EVENT, NAME_EVENT

Constructor Summary

protected	Settlement(String name, Coordinates location) Constructor for subclass extension.
	Settlement(String name, String template, Coordinates location, int populationNumber) Constructs a Settlement object at a given location

Method Summary

void	addScientificAchievement(double achievementCredit, Science science) Add achievement credit to the settlement in a scientific field.
void	destroy() Prepare object for garbage collection.
Collection<Person>	getAffectedPeople() Gets a collection of people affected by this entity.
int	getAirlockNum() Gets the number of airlocks at the settlement.
double	getAirPressure() Gets the air pressure of the life support system.
double	getAirPressureModifier() Gets the air pressure modifier for this settlement.
Collection<Person>	getAllAssociatedPeople() Gets all people associated with this settlement, even if they are out on missions.
Collection<Vehicle>	getAllAssociatedVehicles() Gets all vehicles associated with this settlement, even if they are out on missions.
Airlock	getAvailableAirlock() Gets an available airlock for the settlement.
int	getAvailablePopulationCapacity() Gets the current available population capacity of the settlement
BuildingManager	getBuildingManager() Gets the settlement's building manager.
ConstructionManager	getConstructionManager() Gets the settlement's construction manager.
boolean	getConstructionOverride() Gets the construction override flag.
int	getCurrentPopulationNum() Gets the current population number of the settlement
GoodsManager	getGoodsManager() Gets the settlement's goods manager.
Person[]	getInhabitantArray() Gets an array of current inhabitants of the settlement
Collection<Person>	getInhabitants() Gets a collection of the inhabitants of the settlement.
int	getInitialPopulation() Gets the initial population of the settlement.
int	getLifeSupportCapacity() Gets the number of people the life support can provide for.
MalfunctionManager	getMalfunctionManager() Gets the entity's malfunction manager.
boolean	getManufactureOverride() Gets the manufacture override flag.
boolean	getMissionCreationOverride() Gets the mission creation override flag.
double	getOxygenFlowModifier() Gets the oxygen flow modifier for this settlement.
int	getParkedVehicleNum() Gets the number of vehicles parked at the settlement.
Collection<Vehicle>	getParkedVehicles() Gets a collection of vehicles parked at the settlement.
int	getPopulationCapacity() Gets the population capacity of the settlement
PowerGrid	getPowerGrid() Gets the settlement's power grid.
boolean	getResourceProcessOverride() Gets the resource process override flag.
double	getScientificAchievement(Science science) Gets the settlement's achievement credit for a given scientific field.
double	getTemperature() Gets the temperature of the life support system.
double	getTemperatureModifier() Gets the temperature modifier for this settlement.
String	getTemplate() Gets the settlement template.
double	getTotalScientificAchievement() Gets the settlement's total scientific achievement credit.
double	getWaterFlowModifier() Gets the water flow modifier for this settlement.
boolean	lifeSupportCheck() Returns true if life support is working properly and is not out of oxygen or water.
double	provideOxygen(double amountRequested) Gets oxygen from system.
double	provideWater(double amountRequested) Gets water from system.
void	setConstructionOverride(boolean constructionOverride) Sets the construction override flag.
void	setManufactureOverride(boolean manufactureOverride) Sets the manufacture override flag.
void	setMissionCreationOverride(boolean missionCreationOverride) Sets the mission creation override flag.
void	setResourceProcessOverride(boolean resourceProcessOverride) Sets the resource process override flag.
void	timePassing(double time) Perform time-related processes

Methods inherited from class org.mars_sim.msp.core.Unit

addUnitListener, compareTo, fireUnitUpdate, fireUnitUpdate, getBaseMass, getContainerUnit, getCoordinates, getDescription, getInventory, getMass, getName, getTopContainerUnit, getUnitManager, hasUnitListener, removeUnitListener, setBaseMass, setContainerUnit, setCoordinates, setDescription, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mars_sim.msp.core.malfunction.Malfunctionable

getInventory, getName

Field Detail

ADD_ASSOCIATED_PERSON_EVENT

public static final String ADD_ASSOCIATED_PERSON_EVENT

See Also:

Constant Field Values

REMOVE_ASSOCIATED_PERSON_EVENT

public static final String REMOVE_ASSOCIATED_PERSON_EVENT

See Also:

Constant Field Values

buildingManager

protected BuildingManager buildingManager

goodsManager

protected GoodsManager goodsManager

constructionManager

protected ConstructionManager constructionManager

powerGrid

protected PowerGrid powerGrid

malfunctionManager

protected MalfunctionManager malfunctionManager

Constructor Detail

Settlement

protected Settlement(String name,
                     Coordinates location)

Constructor for subclass extension.

Parameters:

name - the settlement's name

location - the settlement's location

Settlement

public Settlement(String name,
                  String template,
                  Coordinates location,
                  int populationNumber)

Constructs a Settlement object at a given location

Parameters:

name - the settlement's name

template - for the settlement

location - the settlement's location

populationNumber - the settlement's initial population.

Method Detail

getPopulationCapacity

public int getPopulationCapacity()

Gets the population capacity of the settlement

Returns:

the population capacity

getCurrentPopulationNum

public int getCurrentPopulationNum()

Gets the current population number of the settlement

Returns:

the number of inhabitants

getInhabitants

public Collection<Person> getInhabitants()

Gets a collection of the inhabitants of the settlement.

Returns:

Collection of inhabitants

getAvailablePopulationCapacity

public int getAvailablePopulationCapacity()

Gets the current available population capacity of the settlement

Returns:

the available population capacity

getInhabitantArray

public Person[] getInhabitantArray()

Gets an array of current inhabitants of the settlement

Returns:

array of inhabitants

getParkedVehicles

public Collection<Vehicle> getParkedVehicles()

Gets a collection of vehicles parked at the settlement.

Returns:

Collection of parked vehicles

getParkedVehicleNum

public int getParkedVehicleNum()

Gets the number of vehicles parked at the settlement.

Returns:

parked vehicles number

lifeSupportCheck

public boolean lifeSupportCheck()

Returns true if life support is working properly and is not out of oxygen or water.

Specified by:

lifeSupportCheck in interface LifeSupport

Returns:

true if life support is OK

Throws:

Exception - if error checking life support.

getLifeSupportCapacity

public int getLifeSupportCapacity()

Gets the number of people the life support can provide for.

Specified by:

getLifeSupportCapacity in interface LifeSupport

Returns:

the capacity of the life support system

provideOxygen

public double provideOxygen(double amountRequested)

Gets oxygen from system.

Specified by:

provideOxygen in interface LifeSupport

Parameters:

amountRequested - the amount of oxygen requested from system (kg)

Returns:

the amount of oxgyen actually received from system (kg)

Throws:

Exception - if error providing oxygen.

getOxygenFlowModifier

public double getOxygenFlowModifier()

Gets the oxygen flow modifier for this settlement.

Returns:

oxygen flow modifier

provideWater

public double provideWater(double amountRequested)

Gets water from system.

Specified by:

provideWater in interface LifeSupport

Parameters:

amountRequested - the amount of water requested from system (kg)

Returns:

the amount of water actually received from system (kg)

Throws:

Exception - if error providing water.

getWaterFlowModifier

public double getWaterFlowModifier()

Gets the water flow modifier for this settlement.

Returns:

water flow modifier

getAirPressure

public double getAirPressure()

Gets the air pressure of the life support system.

Specified by:

getAirPressure in interface LifeSupport

Returns:

air pressure (atm)

getAirPressureModifier

public double getAirPressureModifier()

Gets the air pressure modifier for this settlement.

Returns:

air pressure flow modifier

getTemperature

public double getTemperature()

Gets the temperature of the life support system.

Specified by:

getTemperature in interface LifeSupport

Returns:

temperature (degrees C)

getTemperatureModifier

public double getTemperatureModifier()

Gets the temperature modifier for this settlement.

Returns:

temperature flow modifier

timePassing

public void timePassing(double time)

Perform time-related processes

Overrides:

timePassing in class Unit

Parameters:

time - the amount of time passing (in millisols)

Throws:

Exception - if error during time passing.

getAffectedPeople

public Collection<Person> getAffectedPeople()

Gets a collection of people affected by this entity.

Specified by:

getAffectedPeople in interface Malfunctionable

Returns:

person collection

getBuildingManager

public BuildingManager getBuildingManager()

Gets the settlement's building manager.

Returns:

building manager

getGoodsManager

public GoodsManager getGoodsManager()

Gets the settlement's goods manager.

Returns:

goods manager

getAvailableAirlock

public Airlock getAvailableAirlock()

Gets an available airlock for the settlement.

Returns:

airlock or null if none available.

getAirlockNum

public int getAirlockNum()

Gets the number of airlocks at the settlement.

Returns:

number of airlocks.

getPowerGrid

public PowerGrid getPowerGrid()

Gets the settlement's power grid.

Returns:

the power grid.

getTemplate

public String getTemplate()

Gets the settlement template.

Returns:

template as string.

getAllAssociatedPeople

public Collection<Person> getAllAssociatedPeople()

Gets all people associated with this settlement, even if they are out on missions.

Returns:

collection of associated people.

getAllAssociatedVehicles

public Collection<Vehicle> getAllAssociatedVehicles()

Gets all vehicles associated with this settlement, even if they are out on missions.

Returns:

collection of associated vehicles.

setMissionCreationOverride

public void setMissionCreationOverride(boolean missionCreationOverride)

Sets the mission creation override flag.

Parameters:

missionCreationOverride - override for settlement mission creation.

getMissionCreationOverride

public boolean getMissionCreationOverride()

Gets the mission creation override flag.

Returns:

override for settlement mission creation.

setConstructionOverride

public void setConstructionOverride(boolean constructionOverride)

Sets the construction override flag.

Parameters:

constructionOverride - override for settlement construction/salvage mission creation.

getConstructionOverride

public boolean getConstructionOverride()

Gets the construction override flag.

Returns:

override for settlement construction mission creation.

setManufactureOverride

public void setManufactureOverride(boolean manufactureOverride)

Sets the manufacture override flag.

Parameters:

manufactureOverride - override for manufacture.

getManufactureOverride

public boolean getManufactureOverride()

Gets the manufacture override flag.

Returns:

override for settlement manufacture.

setResourceProcessOverride

public void setResourceProcessOverride(boolean resourceProcessOverride)

Sets the resource process override flag.

Parameters:

resourceProcessOverride - override for resource processes.

getResourceProcessOverride

public boolean getResourceProcessOverride()

Gets the resource process override flag.

Returns:

override for settlement resource processes.

getConstructionManager

public ConstructionManager getConstructionManager()

Gets the settlement's construction manager.

Returns:

construction manager.

getScientificAchievement

public double getScientificAchievement(Science science)

Gets the settlement's achievement credit for a given scientific field.

Parameters:

science - the scientific field.

Returns:

achievement credit.

getTotalScientificAchievement

public double getTotalScientificAchievement()

Gets the settlement's total scientific achievement credit.

Returns:

achievement credit.

addScientificAchievement

public void addScientificAchievement(double achievementCredit,
                                     Science science)

Add achievement credit to the settlement in a scientific field.

Parameters:

achievementCredit - the achievement credit.

science - the scientific field.

getMalfunctionManager

public MalfunctionManager getMalfunctionManager()

Gets the entity's malfunction manager.

Specified by:

getMalfunctionManager in interface Malfunctionable

Returns:

malfunction manager

getInitialPopulation

public int getInitialPopulation()

Gets the initial population of the settlement.

Returns:

initial population number.

destroy

public void destroy()

Description copied from class: Unit

Prepare object for garbage collection.

Overrides:

destroy in class Unit