Uses of Class
org.mars_sim.msp.core.structure.Settlement

Packages that use Settlement
org.mars_sim.msp.core Contains classes for creating a virtual Mars. 
org.mars_sim.msp.core.malfunction Contains classes involving malfunctions. 
org.mars_sim.msp.core.manufacture Contains classes for manufacturing processes. 
org.mars_sim.msp.core.mars Contains classes for Mars planet information, minerals... 
org.mars_sim.msp.core.person Contains classes involving person units. 
org.mars_sim.msp.core.person.ai.job Contains classes for all possible jobs supported by the simulation. 
org.mars_sim.msp.core.person.ai.mission Contains classes involving missions a person can perform. 
org.mars_sim.msp.core.person.ai.social Contains classes related to social activities: relationships.. 
org.mars_sim.msp.core.person.ai.task Contains classes involving tasks a person can perform. 
org.mars_sim.msp.core.science   
org.mars_sim.msp.core.structure Contains classes involving structure units. 
org.mars_sim.msp.core.structure.building Contains classes for settlement buildings. 
org.mars_sim.msp.core.structure.building.function Contains classes for settlement building functions. 
org.mars_sim.msp.core.structure.construction   
org.mars_sim.msp.core.structure.goods Contains classes for all used goods in the simulation. 
org.mars_sim.msp.core.vehicle Contains classes involving vehicle units. 
 

Uses of Settlement in org.mars_sim.msp.core
 

Methods in org.mars_sim.msp.core that return Settlement
static Settlement CollectionUtils.getRandomRegressionSettlement(java.util.Collection collection)
           
static Settlement CollectionUtils.getRandomSettlement(java.util.Collection collection)
           
static Settlement CollectionUtils.getSettlement(java.util.Collection collection, java.lang.String name)
           
 

Methods in org.mars_sim.msp.core that return types with arguments of type Settlement
static java.util.Collection<Settlement> CollectionUtils.getSettlement(java.util.Collection<Unit> units)
           
 java.util.Collection<Settlement> UnitManager.getSettlements()
          Get settlements in vitual Mars
 

Method parameters in org.mars_sim.msp.core with type arguments of type Settlement
static void CollectionUtils.mergeSettlements(java.util.Collection<Unit> units, java.util.Collection<Settlement> settlements)
           
 

Uses of Settlement in org.mars_sim.msp.core.malfunction
 

Methods in org.mars_sim.msp.core.malfunction with parameters of type Settlement
static java.util.Collection<Malfunctionable> MalfunctionFactory.getAssociatedMalfunctionables(Settlement settlement)
          Gets all malfunctionables associated with a settlement.
 

Uses of Settlement in org.mars_sim.msp.core.manufacture
 

Methods in org.mars_sim.msp.core.manufacture with parameters of type Settlement
static boolean ManufactureUtil.doesSettlementHaveManufacturing(Settlement settlement)
          Checks if settlement has buildings with manufacture function.
static int ManufactureUtil.getHighestManufacturingTechLevel(Settlement settlement)
          Gets the highest manufacturing tech level in a settlement.
static double ManufactureUtil.getManufactureProcessItemValue(ManufactureProcessItem item, Settlement settlement)
          Gets the good value of a manufacturing process item for a settlement.
static double ManufactureUtil.getManufactureProcessValue(ManufactureProcessInfo process, Settlement settlement)
          Gets the goods value of a manufacturing process at a settlement.
 

Uses of Settlement in org.mars_sim.msp.core.mars
 

Methods in org.mars_sim.msp.core.mars that return Settlement
 Settlement ExploredLocation.getSettlement()
          The settlement that explored this site.
 

Methods in org.mars_sim.msp.core.mars with parameters of type Settlement
 ExploredLocation SurfaceFeatures.addExploredLocation(Coordinates location, java.util.Map<java.lang.String,java.lang.Double> estimatedMineralConcentrations, Settlement settlement)
          Adds an explored location.
 

Uses of Settlement in org.mars_sim.msp.core.person
 

