A B C D E F G H I L N O P R S T U V W

A

AbstractCustomer - Class in org.powertac.common

Abstract customer implementation

AbstractCustomer(String) - Constructor for class org.powertac.common.AbstractCustomer

Abstract Customer constructor.

AbstractCustomer(String, ArrayList<CustomerInfo>) - Constructor for class org.powertac.common.AbstractCustomer

Overload of the above constructor

Accounting - Interface in org.powertac.common.interfaces

Common interface for the PowerTAC accounting service.

activate(Instant, int) - Method in interface org.powertac.common.interfaces.Accounting

Runs the accounting process.

activate(Instant, int) - Method in class org.powertac.common.interfaces.TimeslotPhaseProcessor

This method gets called once during each timeslot.

add(TariffSubscription) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Adds an existing subscription to the repo.

addBalancingTransaction(Broker, double, double) - Method in interface org.powertac.common.interfaces.Accounting

Adds a balancing transaction to represent the cost of imbalance

addCustomerInfo(CustomerInfo) - Method in class org.powertac.common.AbstractCustomer

addDistributionTransaction(Broker, double, double) - Method in interface org.powertac.common.interfaces.Accounting

Adds a distribution transaction to represent charges for carrying power

addMarketTransaction(Broker, Timeslot, double, double) - Method in interface org.powertac.common.interfaces.Accounting

Adds a market transaction that includes both a cash component and a product commitment for a specific timeslot.

addTariffTransaction(TariffTransaction.Type, Tariff, CustomerInfo, int, double, double) - Method in interface org.powertac.common.interfaces.Accounting

Adds a tariff transaction to the current-day transaction list.

Auctioneer - Interface in org.powertac.common.interfaces

Interface that defines the publicly accessible methods a Power TAC auctioneer has to implement.

B

bootSession(String, String, String) - Method in interface org.powertac.common.interfaces.CompetitionSetup

Starts a bootstrap session with parameters.

BootstrapDataCollector - Interface in org.powertac.common.interfaces

Object that collects bootstrap data for initializing brokers.

broadcastDeferredMessages() - Method in interface org.powertac.common.interfaces.BrokerProxy

Sends deferred messages

broadcastMessage(Object) - Method in interface org.powertac.common.interfaces.BrokerProxy

Send a message to all brokers

broadcastMessages(List<?>) - Method in interface org.powertac.common.interfaces.BrokerProxy

Sends a list of messages to all brokers

BrokerProxy - Interface in org.powertac.common.interfaces

BrokerProxy is responsible for handling in- and outgoing communication with brokers

C

CapacityControl - Interface in org.powertac.common.interfaces

Support for balancing market interactions between DU and customers/brokers.

carbonEmissionRate - Variable in class org.powertac.common.AbstractCustomer

>=0 - gram CO2 per kW/h

changeSubscription(Tariff, CustomerInfo) - Method in class org.powertac.common.AbstractCustomer

The first implementation of the changing subscription function.

changeSubscription(Tariff, Tariff, CustomerInfo) - Method in class org.powertac.common.AbstractCustomer

In this overloaded implementation of the changing subscription function, Here we just put the tariff we want to change and the whole population is moved to another random tariff.

changeSubscription(Tariff, Tariff, int, CustomerInfo) - Method in class org.powertac.common.AbstractCustomer

In this overloaded implementation of the changing subscription function, Here we just put the tariff we want to change and amount of the population we want to move to the new tariff.

checkRevokedSubscriptions() - Method in class org.powertac.common.AbstractCustomer

The first implementation of the checking for revoked subscriptions function.

clearMarket() - Method in interface org.powertac.common.interfaces.Auctioneer

Clears the market by matching all Orders that have arrived since the last market clearing.

collectBootstrapData(int) - Method in interface org.powertac.common.interfaces.BootstrapDataCollector

Returns a list of bootstrap messages that can be bundled up and sent to brokers at the beginning of a game.

CompetitionControl - Interface in org.powertac.common.interfaces

This is the core of the Power TAC simulation framework, responsible for starting, running, and completing a competition.

CompetitionSetup - Interface in org.powertac.common.interfaces

