java.lang.Object
- org.powertac.common.interfaces.TimeslotPhaseProcessor
- - org.powertac.customer.CustomerModelService

All Implemented Interfaces:

BootstrapState, CustomerServiceAccessor, InitializationService, NewTariffListener
```
@Service
public class CustomerModelService
extends TimeslotPhaseProcessor
implements InitializationService, BootstrapState, NewTariffListener, CustomerServiceAccessor
```
Manages a set of customer models. Each must be configurable as ConfigurableInstances. Each gets supplied a set of service interfaces. In each timeslot, each model has its step() method called. When tariffs are published, each has its evaluateTariffs() method called. At the end of a boot session, each has its bootstrap state saved to the boot record.

Author:

John Collins

Constructor Summary

Constructors
Constructor Description

CustomerModelService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`activate(org.joda.time.Instant time, int phaseNumber)`	This method gets called once during each timeslot.
`org.powertac.common.repo.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
`org.powertac.common.repo.TariffRepo`	`getTariffRepo()`	Returns a reference to a TariffRepo
`TariffSubscriptionRepo`	`getTariffSubscriptionRepo()`	Returns a reference to a TariffSubscriptionRepo
`org.powertac.common.TimeService`	`getTimeService()`	Returns a reference to the TimeService
`org.powertac.common.repo.TimeslotRepo`	`getTimeslotRepo()`	Returns a reference to a TimeslotRepo
`org.powertac.common.repo.WeatherReportRepo`	`getWeatherReportRepo()`	Returns a reference to a WeatherReportRepo
`String`	`initialize(org.powertac.common.Competition competition, List<String> completedInits)`	Initializes a plugin prior to the beginning of a game.
`void`	`publishNewTariffs(List<org.powertac.common.Tariff> tariffs)`	Called periodically with a list of newly-published Tariffs
`void`	`saveBootstrapState()`	Saves state at the conclusion of a bootstrap session as configuration items.

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
  - CustomerModelService
```
public CustomerModelService()
```
- Method Detail
  - initialize
```
public String initialize(org.powertac.common.Competition competition,
                         List<String> completedInits)
```
    Description copied from interface: InitializationService
    
    Initializes a plugin prior to the beginning of a game. The completedInits parameter is the list of plugin role names that have been successfully initialized. If sequence dependencies are satisfied (or if there are no sequence dependencies), then an implementation must complete its pre-game initialization process and return its role name. If sequence dependencies are not satisfied, then an implementation must return null. It will be called again after additional successful initializations have been completed. If initialization is not possible, then returning the string 'fail' will cause the server to log an error and shut down. This will be helpful just in case the implementation also logs a detailed error message.
    
    Specified by:
    
    initialize in interface InitializationService
  - 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
  - publishNewTariffs
```
public void publishNewTariffs(List<org.powertac.common.Tariff> tariffs)
```
    Description copied from interface: NewTariffListener
    
    Called periodically with a list of newly-published Tariffs
    
    Specified by:
    
    publishNewTariffs in interface NewTariffListener
  - saveBootstrapState
```
public void saveBootstrapState()
```
    Description copied from interface: BootstrapState
    
    Saves state at the conclusion of a bootstrap session as configuration items. State can then be restored at the beginning of the sim session through the normal configuration process. The usual way to save state is to call ServerPropertiesService.saveBootstrapState(arg), where arg is either a single configurable object (configured with configureMe() or configureSingleton()), or a list of objects annotated with ConfigurableInstance.
    
    Specified by:
    
    saveBootstrapState in interface BootstrapState
  - getCustomerRepo
```
public org.powertac.common.repo.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 org.powertac.common.repo.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 org.powertac.common.repo.TimeslotRepo getTimeslotRepo()
```
    Description copied from interface: CustomerServiceAccessor
    
    Returns a reference to a TimeslotRepo
    
    Specified by:
    
    getTimeslotRepo in interface CustomerServiceAccessor
  - getTimeService
```
public org.powertac.common.TimeService getTimeService()
```
    Description copied from interface: CustomerServiceAccessor
    
    Returns a reference to the TimeService
    
    Specified by:
    
    getTimeService in interface CustomerServiceAccessor
  - getWeatherReportRepo
```
public org.powertac.common.repo.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

Class CustomerModelService

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CustomerModelService

Method Detail

initialize

activate

publishNewTariffs

saveBootstrapState

getCustomerRepo

getRandomSeedRepo

getTariffRepo

getTariffSubscriptionRepo

getTimeslotRepo

getTimeService

getWeatherReportRepo

getServerConfiguration

getTariffMarket