org.powertac.common.interfaces

Interface PhysicalEnvironment

public interface PhysicalEnvironment

Common Interface for the Physical Environment module.

Version:

0.1, January 2nd, 2011

Author:

David Dauer, Carsten Block

Method Summary

Modifier and Type	Method and Description
List<org.powertac.common.WeatherReport>	generateWeatherData(org.powertac.common.Timeslot currentTimeslot, List<org.powertac.common.Timeslot> targetTimeslots) Generates and returns weather forecasts for every enabled timeslot The physical environment module is responsible for computing weather forecasts for each entry in targetTimeslots from the perspective of the currentTimeslot.

Method Detail

generateWeatherData

List<org.powertac.common.WeatherReport> generateWeatherData(org.powertac.common.Timeslot currentTimeslot,
                                                            List<org.powertac.common.Timeslot> targetTimeslots)

Generates and returns weather forecasts for every enabled timeslot The physical environment module is responsible for computing weather forecasts for each entry in targetTimeslots from the perspective of the currentTimeslot. Note: For the specific resulting Weather instance for which weatherInstance.targetTimeslot == weatherInstance.currentTimeslot (i.e. the "now" timeslot) forecast attribute must be set to false as this is the real (i.e. metered) weather data and not a forecast anymore

Parameters:

currentTimeslot - the current timeslot

targetTimeslots - timeslots to generate weather forecasts for

Returns:

a list of weather forecast objects