Methods in org.mars_sim.msp.core.person that return Settlement
 Settlement Person.getAssociatedSettlement()
          Gets the settlement the person is currently associated with.
 Settlement Person.getSettlement()
          Get settlement person is at, null if person is not at a settlement
 

Methods in org.mars_sim.msp.core.person with parameters of type Settlement
 void Person.setAssociatedSettlement(Settlement newSettlement)
          Sets the associated settlement for a person.
 

Constructors in org.mars_sim.msp.core.person with parameters of type Settlement
Person(java.lang.String name, java.lang.String gender, Settlement settlement)
          Constructs a Person object at a given settlement
 

Uses of Settlement in org.mars_sim.msp.core.person.ai.job
 

Methods in org.mars_sim.msp.core.person.ai.job with parameters of type Settlement
static double JobManager.getBestJobProspect(Person person, Settlement settlement, boolean isHomeSettlement)
          Gets the best job prospect value for a person at a settlement.
static double JobManager.getJobProspect(Person person, Job job, Settlement settlement, boolean isHomeSettlement)
          Get the job prospect value for a person and a particular job at a settlement.
static double JobManager.getRemainingSettlementNeed(Settlement settlement, Job job)
          Gets the need for a job at a settlement minus the capability of the inhabitants performing that job there.
 double Biologist.getSettlementNeed(Settlement settlement)
           
 double Botanist.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Technician.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Architect.getSettlementNeed(Settlement settlement)
           
 double Astronomer.getSettlementNeed(Settlement settlement)
           
 double Driver.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
abstract  double Job.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Doctor.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Physicist.getSettlementNeed(Settlement settlement)
           
 double Chemist.getSettlementNeed(Settlement settlement)
           
 double Areologist.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Meteorologist.getSettlementNeed(Settlement settlement)
           
 double Trader.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Chef.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Engineer.getSettlementNeed(Settlement settlement)
          Gets the base settlement need for this job.
 double Mathematician.getSettlementNeed(Settlement settlement)
           
 

Uses of Settlement in org.mars_sim.msp.core.person.ai.mission
 

Methods in org.mars_sim.msp.core.person.ai.mission that return Settlement
 Settlement VehicleMission.findClosestSettlement()
          Finds the closest settlement to the mission.
 Settlement BiologyStudyFieldMission.getAssociatedSettlement()
           
 Settlement BuildingConstructionMission.getAssociatedSettlement()
           
 Settlement Exploration.getAssociatedSettlement()
           
 Settlement Trade.getAssociatedSettlement()
          Gets the settlement associated with the mission.
 Settlement CollectResourcesMission.getAssociatedSettlement()
          Gets the settlement associated with the mission.
abstract  Settlement Mission.getAssociatedSettlement()
          Gets the settlement associated with the mission.
 Settlement Mining.getAssociatedSettlement()
           
 Settlement AreologyStudyFieldMission.getAssociatedSettlement()
           
 Settlement TravelToSettlement.getAssociatedSettlement()
          Gets the settlement associated with the mission.
 Settlement RescueSalvageVehicle.getAssociatedSettlement()
          Gets the settlement associated with the mission.
 Settlement TravelToSettlement.getDestinationSettlement()
          Gets the destination settlement.
 Settlement NavPoint.getSettlement()
          Gets the settlement at the navpoint.
 Settlement RoverMission.getStartingSettlement()
          Gets the starting settlement.
 Settlement Trade.getTradingSettlement()
          Gets the settlement that the starting settlement is trading with.
 

Methods in org.mars_sim.msp.core.person.ai.mission with parameters of type Settlement
static java.util.Map<Good,java.lang.Integer> TradeUtil.addNonProfitsToLoad(Settlement buyingSettlement, Settlement sellingSettlement, Rover rover, java.util.Map<Good,java.lang.Integer> currentLoad, java.util.Set<Good> nonAddGoods, double currentValue, double targetValue)
          Adds to a goods load between a buying settlement and a selling settlement.
