org.powertac.householdcustomer

Class HouseholdCustomerService

java.lang.Object

org.powertac.common.interfaces.TimeslotPhaseProcessor

org.powertac.householdcustomer.HouseholdCustomerService

All Implemented Interfaces:

org.powertac.common.interfaces.CustomerServiceAccessor, org.powertac.common.interfaces.InitializationService, org.powertac.common.interfaces.NewTariffListener

@Service
public class HouseholdCustomerService
extends org.powertac.common.interfaces.TimeslotPhaseProcessor
implements org.powertac.common.interfaces.NewTariffListener, org.powertac.common.interfaces.InitializationService, org.powertac.common.interfaces.CustomerServiceAccessor

Implements the Household Consumer Model. It creates Household Consumers that can subscribe to tariffs, evaluate them in order to choose the best one for its interests, shift their load in order to minimize their costs and many others. They contain different types of households with respect to the way they choose the tariffs and they shift their loads.

Version:

1.5, Date: 2.25.12

Author:

Antonios Chrysopoulos

Constructor Summary

Constructors

Constructor and Description
HouseholdCustomerService() This is the constructor of the Household Consumer Service.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(org.joda.time.Instant time, int phaseNumber) This function finds all the available Household Consumers in the competition and creates a list of their customerInfo.
void	clearConfiguration() This function cleans the configuration files in case they have not been cleaned at the beginning of the game
String	getConfigFile1() Getter method for the first configuration file
org.powertac.common.repo.CustomerRepo	getCustomerRepo()
org.powertac.common.repo.RandomSeedRepo	getRandomSeedRepo()
org.powertac.common.interfaces.ServerConfiguration	getServerConfiguration()
org.powertac.common.repo.TariffRepo	getTariffRepo()
org.powertac.common.repo.TariffSubscriptionRepo	getTariffSubscriptionRepo()
org.powertac.common.TimeService	getTimeService()
org.powertac.common.repo.TimeslotRepo	getTimeslotRepo()
List<Village>	getVillageList() This function returns the list of the villages created at the beginning of the game by the service
org.powertac.common.repo.WeatherReportRepo	getWeatherReportRepo()
String	initialize(org.powertac.common.Competition competition, List<String> completedInits) This function called once at the beginning of each game by the server initialization service.
void	publishNewTariffs(List<org.powertac.common.Tariff> tariffs)
void	setConfigFile1(String config)
void	setDefaults()

Methods inherited from class org.powertac.common.interfaces.TimeslotPhaseProcessor

init, setTimeslotPhase

Methods inherited from class java.lang.Object

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

Constructor Detail

HouseholdCustomerService

public HouseholdCustomerService()

This is the constructor of the Household Consumer Service.

Method Detail

initialize

public String initialize(org.powertac.common.Competition competition,
                List<String> completedInits)

This function called once at the beginning of each game by the server initialization service. Here is where you do pre-game setup. This will read the server properties file to take the competition input variables needed (configuration files, days of competition), create a listener for our service, in order to get the new tariff, as well as create the household Consumers that will be running in the game.

Specified by:

initialize in interface org.powertac.common.interfaces.InitializationService

publishNewTariffs

public void publishNewTariffs(List<org.powertac.common.Tariff> tariffs)

Specified by:

publishNewTariffs in interface org.powertac.common.interfaces.NewTariffListener

getConfigFile1

public String getConfigFile1()

Getter method for the first configuration file

setConfigFile1

@ConfigurableValue(valueType="String",
                   description="first configuration file of the household customers")
public void setConfigFile1(String config)

getVillageList

public List<Village> getVillageList()

This function returns the list of the villages created at the beginning of the game by the service

clearConfiguration

public void clearConfiguration()

This function cleans the configuration files in case they have not been cleaned at the beginning of the game

activate

public void activate(org.joda.time.Instant time,
            int phaseNumber)

This function finds all the available Household Consumers in the competition and creates a list of their customerInfo.

Specified by:

activate in class org.powertac.common.interfaces.TimeslotPhaseProcessor

setDefaults

public void setDefaults()

Specified by:

setDefaults in interface org.powertac.common.interfaces.InitializationService

getCustomerRepo

public org.powertac.common.repo.CustomerRepo getCustomerRepo()

Specified by:

getCustomerRepo in interface org.powertac.common.interfaces.CustomerServiceAccessor

getRandomSeedRepo

public org.powertac.common.repo.RandomSeedRepo getRandomSeedRepo()

Specified by:

getRandomSeedRepo in interface org.powertac.common.interfaces.CustomerServiceAccessor

getTariffRepo

public org.powertac.common.repo.TariffRepo getTariffRepo()

Specified by:

getTariffRepo in interface org.powertac.common.interfaces.CustomerServiceAccessor

getTariffSubscriptionRepo

public org.powertac.common.repo.TariffSubscriptionRepo getTariffSubscriptionRepo()

Specified by:

getTariffSubscriptionRepo in interface org.powertac.common.interfaces.CustomerServiceAccessor

getTimeslotRepo

public org.powertac.common.repo.TimeslotRepo getTimeslotRepo()

Specified by:

getTimeslotRepo in interface org.powertac.common.interfaces.CustomerServiceAccessor

getTimeService

public org.powertac.common.TimeService getTimeService()

Specified by:

getTimeService in interface org.powertac.common.interfaces.CustomerServiceAccessor

getWeatherReportRepo

public org.powertac.common.repo.WeatherReportRepo getWeatherReportRepo()

Specified by:

getWeatherReportRepo in interface org.powertac.common.interfaces.CustomerServiceAccessor

getServerConfiguration

public org.powertac.common.interfaces.ServerConfiguration getServerConfiguration()

Specified by:

getServerConfiguration in interface org.powertac.common.interfaces.CustomerServiceAccessor