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

java.lang.Object
  extended by org.mars_sim.msp.simulation.structure.building.function.Function
      extended by org.mars_sim.msp.simulation.structure.building.function.PowerGeneration
All Implemented Interfaces:
java.io.Serializable

public class PowerGeneration
extends Function
implements java.io.Serializable

The PowerGeneration class is a building function for generating power.

See Also:
Serialized Form

Field Summary
static java.lang.String NAME
           
 
Constructor Summary
PowerGeneration(Building building)
          Constructor
 
Method Summary
 double getFullPowerRequired()
          Gets the amount of power required when function is at full power.
 double getGeneratedPower()
          Gets the amount of electrical power generated.
 double getPowerDownPowerRequired()
          Gets the amount of power required when function is at power down level.
 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

PowerGeneration

public PowerGeneration(Building building)
                throws BuildingException
Constructor

Parameters:
building - the building this function is for.
Throws:
BuildingException - if error in constructing function.
Method Detail

getGeneratedPower

public double getGeneratedPower()
Gets the amount of electrical power generated.

Returns:
power generated in kW

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)