Handles the pre-game competition setup process.

configureInstances(Class<?>) - Method in interface org.powertac.common.interfaces.ServerConfiguration

Creates and configures potentially multiple instances of a target class annotated as @ConfigurableInstance.

configureMe(Object) - Method in interface org.powertac.common.interfaces.ServerConfiguration

Configures a target object by matching configuration clauses with

consumePower() - Method in class org.powertac.common.AbstractCustomer

The first implementation of the power consumption function.

custId - Variable in class org.powertac.common.AbstractCustomer

The id of the Abstract Customer

customerInfos - Variable in class org.powertac.common.AbstractCustomer

The Customer specifications

customerRepo - Variable in class org.powertac.common.AbstractCustomer

D

deferredUnsubscribe(int) - Method in class org.powertac.common.TariffSubscription

Handles the actual unsubscribe operation.

E

exerciseBalancingControl(BalancingOrder, double, double) - Method in interface org.powertac.common.interfaces.CapacityControl

Creates BalancingControlEvent, posts it on correct TariffSubscription instances.

F

findActiveSubscriptionsForCustomer(CustomerInfo) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Returns the list of active subscriptions for a given customer.

findSubscriptionForTariffAndCustomer(Tariff, CustomerInfo) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

findSubscriptionsForCustomer(CustomerInfo) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Returns the list of subscriptions for a given customer.

findSubscriptionsForTariff(Tariff) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Returns the list of subscriptions for a given tariff.

forwardMessage(Object) - Method in interface org.powertac.common.interfaces.VisualizerProxy

Forwards message to registered listeners

G

generateWeatherData(Timeslot, List<Timeslot>) - Method in interface org.powertac.common.interfaces.PhysicalEnvironment

Generates and returns weather forecasts for every enabled timeslot The physical environment module is responsible for computing weather forecasts for each entry in targetTimeslots from the perspective of the currentTimeslot.

getActiveTariffList(PowerType) - Method in interface org.powertac.common.interfaces.TariffMarket

Returns the list of currently active tariffs for the given PowerType.

getCarbonEmissionRate() - Method in class org.powertac.common.AbstractCustomer

getCurrentMarketPosition(Broker) - Method in interface org.powertac.common.interfaces.Accounting

Returns the market position for the current timeslot for a given broker.

getCurrentNetLoad(Broker) - Method in interface org.powertac.common.interfaces.Accounting

Returns the current net load represented by unprocessed TariffTransactions for a specific Broker.

getCurtailableUsage(BalancingOrder) - Method in interface org.powertac.common.interfaces.CapacityControl

Gathers up power usage data for the current timeslot that could be subject to a BalancingOrder.

getCurtailment() - Method in class org.powertac.common.TariffSubscription

Returns the curtailment in kwh for the previous timeslot.

getCustId() - Method in class org.powertac.common.AbstractCustomer

getCustomer() - Method in class org.powertac.common.TariffSubscription

getCustomerInfo() - Method in class org.powertac.common.AbstractCustomer

getCustomersCommitted() - Method in class org.powertac.common.TariffSubscription

getDefaultTariff(PowerType) - Method in interface org.powertac.common.interfaces.TariffMarket

Returns the default tariff.

getDoubleProperty(String, Double) - Method in interface org.powertac.common.interfaces.ServerProperties

Returns the value of the named property as a Double, or defaultValue if no such property is found.

getExpiredCustomerCount() - Method in class org.powertac.common.TariffSubscription

Returns the number of individual customers who may withdraw from this subscription without penalty.

getId() - Method in class org.powertac.common.AbstractCustomer

Synonym for getCustId()

getId() - Method in class org.powertac.common.RandomSeed

getId() - Method in class org.powertac.common.TariffSubscription

getIntegerProperty(String, Integer) - Method in interface org.powertac.common.interfaces.ServerProperties

Returns the value of the named property as an Integer, or defaultValue if no such property is found.

getLowerPowerCap() - Method in class org.powertac.common.AbstractCustomer

getMaxRemainingCurtailment() - Method in class org.powertac.common.TariffSubscription

