|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mars_sim.msp.simulation.structure.building.function.Function
org.mars_sim.msp.simulation.structure.building.function.LifeSupport
public class LifeSupport
The LifeSupport class is a building function for life support and managing inhabitants.
Field Summary | |
---|---|
static java.lang.String |
NAME
|
Constructor Summary | |
---|---|
LifeSupport(Building building)
Constructor |
|
LifeSupport(Building building,
int occupantCapacity,
double powerRequired)
Alternate constructor with given occupant capacity and power required. |
Method Summary | |
---|---|
void |
addPerson(Person person)
Adds a person to the building. |
boolean |
containsPerson(Person person)
Checks if the building contains a particular person. |
int |
getAvailableOccupancy()
Gets the available occupancy room. |
double |
getFullPowerRequired()
Gets the amount of power required when function is at full power. |
int |
getOccupantCapacity()
Gets the building's capacity for supporting occupants. |
int |
getOccupantNumber()
Gets the current number of occupants in the building. |
java.util.Collection<Person> |
getOccupants()
Gets a collection of occupants in the building. |
double |
getPowerDownPowerRequired()
Gets the amount of power required when function is at power down level. |
void |
removePerson(Person occupant)
Removes a person from the building. |
void |
timePassing(double time)
Time passing for the building. |
Methods inherited from class org.mars_sim.msp.simulation.structure.building.function.Function |
---|
getBuilding, getName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NAME
Constructor Detail |
---|
public LifeSupport(Building building) throws BuildingException
building
- the building this function is for.
BuildingException
- if error in constructing function.public LifeSupport(Building building, int occupantCapacity, double powerRequired) throws BuildingException
building
- the building this function is for.occupantCapacity
- the number of occupants this building can hold.powerRequired
- the power required (kW)
BuildingException
- if error constructing function.Method Detail |
---|
public int getOccupantCapacity()
public int getOccupantNumber()
public int getAvailableOccupancy()
public boolean containsPerson(Person person)
public java.util.Collection<Person> getOccupants()
public void addPerson(Person person) throws BuildingException
person
- new person to add to building.
BuildingException
- if person is already building occupant.public void removePerson(Person occupant) throws BuildingException
occupant
- the person to remove from building.
BuildingException
- if person is not building occupant.public void timePassing(double time) throws BuildingException
timePassing
in class Function
time
- amount of time passing (in millisols)
BuildingException
- if error occurs.public double getFullPowerRequired()
getFullPowerRequired
in class Function
public double getPowerDownPowerRequired()
getPowerDownPowerRequired
in class Function
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |