forestry.core.utils

Class ClimateUtil

java.lang.Object

forestry.core.utils.ClimateUtil

All Implemented Interfaces:

IClimateHelper

public class ClimateUtil
extends java.lang.Object
implements IClimateHelper

Constructor Summary

Constructors

Constructor and Description
ClimateUtil()

Method Summary

Modifier and Type	Method and Description
static void	addClimateErrorStates(EnumTemperature temperature, EnumHumidity humidity, EnumTemperature baseTemp, EnumTolerance tolTemp, EnumHumidity baseHumid, EnumTolerance tolHumid, java.util.Set<IErrorState> errorStates)
static int	getColor(EnumTemperature temperature)
java.util.ArrayList<EnumHumidity>	getToleratedHumidity(EnumHumidity prefered, EnumTolerance tolerance) Gets a collection of humidities which fit the given parameters.
java.util.ArrayList<EnumTemperature>	getToleratedTemperature(EnumTemperature prefered, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClimateUtil

public ClimateUtil()

Method Detail

isWithinLimits

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

Description copied from interface: IClimateHelper

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

Specified by:

isWithinLimits in interface IClimateHelper

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

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

Specified by:

isWithinLimits in interface IClimateHelper

isWithinLimits

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

Specified by:

isWithinLimits in interface IClimateHelper

getToleratedHumidity

public java.util.ArrayList<EnumHumidity> getToleratedHumidity(EnumHumidity prefered,
                                                              EnumTolerance tolerance)

Description copied from interface: IClimateHelper

Gets a collection of humidities which fit the given parameters.

Specified by:

getToleratedHumidity in interface IClimateHelper

Parameters:

prefered - 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

public java.util.ArrayList<EnumTemperature> getToleratedTemperature(EnumTemperature prefered,
                                                                    EnumTolerance tolerance)

Description copied from interface: IClimateHelper

Gets a collection of temperatures which fit the given parameters.

Specified by:

getToleratedTemperature in interface IClimateHelper

Parameters:

prefered - 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

public java.lang.String toDisplay(EnumTemperature temperature)

Description copied from interface: IClimateHelper

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

Specified by:

toDisplay in interface IClimateHelper

Parameters:

temperature - Temperature to generate the string for.

Returns:

A localized, human readable string for the given temperature.

toDisplay

public java.lang.String toDisplay(EnumHumidity humidity)

Description copied from interface: IClimateHelper

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

Specified by:

toDisplay in interface IClimateHelper

Parameters:

humidity - Humidity to generate the string for.

Returns:

A localized, human readable string for the given humidity.

addClimateErrorStates

public static void addClimateErrorStates(EnumTemperature temperature,
                                         EnumHumidity humidity,
                                         EnumTemperature baseTemp,
                                         EnumTolerance tolTemp,
                                         EnumHumidity baseHumid,
                                         EnumTolerance tolHumid,
                                         java.util.Set<IErrorState> errorStates)

getColor

public static int getColor(EnumTemperature temperature)