Returns the maximum curtailment possible after the customer model has run and possibly applied economic controls.

getName() - Method in class org.powertac.common.AbstractCustomer

getPendingTariffTransactions() - Method in interface org.powertac.common.interfaces.Accounting

Returns the list of pending tariff transactions for the current timeslot.

getPopulation() - Method in class org.powertac.common.AbstractCustomer

getProperty(String) - Method in interface org.powertac.common.interfaces.ServerProperties

Returns the value of the property with the given name, or null if no such property is found.

getProperty(String, String) - Method in interface org.powertac.common.interfaces.ServerProperties

Returns the value of the named property, or the defaultValue if no such property is found.

getPurpose() - Method in class org.powertac.common.RandomSeed

getRandomSeed(String, long, String) - Method in class org.powertac.common.repo.RandomSeedRepo

Returns the RandomSeed instance identified by classname, id, and purpose, creating it if necessary.

getRequesterClass() - Method in class org.powertac.common.RandomSeed

getRequesterId() - Method in class org.powertac.common.RandomSeed

getRevokedSubscriptionList(CustomerInfo) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Returns the list of subscriptions for this customer that have been revoked and have non-zero committed customer counts.

getSubscription(CustomerInfo, Tariff) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Returns the TariffSubscription for the given Tariff/Customer pair, creating it if necessary.

getSunToPowerConversion() - Method in class org.powertac.common.AbstractCustomer

getTariff() - Method in class org.powertac.common.TariffSubscription

getTempToPowerConversion() - Method in class org.powertac.common.AbstractCustomer

getTotalUsage() - Method in class org.powertac.common.TariffSubscription

getUpperPowerCap() - Method in class org.powertac.common.AbstractCustomer

getValue() - Method in class org.powertac.common.RandomSeed

getWindToPowerConversion() - Method in class org.powertac.common.AbstractCustomer

H

handleRevokedTariff() - Method in class org.powertac.common.TariffSubscription

Handles the subscription switch in case the underlying Tariff has been revoked.

I

init() - Method in class org.powertac.common.interfaces.TimeslotPhaseProcessor

This method must be called in the per-game initialization code in each implementing class.

InitializationService - Interface in org.powertac.common.interfaces

Implementations of this interface are expected to initialize individual plugins prior to the beginning of a game.

initialize(Competition, List<String>) - Method in interface org.powertac.common.interfaces.InitializationService

Initializes a plugin prior to the beginning of a game.

isBootstrapMode() - Method in interface org.powertac.common.interfaces.CompetitionControl

True just in case the sim is running in bootstrap mode - generating bootstrap data.

isRunning() - Method in interface org.powertac.common.interfaces.CompetitionControl

True if a simulation (boot or sim) session is currently running.

L

loadSeeds(File) - Method in class org.powertac.common.repo.RandomSeedRepo

Pre-loads seeds from an existing server logfile, or from a stripped-down logfile containing only the RandomSeed lines.

log - Static variable in class org.powertac.common.AbstractCustomer

loginBroker(String) - Method in interface org.powertac.common.interfaces.CompetitionControl

Attempts to log in a broker by username.

lowerPowerCap - Variable in class org.powertac.common.AbstractCustomer

>0: min power consumption (think refrigerator); <0: max power production (think power plant with max capacity)

N

name - Variable in class org.powertac.common.AbstractCustomer

The name of the Abstract Customer

NewTariffListener - Interface in org.powertac.common.interfaces

Implementors of this interface can be notified of new tariff publication by calling registerNewTariffListener(this) on the TariffMarket.

O

org.powertac.common - package org.powertac.common

org.powertac.common.interfaces - package org.powertac.common.interfaces

org.powertac.common.repo - package org.powertac.common.repo

P

PhysicalEnvironment - Interface in org.powertac.common.interfaces

Common Interface for the Physical Environment module.

postBalancingControl(double) - Method in class org.powertac.common.TariffSubscription

Posts a BalancingControlEvent to the subscription.

postEconomicControl(EconomicControlEvent) - Method in interface org.powertac.common.interfaces.CapacityControl

Posts an EconomicControlEvent on the correct TariffSubscription instances.

