org.mars_sim.msp.simulation.mars
Class ExploredLocation

java.lang.Object
  extended by org.mars_sim.msp.simulation.mars.ExploredLocation
All Implemented Interfaces:
java.io.Serializable

public class ExploredLocation
extends java.lang.Object
implements java.io.Serializable

A class representing an explored location. It contains information on estimated mineral concentrations and if it has been mined or not. Perhaps later we can add more information related to exploration, such as evidence for life.

See Also:
Serialized Form

Method Summary
 java.util.Map<java.lang.String,java.lang.Double> getEstimatedMineralConcentrations()
          Gets a map of estimated mineral concentrations at the location.
 Coordinates getLocation()
          Gets the location coordinates.
 Settlement getSettlement()
          The settlement that explored this site.
 boolean isExplored()
          Checks if the location has been explored of not.
 boolean isMined()
          Checks if the location has been mined or not.
 boolean isReserved()
          Checks if the location has been reserved for mining.
 void setExplored(boolean explored)
          Sets if the location has been explored or not.
 void setMined(boolean mined)
          Sets if the location has been mined or not.
 void setReserved(boolean reserved)
          Sets if the location has been reserved for mining.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getLocation

public Coordinates getLocation()
Gets the location coordinates.

Returns:
coordinates.

getEstimatedMineralConcentrations

public java.util.Map<java.lang.String,java.lang.Double> getEstimatedMineralConcentrations()
Gets a map of estimated mineral concentrations at the location.

Returns:
a map of all mineral types and their estimated concentrations (0% -100%)

setMined

public void setMined(boolean mined)
Sets if the location has been mined or not.

Parameters:
mined - true if mined.

isMined

public boolean isMined()
Checks if the location has been mined or not.

Returns:
true if mined.

setExplored

public void setExplored(boolean explored)
Sets if the location has been explored or not.

Parameters:
explored - true if explored.

isExplored

public boolean isExplored()
Checks if the location has been explored of not.

Returns:
true if explored.

setReserved

public void setReserved(boolean reserved)
Sets if the location has been reserved for mining.

Parameters:
reserved - true if reserved.

isReserved

public boolean isReserved()
Checks if the location has been reserved for mining.

Returns:
true if reserved.

getSettlement

public Settlement getSettlement()
The settlement that explored this site.

Returns:
settlement