org.powertac.householdcustomer.customers

Class Village

java.lang.Object

org.powertac.customer.AbstractCustomer

org.powertac.householdcustomer.customers.Village

public class Village
extends AbstractCustomer

The village domain class is a set of households that comprise a small village that consumes aggregated energy by the appliances installed in each household.

Version:

1.5, Date: 2.25.12

Author:

Antonios Chrysopoulos

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Village.TariffEvaluationWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	log logger for trace logging -- use log.info(), log.warn(), and log.error() appropriately.
protected TariffEvaluationHelper	tariffEvalHelper

Fields inherited from class org.powertac.customer.AbstractCustomer

allCustomerInfos, customerInfos, name, rs1, service

Constructor Summary

Constructors

Constructor and Description
Village(String name) This is the constructor function of the Village customer

Method Summary

Modifier and Type	Method and Description
void	consumePower()
void	evaluateTariffs(List<Tariff> tariffs) This is the basic evaluation function, taking into consideration the minimum cost without shifting the appliances' load but the tariff chosen is picked up randomly by using a possibility pattern.
Map<CustomerInfo,String>	getHouseMapping() This function returns the inertia Map variable of the village.
Vector<Household>	getHouses() This function returns a vector with all the houses that are present in this village.
Vector<Household>	getHouses(String type) This function returns a vector with all the households of a certain type that are present in this village.
Map<CustomerInfo,TariffEvaluator>	getTariffEvaluators() This function returns the period Map variable of the village.
void	initialize() Initializes the instance.
void	initialize(Properties conf, int seed, Map<CustomerInfo,String> mapping) This is the initialization function.
void	step() Called to run the model forward one step.
void	subscribeDefault(TariffMarket tariffMarketService)
String	toString()

Methods inherited from class org.powertac.customer.AbstractCustomer

addCustomerInfo, changeSubscription, getCurrentSubscriptions, getCurrentSubscriptions, getCustId, getCustomerInfo, getCustomerInfoList, getCustomerInfos, getId, getName, getPopulation, lastSunday, nextStartOfDay, saveBootstrapState, setName, setServiceAccessor, setTariffMarket, startOfDay

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.logging.log4j.Logger log

logger for trace logging -- use log.info(), log.warn(), and log.error() appropriately. Use log.debug() for output you want to see in testing or debugging.

tariffEvalHelper

protected final TariffEvaluationHelper tariffEvalHelper

Constructor Detail

Village

public Village(String name)

This is the constructor function of the Village customer

Method Detail

initialize

public void initialize()

Description copied from class: AbstractCustomer

Initializes the instance. Called after configuration, and after a call to setServices(). TODO -- do we really want this here?

Overrides:

initialize in class AbstractCustomer

initialize

public void initialize(Properties conf,
                       int seed,
                       Map<CustomerInfo,String> mapping)

This is the initialization function. It uses the variable values for the configuration file to create the village with its households and then fill them with persons and appliances.

Parameters:

conf -

seed -

mapping -

subscribeDefault

public void subscribeDefault(TariffMarket tariffMarketService)

consumePower

public void consumePower()

getHouseMapping

public Map<CustomerInfo,String> getHouseMapping()

This function returns the inertia Map variable of the village.

getTariffEvaluators

public Map<CustomerInfo,TariffEvaluator> getTariffEvaluators()

This function returns the period Map variable of the village.

getHouses

public Vector<Household> getHouses()

This function returns a vector with all the houses that are present in this village.

getHouses

public Vector<Household> getHouses(String type)

This function returns a vector with all the households of a certain type that are present in this village.

evaluateTariffs

public void evaluateTariffs(List<Tariff> tariffs)

This is the basic evaluation function, taking into consideration the minimum cost without shifting the appliances' load but the tariff chosen is picked up randomly by using a possibility pattern. The better tariffs have more chances to be chosen.

Specified by:

evaluateTariffs in class AbstractCustomer

step

public void step()

Description copied from class: AbstractCustomer

Called to run the model forward one step.

Specified by:

step in class AbstractCustomer

toString

public String toString()

Overrides:

toString in class AbstractCustomer