postRatioControl(double) - Method in class org.powertac.common.TariffSubscription

Posts the ratio for an EconomicControlEvent to the subscription for the current timeslot.

preGame() - Method in interface org.powertac.common.interfaces.CompetitionSetup

Runs the pre-game cycle of the simulator, which sets all plugin components to their default state.

processOrder(Order) - Method in interface org.powertac.common.interfaces.Auctioneer

Processes an incoming order, typically by saving it on a list for the next market clearing.

processRevokedTariffs() - Method in interface org.powertac.common.interfaces.TariffMarket

Revokes tariffs for which TariffRevoke messages have been received since the last time this method was called in an earlier timeslot.

producePower() - Method in class org.powertac.common.AbstractCustomer

The first implementation of the power consumption function.

publishConfiguration(Object) - Method in interface org.powertac.common.interfaces.ServerConfiguration

Gathers public configuration data for publication to brokers.

publishNewTariffs(List<Tariff>) - Method in interface org.powertac.common.interfaces.NewTariffListener

Called periodically with a list of newly-published Tariffs

R

RandomSeed - Class in org.powertac.common

RandomSeed is used to store generated random seed in the database in order to be able to "replay" PowerTAC competitions later on with exactly the same random seed settings as originally used.

RandomSeed(String, long, String) - Constructor for class org.powertac.common.RandomSeed

Constructor that creates a new seed with a random value.

RandomSeed(String, long, String, long) - Constructor for class org.powertac.common.RandomSeed

Constructor to re-create a random seed with a given value.

randomSeedRepo - Variable in class org.powertac.common.AbstractCustomer

RandomSeedRepo - Class in org.powertac.common.repo

Repository for RandomSeed instances.

RandomSeedRepo() - Constructor for class org.powertac.common.repo.RandomSeedRepo

receiveMessage(Object) - Method in interface org.powertac.common.interfaces.VisualizerMessageListener

recycle() - Method in class org.powertac.common.repo.RandomSeedRepo

recycle() - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Clears out the repo in preparation for another simulation.

registerBrokerMessageListener(Object, Class<?>) - Method in interface org.powertac.common.interfaces.BrokerProxy

Sets up a dispatch listener for market messages

registerNewTariffListener(NewTariffListener) - Method in interface org.powertac.common.interfaces.TariffMarket

Registers a listener for publication of new Tariffs.

registerTimeslotPhase(TimeslotPhaseProcessor, int) - Method in interface org.powertac.common.interfaces.CompetitionControl

Registers the caller to be activated during each timeslot in the proper phase sequence.

registerVisualizerMessageListener(VisualizerMessageListener) - Method in interface org.powertac.common.interfaces.VisualizerProxy

Sets up a dispatch listener for market messages

removeSubscriptionsForTariff(Tariff) - Method in class org.powertac.common.repo.TariffSubscriptionRepo

Removes all subscriptions for the given tariff.

routeMessage(Object) - Method in interface org.powertac.common.interfaces.BrokerProxy

Routes a message to server components.

rs1 - Variable in class org.powertac.common.AbstractCustomer

Random Number Generator

runOnce(boolean) - Method in interface org.powertac.common.interfaces.CompetitionControl

Waits for broker login, then starts and runs a simulation.

S

selectTariff(PowerType) - Method in class org.powertac.common.AbstractCustomer

The first implementation of the tariff selection function.

sendMessage(Broker, Object) - Method in interface org.powertac.common.interfaces.BrokerProxy

Send a message to a specific broker

sendMessages(Broker, List<?>) - Method in interface org.powertac.common.interfaces.BrokerProxy

Sends a list of messages to a specific broker

ServerConfiguration - Interface in org.powertac.common.interfaces

Support for annotation-driven configuration.

ServerProperties - Interface in org.powertac.common.interfaces

Supports server configuration by allowing components to retrieve property values from a standard Java properties file.

setAuthorizedBrokerList(List<String>) - Method in interface org.powertac.common.interfaces.CompetitionControl

Sets the list of brokers authorized to log in to the next game.

setDefaults() - Method in interface org.powertac.common.interfaces.InitializationService

