org.powertac.customer

Class AbstractCustomer

java.lang.Object

org.powertac.customer.AbstractCustomer

All Implemented Interfaces:

org.powertac.common.interfaces.CustomerModelAccessor

Direct Known Subclasses:

ColdStorage

@ConfigurableInstance
public abstract class AbstractCustomer
extends Object
implements org.powertac.common.interfaces.CustomerModelAccessor

Customer models must implement this interface.

Author:

John Collins

Field Summary

Fields

Modifier and Type	Field and Description
protected org.powertac.common.CustomerInfo	customerInfo
protected String	name
protected org.powertac.common.repo.RandomSeedRepo	randomSeedRepo
protected org.powertac.common.repo.TariffRepo	tariffRepo
protected org.powertac.common.repo.TariffSubscriptionRepo	tariffSubscriptionRepo
protected org.powertac.common.repo.WeatherReportRepo	weatherReportRepo

Constructor Summary

Constructors

Constructor and Description
AbstractCustomer()
AbstractCustomer(String name) Sets up basic attributes.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	evaluateTariffs(List<org.powertac.common.Tariff> tariffs) Called to evaluate tariffs.
List<org.powertac.common.TariffSubscription>	getCurrentSubscriptions() Returns the current tariff subscriptions for this model
org.powertac.common.CustomerInfo	getCustomerInfo() Returns the CustomerInfo associated with this instance.
String	getName() Returns the name of this customer instance.
void	initialize() Initializes the instance.
void	setName(String name)
void	setServices(org.powertac.common.repo.RandomSeedRepo randomSeedRepo, org.powertac.common.repo.WeatherReportRepo weatherReportRepo, org.powertac.common.repo.TariffRepo tariffRepo, org.powertac.common.repo.TariffSubscriptionRepo tariffSubscriptionRepo) Populates the instance with service pointers to avoid Spring dependency.
abstract void	step() Called to run the model forward one step.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.powertac.common.interfaces.CustomerModelAccessor

getBrokerSwitchFactor, getCapacityProfile, getInertiaSample, getTariffChoiceSample

Field Detail

name

protected String name

customerInfo

protected org.powertac.common.CustomerInfo customerInfo

weatherReportRepo

protected org.powertac.common.repo.WeatherReportRepo weatherReportRepo

randomSeedRepo

protected org.powertac.common.repo.RandomSeedRepo randomSeedRepo

tariffRepo

protected org.powertac.common.repo.TariffRepo tariffRepo

tariffSubscriptionRepo

protected org.powertac.common.repo.TariffSubscriptionRepo tariffSubscriptionRepo

Constructor Detail

AbstractCustomer

public AbstractCustomer()

AbstractCustomer

public AbstractCustomer(String name)

Sets up basic attributes. Population is 1 unless individual models change it.

Method Detail

setServices

public void setServices(org.powertac.common.repo.RandomSeedRepo randomSeedRepo,
               org.powertac.common.repo.WeatherReportRepo weatherReportRepo,
               org.powertac.common.repo.TariffRepo tariffRepo,
               org.powertac.common.repo.TariffSubscriptionRepo tariffSubscriptionRepo)

Populates the instance with service pointers to avoid Spring dependency.

initialize

public void initialize()

Initializes the instance. Called after configuration, and after a call to setServices(). Subclasses must call this method to get the CustomerInfo registered.

Parameters:

randomSeedRepo -

step

public abstract void step()

Called to run the model forward one step.

evaluateTariffs

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

Called to evaluate tariffs.

getName

public String getName()

Returns the name of this customer instance. Names need not be unique, but unique names will be of considerable value in understanding log file entries.

getCustomerInfo

public org.powertac.common.CustomerInfo getCustomerInfo()

Returns the CustomerInfo associated with this instance. It is up to individual models to fill out the fields.

Specified by:

getCustomerInfo in interface org.powertac.common.interfaces.CustomerModelAccessor

setName

@ConfigurableValue(valueType="String",
                   description="instance name - required")
public void setName(String name)

getCurrentSubscriptions

public List<org.powertac.common.TariffSubscription> getCurrentSubscriptions()

Returns the current tariff subscriptions for this model