Package org.powertac.householdcustomer

Class HouseholdCustomerService

java.lang.Object

org.powertac.common.interfaces.TimeslotPhaseProcessor

org.powertac.householdcustomer.HouseholdCustomerService

All Implemented Interfaces:

CustomerServiceAccessor, InitializationService, NewTariffListener

@Service
public class HouseholdCustomerService
extends TimeslotPhaseProcessor
implements NewTariffListener, InitializationService, 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	Description
HouseholdCustomerService()	This is the constructor of the Household Consumer Service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.joda.time.Instant time, int phaseNumber)	This method gets called once during each timeslot.
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
CustomerRepo	getCustomerRepo()	Returns a reference to a CustomerRepo
RandomSeedRepo	getRandomSeedRepo()	Returns a reference to a RandomSeedRepo
ServerConfiguration	getServerConfiguration()	Returns a reference to a ServerConfiguration service
TariffMarket	getTariffMarket()	Returns a reference to the TariffMarket
TariffRepo	getTariffRepo()	Returns a reference to a TariffRepo
TariffSubscriptionRepo	getTariffSubscriptionRepo()	Returns a reference to a TariffSubscriptionRepo
TimeService	getTimeService()	Returns a reference to the TimeService
TimeslotRepo	getTimeslotRepo()	Returns a reference to a TimeslotRepo
List<Village>	getVillageList()	This function returns the list of the villages created at the beginning of the game by the service
WeatherReportRepo	getWeatherReportRepo()	Returns a reference to a WeatherReportRepo
String	initialize(Competition competition, List<String> completedInits)	This function called once at the beginning of each game by the server initialization service.
void	publishNewTariffs(List<Tariff> tariffs)	Called periodically with a list of newly-published Tariffs
void	setConfigFile1(String config)

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(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 InitializationService

publishNewTariffs

public void publishNewTariffs(List<Tariff> tariffs)

Description copied from interface: NewTariffListener

Called periodically with a list of newly-published Tariffs

Specified by:

publishNewTariffs in interface 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)

Description copied from class: TimeslotPhaseProcessor

This method gets called once during each timeslot. To get called, the module must first call the register(phaseNumber) method on CompetitionControl. The call will give the current simulation time and phase number in the arguments.

Specified by:

activate in class TimeslotPhaseProcessor

getCustomerRepo

public CustomerRepo getCustomerRepo()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a CustomerRepo

Specified by:

getCustomerRepo in interface CustomerServiceAccessor

getRandomSeedRepo

public RandomSeedRepo getRandomSeedRepo()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a RandomSeedRepo

Specified by:

getRandomSeedRepo in interface CustomerServiceAccessor

getTariffRepo

public TariffRepo getTariffRepo()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a TariffRepo

Specified by:

getTariffRepo in interface CustomerServiceAccessor

getTariffSubscriptionRepo

public TariffSubscriptionRepo getTariffSubscriptionRepo()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a TariffSubscriptionRepo

Specified by:

getTariffSubscriptionRepo in interface CustomerServiceAccessor

getTimeslotRepo

public TimeslotRepo getTimeslotRepo()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a TimeslotRepo

Specified by:

getTimeslotRepo in interface CustomerServiceAccessor

getTimeService

public TimeService getTimeService()

Description copied from interface: CustomerServiceAccessor

Returns a reference to the TimeService

Specified by:

getTimeService in interface CustomerServiceAccessor

getWeatherReportRepo

public WeatherReportRepo getWeatherReportRepo()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a WeatherReportRepo

Specified by:

getWeatherReportRepo in interface CustomerServiceAccessor

getServerConfiguration

public ServerConfiguration getServerConfiguration()

Description copied from interface: CustomerServiceAccessor

Returns a reference to a ServerConfiguration service

Specified by:

getServerConfiguration in interface CustomerServiceAccessor

getTariffMarket

public TariffMarket getTariffMarket()

Description copied from interface: CustomerServiceAccessor

Returns a reference to the TariffMarket

Specified by:

getTariffMarket in interface CustomerServiceAccessor