org.mars_sim.msp.simulation.structure.building.function
Class Storage

java.lang.Object
  org.mars_sim.msp.simulation.structure.building.function.Function
      org.mars_sim.msp.simulation.structure.building.function.Storage

All Implemented Interfaces:

java.io.Serializable

public class Storage
extends Function
implements java.io.Serializable

The storage class is a building function for storing resources and units.

See Also:

Serialized Form

Field Summary

static java.lang.String

NAME

Constructor Summary

Storage(Building building)
Constructor

Method Summary

double	getFullPowerRequired() Gets the amount of power required when function is at full power.
double	getPowerDownPowerRequired() Gets the amount of power required when function is at power down level.
java.util.Map	getResourceStorageCapacity() Gets a map of the resources this building is capable of storing and their amounts in kg.
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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

Storage

public Storage(Building building)
        throws BuildingException

Constructor

Parameters:

building - the building the function is for.

Throws:

BuildingException - if function cannot be constructed.

Method Detail

getResourceStorageCapacity

public java.util.Map getResourceStorageCapacity()

Gets a map of the resources this building is capable of storing and their amounts in kg.

Returns:

Map of resource keys and amount Double values.

timePassing

public void timePassing(double time)
                 throws BuildingException

Time passing for the building.

Specified by:

timePassing in class Function

Parameters:

time - amount of time passing (in millisols)

Throws:

BuildingException - if error occurs.

getFullPowerRequired

public double getFullPowerRequired()

Gets the amount of power required when function is at full power.

Specified by:

getFullPowerRequired in class Function

Returns:

power (kW)

getPowerDownPowerRequired

public double getPowerDownPowerRequired()

Gets the amount of power required when function is at power down level.

Specified by:

getPowerDownPowerRequired in class Function

Returns:

power (kW)