protected static boolean RoverMission.areVehiclesAvailable(Settlement settlement, boolean allowMaintReserved)
          Checks to see if any vehicles are available at a settlement.
 void Mission.associateAllMembersWithSettlement(Settlement settlement)
          Associate all mission members with a settlement.
protected static boolean RoverMission.atLeastOnePersonRemainingAtSettlement(Settlement settlement, Person person)
          Checks to see if at least one inhabitant a settlement is remaining there.
static java.util.Map<Good,java.lang.Integer> TradeUtil.determineLoad(Settlement buyingSettlement, Settlement sellingSettlement, Rover rover)
          Determines the load between a buying settlement and a selling settlement.
static double TradeUtil.determineLoadValue(java.util.Map<Good,java.lang.Integer> load, Settlement settlement, boolean buy)
          Determines the value of a load to a settlement.
static Vehicle RescueSalvageVehicle.findAvailableBeaconVehicle(Settlement settlement, double range)
          Finds the closest available rescue or salvage vehicles within range.
static java.util.Map<Good,java.lang.Integer> TradeUtil.getDesiredBuyLoad(Settlement startingSettlement, Rover rover, Settlement tradingSettlement)
          Gets the desired buy load from a trading settlement.
static double TradeUtil.getEstimatedMissionCost(Settlement startingSettlement, Rover rover, double distance)
          Gets the estimated trade mission cost.
 java.util.List<Mission> MissionManager.getMissionsForSettlement(Settlement settlement)
          Gets all the active missions associated with a given settlement.
protected static Vehicle RoverMission.getVehicleWithGreatestRange(Settlement settlement, boolean allowMaintReserved)
          Gets the available vehicle at the settlement with the greatest range.
protected static boolean RoverMission.hasBackupRover(Settlement settlement)
          Checks if there is an available backup rover at the settlement for the mission.
protected static boolean VehicleMission.hasEmbarkingMissions(Settlement settlement)
          Checks to see if there are any currently embarking missions at the settlement.
protected static boolean RoverMission.hasEnoughBasicResources(Settlement settlement)
          Checks if there are enough basic mission resources at the settlement to start mission.
static boolean RescueSalvageVehicle.isClosestCapableSettlement(Settlement thisSettlement, Vehicle thisVehicle)
          Checks if this is the closest settlement to a beacon vehicle that could rescue/salvage it.
protected static boolean RoverMission.minAvailablePeopleAtSettlement(Settlement settlement, int minNum)
          Checks to see if at least a minimum number of people are available for a mission at a settlement.
protected static int CollectResourcesMission.numCollectingContainersAvailable(Settlement settlement, java.lang.Class containerType)
          Gets the number of empty containers of given type at the settlement.
protected  void Trade.performDisembarkToSettlementPhase(Person person, Settlement disembarkSettlement)
          Performs the disembark to settlement phase of the mission.
protected  void RoverMission.performDisembarkToSettlementPhase(Person person, Settlement disembarkSettlement)
          Performs the disembark to settlement phase of the mission.
protected  void Mining.performDisembarkToSettlementPhase(Person person, Settlement disembarkSettlement)
           
protected abstract  void VehicleMission.performDisembarkToSettlementPhase(Person person, Settlement disembarkSettlement)
          Performs the disembark to settlement phase of the mission.
protected  void RescueSalvageVehicle.performDisembarkToSettlementPhase(Person person, Settlement disembarkSettlement)
          Performs the disembark to settlement phase of the mission.
protected  void RoverMission.setStartingSettlement(Settlement startingSettlement)
          Sets the starting settlement.
 

Constructors in org.mars_sim.msp.core.person.ai.mission with parameters of type Settlement
AreologyStudyFieldMission(java.util.Collection<Person> members, Settlement startingSettlement, Person leadResearcher, ScientificStudy study, Rover rover, Coordinates fieldSite, java.lang.String description)
          Constructor with explicit information.
BiologyStudyFieldMission(java.util.Collection<Person> members, Settlement startingSettlement, Person leadResearcher, ScientificStudy study, Rover rover, Coordinates fieldSite, java.lang.String description)
          Constructor with explicit information.
BuildingConstructionMission(java.util.Collection<Person> members, Settlement settlement, ConstructionSite site, ConstructionStageInfo stageInfo, java.util.List<GroundVehicle> vehicles)
          Constructor
CollectIce(java.util.Collection<Person> members, Settlement startingSettlement, java.util.List<Coordinates> iceCollectionSites, Rover rover, java.lang.String description)
          Constructor with explicit data.
CollectRegolith(java.util.Collection<Person> members, Settlement startingSettlement, java.util.List<Coordinates> regolithCollectionSites, Rover rover, java.lang.String description)
          Constructor with explicit data.
Exploration(java.util.Collection<Person> members, Settlement startingSettlement, java.util.List<Coordinates> explorationSites, Rover rover, java.lang.String description)
          Constructor with explicit data.
Mining(java.util.Collection<Person> members, Settlement startingSettlement, ExploredLocation miningSite, Rover rover, LightUtilityVehicle luv, java.lang.String description)
          Constructor with explicit data.
NavPoint(Coordinates location, Settlement settlement, java.lang.String description)
          Constructor with location and settlement.
RescueSalvageVehicle(java.util.Collection<Person> members, Settlement startingSettlement, Vehicle vehicleTarget, Rover rover, java.lang.String description)
          Constructor with explicit data.
Trade(java.util.Collection<Person> members, Settlement startingSettlement, Settlement tradingSettlement, Rover rover, java.lang.String description, java.util.Map<Good,java.lang.Integer> sellGoods, java.util.Map<Good,java.lang.Integer> buyGoods)
          Constructor with explicit data.
TravelToSettlement(java.util.Collection<Person> members, Settlement startingSettlement, Settlement destinationSettlement, Rover rover, java.lang.String description)
          Constructor with explicit data.
 

Uses of Settlement in org.mars_sim.msp.core.person.ai.social
 

Methods in org.mars_sim.msp.core.person.ai.social with parameters of type Settlement
 void RelationshipManager.addInitialSettler(Person person, Settlement settlement)
          Adds an initial settler who will have an existing relationship with all the other inhabitants if his/her settlement.
 

Uses of Settlement in org.mars_sim.msp.core.person.ai.task
 

Methods in org.mars_sim.msp.core.person.ai.task with parameters of type Settlement
static boolean LoadVehicle.enoughCapacityForSupplies(java.util.Map<Resource,java.lang.Number> resources, java.util.Map<java.lang.Class,java.lang.Integer> equipment, Vehicle vehicle, Settlement settlement)
          Checks if a vehicle has enough storage capacity for the supplies needed on the trip.
static boolean LoadVehicle.hasEnoughSupplies(Settlement settlement, Vehicle vehicle, java.util.Map<Resource,java.lang.Number> resources, java.util.Map<java.lang.Class,java.lang.Integer> equipment, int vehicleCrewNum, double tripTime)
          Checks if there are enough supplies in the settlement's stores to supply trip.
 

Constructors in org.mars_sim.msp.core.person.ai.task with parameters of type Settlement
NegotiateTrade(Settlement sellingSettlement, Settlement buyingSettlement, Rover rover, java.util.Map<Good,java.lang.Integer> soldLoad, Person buyingTrader, Person sellingTrader)
          Constructor
 

Uses of Settlement in org.mars_sim.msp.core.science
 

Methods in org.mars_sim.msp.core.science that return Settlement
 Settlement ScientificStudy.getPrimarySettlement()
          Gets the settlement where primary research is conducted.
 

Methods in org.mars_sim.msp.core.science with parameters of type Settlement
 java.util.List<ScientificStudy> ScientificStudyManager.getAllStudies(Settlement settlement)
          Gets a list of all studies a settlement is primary for.
 java.util.List<ScientificStudy> ScientificStudyManager.getCompletedPrimaryStudies(Settlement settlement)
          Gets all completed scientific studies at a primary research settlement.
 java.util.List<ScientificStudy> ScientificStudyManager.getOngoingPrimaryStudies(Settlement settlement)
          Gets all ongoing scientific studies at a primary research settlement.
 

