Package org.powertac.common

Power TAC domain types, shared between simulation server and brokers. Most classes in this package are messages that can be exchanged between the server and brokers, and most are immutable. Also in this package are some essential domain services, that must be identical between server and broker, including the TimeService and a message converter.
  • Interface Summary 
    Interface Description
    Action
    This is a simple interface intended to be implemented by anonymous classes that need to create a deferred action of some sort.
    TimedAction
    Generic action type that takes time as an argument.
    ValidatableMessage
    Classes of this type may implement the isValid() method to perform a local validation of the contents of a message.
  • Class Summary 
    Class Description
    BalancingTransaction
    Represents the broker's final supply/demand imbalance in the current timeslot, and the Distribution Utility's charge for this imbalance.
    BankTransaction
    Represents interest charges and payments for brokers.
    Broker
    A broker instance represents a competition participant.
    BrokerTransaction
    Superclass with common attributes for a number of transaction types.
    CapacityTransaction
    Represents the fee assessed by the Distribution Utility for peak capacity events.
    CashPosition
    A CashPosition domain instance represents the current state of a broker's cash account.
    ClearedTrade
    A ClearedTrade instance reports public information about a specific market clearing -- clearing price and total quantity traded.
    Competition
    A competition instance represents a single PowerTAC competition and at the same time serves as the place for all competition properties that can be adjusted during competition setup (i.e.
    CustomerInfo
    A CustomerInfo instance represents a customer model (i.e.
    DistributionTransaction
    Represents the fee assessed by the Distribution Utility for transport of energy over its facilities during the current timeslot.
    HourlyCharge
    Represents the cost of power during a specific timeslot in a variable Rate.
    IdGenerator
    Generates numeric ID values for domain types.
    MarketPosition
    A MarketPosition domain instance represents the current position of a single broker for wholesale power in a given timeslot.
    MarketTransaction
    A MarketTransaction instance represents a trade in the wholesale market.
    Order
    A Order instance represents a market (no price specified) or a limit (min/max price specified) order in the PowerTAC wholesale market.
    Orderbook
    An orderbook instance captures a snapshot of the PowerTAC wholesale market's orderbook (the un-cleared bids and asks remaining after the market is cleared).
    OrderbookOrder
    Each instance is an individual un-cleared entry (a Bid or an Ask) within an Orderbook.
    Rate
    Tariffs are composed of Rates.
    RateCore
    Common supertype of Rate classes, holds tariff ID for this rate.
    RegulationRate
    Tariffs are composed of Rates, including RegulationRates.
    RepeatingTimedAction
    A timedAction
    Tariff
    Entity wrapper for TariffSpecification that supports Tariff evaluation and billing.
    TariffEvaluationHelper
    Probe object that can be used by customer models and other players to generate cost estimates for tariffs, including a risk-adjusted estimates of the actual cost of variable-rate tariffs.
    TariffMessage
    Supertype of all tariff-related messages that can be processed by a TariffMessageProcessor.
    TariffSpecification
    Represents a Tariff offered by a Broker to customers.
    TariffTransaction
    A TariffTransaction instance represents the kWh of energy consumed (kWh < 0) or produced kWh > 0 by some members of a specific customer model, in a specific timeslot, under a particular tariff.
    TimeService
    This is the simulation time-keeper and event queue.
    Timeslot
    A timeslot instance describes an interval of time (slot) for which power may be traded in the wholesale market.
    WeatherForecast
    A collection of weatherForecastPredictions giving hourly forecasts for future timeslots.
    WeatherForecastPrediction
    A weather forecast report instance that describes the weather data
    WeatherReport
    A weather report instance that describes the weather data for one hour of the simulation
    XMLMessageConverter
    Initializes the XStream message serialization system
  • Enum Summary 
    Enum Description
    CustomerInfo.CustomerClass  
    RegulationRate.ResponseTime  
    Tariff.State  
    TariffTransaction.Type