forestry.api.genetics

Interface IClimateHelper

All Known Implementing Classes:

ClimateUtil

public interface IClimateHelper

Method Summary

Modifier and Type	Method and Description
java.util.Collection<EnumHumidity>	getToleratedHumidity(EnumHumidity preferred, EnumTolerance tolerance) Gets a collection of humidities which fit the given parameters.
java.util.Collection<EnumTemperature>	getToleratedTemperature(EnumTemperature preferred, EnumTolerance tolerance) Gets a collection of temperatures which fit the given parameters.
boolean	isWithinLimits(EnumHumidity humidity, EnumHumidity baseHumid, EnumTolerance tolHumid)
boolean	isWithinLimits(EnumTemperature temperature, EnumHumidity humidity, EnumTemperature baseTemp, EnumTolerance tolTemp, EnumHumidity baseHumid, EnumTolerance tolHumid) Determines whether the given temperature and humidity are within the given constraints.
boolean	isWithinLimits(EnumTemperature temperature, EnumTemperature baseTemp, EnumTolerance tolTemp)
java.lang.String	toDisplay(EnumHumidity humidity) Gets a localized, human readable string for the given humidity.
java.lang.String	toDisplay(EnumTemperature temperature) Gets a localized, human readable string for the given temperature.

Method Detail

isWithinLimits

boolean isWithinLimits(EnumTemperature temperature,
                       EnumHumidity humidity,
                       EnumTemperature baseTemp,
                       EnumTolerance tolTemp,
                       EnumHumidity baseHumid,
                       EnumTolerance tolHumid)

Determines whether the given temperature and humidity are within the given constraints.

Parameters:

temperature - The temperature to test.

humidity - The humidity to test.

baseTemp - Base temperature for the test.

tolTemp - Temperature tolerance to apply.

baseHumid - Base humidity for the test.

tolHumid - Humidity tolerance to apply.

Returns:

true if both temperature and humidity fit the given constraints.

isWithinLimits

boolean isWithinLimits(EnumTemperature temperature,
                       EnumTemperature baseTemp,
                       EnumTolerance tolTemp)

isWithinLimits

boolean isWithinLimits(EnumHumidity humidity,
                       EnumHumidity baseHumid,
                       EnumTolerance tolHumid)

getToleratedHumidity

java.util.Collection<EnumHumidity> getToleratedHumidity(EnumHumidity preferred,
                                                        EnumTolerance tolerance)

Gets a collection of humidities which fit the given parameters.

Parameters:

preferred - Base humidity from which to measure.

tolerance - Tolerance to apply to the base humidity.

Returns:

A collection of humidities which fall within the given parameters.

getToleratedTemperature

java.util.Collection<EnumTemperature> getToleratedTemperature(EnumTemperature preferred,
                                                              EnumTolerance tolerance)

Gets a collection of temperatures which fit the given parameters.

Parameters:

preferred - Base temperature from which to measure.

tolerance - Tolerance to apply to the base temperatures.

Returns:

A collection of temperatures which fall within the given parameters.

toDisplay

java.lang.String toDisplay(EnumTemperature temperature)

Gets a localized, human readable string for the given temperature.

Parameters:

temperature - Temperature to generate the string for.

Returns:

A localized, human readable string for the given temperature.

toDisplay

java.lang.String toDisplay(EnumHumidity humidity)

Gets a localized, human readable string for the given humidity.

Parameters:

humidity - Humidity to generate the string for.

Returns:

A localized, human readable string for the given humidity.