org.mars_sim.msp.core.structure
Class SettlementTemplate

java.lang.Object
  org.mars_sim.msp.core.structure.SettlementTemplate

All Implemented Interfaces:

Serializable

public class SettlementTemplate
extends Object
implements Serializable

A settlement template information.

See Also:

Serialized Form

Constructor Summary

SettlementTemplate(String name, int defaultPopulation)
Constructor

Method Summary

void	addAmountResource(AmountResource resource, double amount) Adds an amount of a type of resource.
void	addBuildingTemplate(BuildingTemplate buildingTemplate) Adds a building template.
void	addEquipment(String equipmentType, int number) Adds a number of equipment of a given type.
void	addPart(Part part, int number) Adds a number of a type of part.
void	addResupplyMissionTemplate(ResupplyMissionTemplate resupplyMissionTemplate) Adds a resupply mission template.
void	addVehicles(String vehicleType, int number) Adds a number of vehicles of a given type.
void	destroy() Prepare object for garbage collection.
List<BuildingTemplate>	getBuildingTemplates() Gets the list of building templates.
int	getDefaultPopulation() Gets the default population capacity of the template.
Map<String,Integer>	getEquipment() Gets a map of equipment types and number.
Map<Part,Integer>	getParts() Gets a map of parts and numbers.
Map<AmountResource,Double>	getResources() Gets a map of resources and amounts.
List<ResupplyMissionTemplate>	getResupplyMissionTemplates() Gets the list of resupply mission templates.
String	getTemplateName() Gets the name of the template.
Map<String,Integer>	getVehicles() Gets a map of vehicle types and number.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettlementTemplate

public SettlementTemplate(String name,
                          int defaultPopulation)

Constructor

Method Detail

getTemplateName

public String getTemplateName()

Gets the name of the template.

Returns:

name.

getDefaultPopulation

public int getDefaultPopulation()

Gets the default population capacity of the template.

Returns:

population capacity.

addBuildingTemplate

public void addBuildingTemplate(BuildingTemplate buildingTemplate)

Adds a building template.

Parameters:

buildingTemplate - the building template.

getBuildingTemplates

public List<BuildingTemplate> getBuildingTemplates()

Gets the list of building templates.

Returns:

list of building templates.

addVehicles

public void addVehicles(String vehicleType,
                        int number)

Adds a number of vehicles of a given type.

Parameters:

vehicleType - the vehicle type.

number - the number of vehicles to add.

getVehicles

public Map<String,Integer> getVehicles()

Gets a map of vehicle types and number.

Returns:

map.

addEquipment

public void addEquipment(String equipmentType,
                         int number)

Adds a number of equipment of a given type.

Parameters:

equipmentType - the equipment type.

number - the number of equipment to add.

getEquipment

public Map<String,Integer> getEquipment()

Gets a map of equipment types and number.

Returns:

map.

addAmountResource

public void addAmountResource(AmountResource resource,
                              double amount)

Adds an amount of a type of resource.

Parameters:

resource - the resource.

amount - the amount (kg).

getResources

public Map<AmountResource,Double> getResources()

Gets a map of resources and amounts.

Returns:

map.

addPart

public void addPart(Part part,
                    int number)

Adds a number of a type of part.

Parameters:

part - the part.

number - the number of parts.

getParts

public Map<Part,Integer> getParts()

Gets a map of parts and numbers.

Returns:

map.

addResupplyMissionTemplate

public void addResupplyMissionTemplate(ResupplyMissionTemplate resupplyMissionTemplate)

Adds a resupply mission template.

Parameters:

resupplyMissionTemplate - the resupply mission template.

getResupplyMissionTemplates

public List<ResupplyMissionTemplate> getResupplyMissionTemplates()

Gets the list of resupply mission templates.

Returns:

list of resupply mission templates.

destroy

public void destroy()

Prepare object for garbage collection.