- 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(RegulationCapacity) - Method in class org.powertac.common.RegulationCapacity
-
Adds the capacities in the given RegulationCapacity instance to this
instance.
- 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
- addDownRegulation(double) - Method in class org.powertac.common.RegulationCapacity
-
Adds the given amount of down-regulation capacity.
- 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.
- addUpRegulation(double) - Method in class org.powertac.common.RegulationCapacity
-
Adds the given amount of up-regulation capacity.
- Auctioneer - Interface in org.powertac.common.interfaces
-
Interface that defines the publicly accessible methods
a Power TAC auctioneer has to implement.
- 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, 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.
- 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.
- computeInconvenience(Tariff) - Method in class org.powertac.common.TariffEvaluator
-
Computes composite per-tariff inconvenience of a tariff.
- 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
- CustomerModelAccessor - Interface in org.powertac.common.interfaces
-
Defines an interface for access to customer model details
that support tariff evaluation.
- customerRepo - Variable in class org.powertac.common.AbstractCustomer
-
- 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.
- getBalancingCost() - Method in interface org.powertac.common.interfaces.BalancingMarket
-
Returns the per-timeslot charge for running the balancing market
- getBrokerSwitchFactor(boolean) - Method in interface org.powertac.common.interfaces.CustomerModelAccessor
-
Returns the inconvenience of switching brokers.
- getCapacityProfile(Tariff) - Method in interface org.powertac.common.interfaces.CustomerModelAccessor
-
Returns a capacity profile for the given tariff.
- 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.
- getCurrentSupplyDemandByBroker() - Method in interface org.powertac.common.interfaces.Accounting
-
Returns a mapping of brokers to total supply and demand among subscribed
customers.
- getCurtailment() - Method in class org.powertac.common.TariffSubscription
-
Deprecated.
Use getRegulation() instead, but remember that it returns
a per-member value, while this method returns an aggregate value.
- getCustId() - Method in class org.powertac.common.AbstractCustomer
-
- getCustomer() - Method in class org.powertac.common.TariffSubscription
-
- getCustomerInfo() - Method in class org.powertac.common.AbstractCustomer
-
- getCustomerInfo() - Method in interface org.powertac.common.interfaces.CustomerModelAccessor
-
Returns the CustomerInfo instance for this customer model.
- getCustomersCommitted() - Method in class org.powertac.common.TariffSubscription
-
- getDefaultSpotPrice() - Method in interface org.powertac.common.interfaces.BalancingMarket
-
Returns the value used for spot price per MWh if unavailable from
wholesale market.
- 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.
- getDownRegulationCapacity() - Method in class org.powertac.common.RegulationCapacity
-
Returns the available down-regulation capacity in kWh.
- 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.RegulationCapacity
-
- getId() - Method in class org.powertac.common.TariffSubscription
-
- getInertiaSample() - Method in interface org.powertac.common.interfaces.CustomerModelAccessor
-
Returns a [0,1] random value used to choose whether individual customers
evaluate tariffs or not.
- 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.
- getInterruptibilityFactor() - Method in class org.powertac.common.TariffEvaluator
-
Returns inconvenience of interruptibility.
- getLowerPowerCap() - Method in class org.powertac.common.AbstractCustomer
-
- getMarketBalance(Broker) - Method in interface org.powertac.common.interfaces.BalancingMarket
-
Returns the market balance for a given broker.
- 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.
- getPMinusPrime() - Method in interface org.powertac.common.interfaces.BalancingMarket
-
Returns the slope of cost curve for down-regulation.
- getPopulation(CustomerInfo) - Method in class org.powertac.common.AbstractCustomer
-
- getPPlusPrime() - Method in interface org.powertac.common.interfaces.BalancingMarket
-
Returns the slope of cost curve for up-regulation.
- 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.
- getRegulation(Broker) - Method in interface org.powertac.common.interfaces.BalancingMarket
-
Returns the net regulation energy (positive for up-regulation,
negative for down-regulation) for a given broker.
- getRegulation() - Method in class org.powertac.common.TariffSubscription
-
Returns the regulation quantity exercised per member
in the previous timeslot.
- getRegulationCapacity(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.
- getRemainingRegulationCapacity() - Method in class org.powertac.common.TariffSubscription
-
Returns the maximum aggregate up-regulation possible after the
customer model has run and possibly applied economic controls.
- 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
-
- getTariffChoiceSample() - Method in interface org.powertac.common.interfaces.CustomerModelAccessor
-
Returns a [0,1] random value used to make choices using the logit choice
model.
- getTempToPowerConversion() - Method in class org.powertac.common.AbstractCustomer
-
- getTieredRateFactor() - Method in class org.powertac.common.TariffEvaluator
-
Returns inconvenience of tiered rate.
- getTotalUsage() - Method in class org.powertac.common.TariffSubscription
-
- getTouFactor() - Method in class org.powertac.common.TariffEvaluator
-
Returns inconvenience of time-of-use rate.
- getUpperPowerCap() - Method in class org.powertac.common.AbstractCustomer
-
- getUpRegulationCapacity() - Method in class org.powertac.common.RegulationCapacity
-
Returns the available up-regulation capacity in kWh.
- getValue() - Method in class org.powertac.common.RandomSeed
-
- getVariablePricingFactor() - Method in class org.powertac.common.TariffEvaluator
-
Returns inconvenience of variable pricing.
- getWindToPowerConversion() - Method in class org.powertac.common.AbstractCustomer
-
- 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
- RegulationCapacity - Class in org.powertac.common
-
Represents available regulation capacity for a given TariffSubscription.
- RegulationCapacity(double, double) - Constructor for class org.powertac.common.RegulationCapacity
-
Creates a new RegulationCapacity instance specifying the amounts of
regulating capacity available for up-regulation and down-regulation.
- 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.
- saveBootstrapState() - Method in interface org.powertac.common.interfaces.BootstrapState
-
Saves state at the conclusion of a bootstrap session as configuration
items.
- saveBootstrapState(Object) - Method in interface org.powertac.common.interfaces.ServerConfiguration
-
Gathers state information at the end of a boot session to be restored
in a subsequent sim session.
- 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
-
Deprecated.
- 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
- setDownRegulationCapacity(double) - Method in class org.powertac.common.RegulationCapacity
-
Sets the down-regulation value.
- setRegulationCapacity(RegulationCapacity) - Method in class org.powertac.common.TariffSubscription
-
Communicates the ability of the customer model to handle regulation
requests.
- setTimeslotPhase(int) - Method in class org.powertac.common.interfaces.TimeslotPhaseProcessor
-
This is the Spring-accessible setter for the phase number
- setUpRegulationCapacity(double) - Method in class org.powertac.common.RegulationCapacity
-
Sets the up-regulation value.
- 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, 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