Creates and saves default PluginConfig instances.

setDefaultTariff(TariffSpecification) - Method in interface org.powertac.common.interfaces.TariffMarket

Convenience method to set the default tariff at the beginning of the game.

setDeferredBroadcast(boolean) - Method in interface org.powertac.common.interfaces.BrokerProxy

Holds up message transmission when true

setTimeslotPhase(int) - Method in class org.powertac.common.interfaces.TimeslotPhaseProcessor

This is the Spring-accessible setter for the phase number

shutDown() - Method in interface org.powertac.common.interfaces.CompetitionControl

Stops a running simulation, and sends out the SimEnd message to brokers.

simSession(String, String, String, String, List<String>, String) - Method in interface org.powertac.common.interfaces.CompetitionSetup

Starts a simulation session with parameters, in a new thread.

step() - Method in class org.powertac.common.AbstractCustomer

subscribe(Tariff, int, CustomerInfo) - Method in class org.powertac.common.AbstractCustomer

Subscribing a certain population amount to a certain subscription

subscribe(int) - Method in class org.powertac.common.TariffSubscription

Subscribes some number of discrete customers.

subscribeDefault() - Method in class org.powertac.common.AbstractCustomer

Function utilized at the beginning in order to subscribe to the default tariff

subscribeToTariff(Tariff, CustomerInfo, int) - Method in interface org.powertac.common.interfaces.TariffMarket

Subscribes a block of Customers from a single Customer model to the specified Tariff, as long as the Tariff has not expired.

sunToPowerConversion - Variable in class org.powertac.common.AbstractCustomer

measures how sun intensity changes translate into load /generation changes of the customer

T

TariffMarket - Interface in org.powertac.common.interfaces

Tariff Market Receives, validates, and stores new tariffs, enforces tariff validity rules.

tariffMarketService - Variable in class org.powertac.common.AbstractCustomer

TariffSubscription - Class in org.powertac.common

A TariffSubscription is an entity representing an association between a Customer and a Tariff.

TariffSubscription(CustomerInfo, Tariff) - Constructor for class org.powertac.common.TariffSubscription

tariffSubscriptionRepo - Variable in class org.powertac.common.AbstractCustomer

TariffSubscriptionRepo - Class in org.powertac.common.repo

Repository for TariffSubscriptions.

TariffSubscriptionRepo() - Constructor for class org.powertac.common.repo.TariffSubscriptionRepo

tempToPowerConversion - Variable in class org.powertac.common.AbstractCustomer

measures how temperature changes translate into load / generation changes of the customer

TimeslotPhaseProcessor - Class in org.powertac.common.interfaces

Plugins must extend this class in order to be invoked during timeslot processing by the CompetitionControl.

TimeslotPhaseProcessor() - Constructor for class org.powertac.common.interfaces.TimeslotPhaseProcessor

toString() - Method in class org.powertac.common.AbstractCustomer

U

unsubscribe(TariffSubscription, int) - Method in class org.powertac.common.AbstractCustomer

Unsubscribing a certain population amount from a certain subscription

unsubscribe(int) - Method in class org.powertac.common.TariffSubscription

Removes customerCount customers (at most) from this subscription, posts early-withdrawal fees if appropriate.

upperPowerCap - Variable in class org.powertac.common.AbstractCustomer

>0: max power consumption (think consumer with fuse limit); <0: min power production (think nuclear power plant with min output)

usePower(double) - Method in class org.powertac.common.TariffSubscription

Generates and returns a TariffTransaction instance for the current timeslot that represents the amount of production (negative amount) or consumption (positive amount), along with the credit/debit that results.

V

VisualizerMessageListener - Interface in org.powertac.common.interfaces

Implementors of this interface will be notified of selected events necessary for visualization by calling registerVisualizerMessageListener(this) on VisualizerProxy.

VisualizerProxy - Interface in org.powertac.common.interfaces

Visualization Proxy is responsible for forwarding selected server data to any registered visualizer

W

windToPowerConversion - Variable in class org.powertac.common.AbstractCustomer

measures how wind changes translate into load / generation changes of the customer

A B C D E F G H I L N O P R S T U V W