Uses of Settlement in org.mars_sim.msp.core.structure
 

Constructors in org.mars_sim.msp.core.structure with parameters of type Settlement
PowerGrid(Settlement settlement)
          Constructor
ResupplyEvent(Settlement settlement, java.lang.String resupplyName)
          Constructor
 

Uses of Settlement in org.mars_sim.msp.core.structure.building
 

Methods in org.mars_sim.msp.core.structure.building that return Settlement
 Settlement BuildingManager.getSettlement()
          Gets the building manager's settlement.
 

Methods in org.mars_sim.msp.core.structure.building with parameters of type Settlement
static void BuildingManager.addToRandomBuilding(GroundVehicle vehicle, Settlement settlement)
          Adds a ground vehicle to a random ground vehicle maintenance building within a settlement.
static void BuildingManager.addToRandomBuilding(Person person, Settlement settlement)
          Adds a person to a random inhabitable building within a settlement.
 

Constructors in org.mars_sim.msp.core.structure.building with parameters of type Settlement
BuildingManager(Settlement settlement)
          Constructor to construct buildings from settlement config template.
BuildingManager(Settlement settlement, java.util.List<java.lang.String> buildingNames)
          Constructor to construct buildings from name list.
 

Uses of Settlement in org.mars_sim.msp.core.structure.building.function
 

Methods in org.mars_sim.msp.core.structure.building.function with parameters of type Settlement
static double Recreation.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Communication.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double ResourceProcessing.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Farming.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Research.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double LifeSupport.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double MedicalCare.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Dining.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double GroundVehicleMaintenance.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double AstronomicalObservation.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Exercise.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double PowerStorage.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Cooking.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Storage.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double LivingAccommodations.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double EVA.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double PowerGeneration.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
static double Manufacture.getFunctionValue(java.lang.String buildingName, boolean newBuilding, Settlement settlement)
          Gets the value of the function for a named building.
 

Constructors in org.mars_sim.msp.core.structure.building.function with parameters of type Settlement
Crop(CropType cropType, double maxHarvest, Farming farm, Settlement settlement, boolean newCrop)
          Constructor
 

Uses of Settlement in org.mars_sim.msp.core.structure.construction
 

Constructors in org.mars_sim.msp.core.structure.construction with parameters of type Settlement
ConstructionManager(Settlement settlement)
          Constructor
 

Uses of Settlement in org.mars_sim.msp.core.structure.goods
 

Methods in org.mars_sim.msp.core.structure.goods that return Settlement
 Settlement CreditEvent.getSettlement1()
          Gets the first settlement.
 Settlement CreditEvent.getSettlement2()
          Gets the second settlement.
 

Methods in org.mars_sim.msp.core.structure.goods with parameters of type Settlement
 double CreditManager.getCredit(Settlement settlement1, Settlement settlement2)
          Gets the credit between two settlements.
 void CreditManager.setCredit(Settlement settlement1, Settlement settlement2, double amount)
          Sets the credit between two settlements.
 

Constructors in org.mars_sim.msp.core.structure.goods with parameters of type Settlement
CreditEvent(Settlement settlement1, Settlement settlement2, double credit)
          Constructor
GoodsManager(Settlement settlement)
          Constructor
 

Uses of Settlement in org.mars_sim.msp.core.vehicle
 

Methods in org.mars_sim.msp.core.vehicle that return Settlement
 Settlement Vehicle.getSettlement()
          Returns the current settlement vehicle is parked at.
 

Constructors in org.mars_sim.msp.core.vehicle with parameters of type Settlement
LightUtilityVehicle(java.lang.String name, java.lang.String description, Settlement settlement)
           
Rover(java.lang.String name, java.lang.String description, Settlement settlement)
          Constructs a Rover object at a given settlement
Vehicle(java.lang.String name, java.lang.String description, Settlement settlement, double baseSpeed, double baseMass, double fuelEfficiency)
          Constructor to be used for testing.