Index (Power TAC broker-core 1.6.0 API)

A B C E G H I J L M O P R S

A

Activatable - Interface in org.powertac.samplebroker.interfaces: Interface for services that need to be called when the final TimeslotComplete message has been received from the server in each timeslot.
activate(int) - Method in interface org.powertac.samplebroker.interfaces.Activatable: Called once/timeslot after the TimeslotComplete message has been received.
addProperties(Properties) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService: Adds the Properties structure to the broker configuration.
addProperties(PropertiesConfiguration) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService: Adds the PropertiesConfiguration to the broker configuration.

B

BrokerContext - Interface in org.powertac.samplebroker.interfaces: Provides message handler registration, along with access to competition context information, including The message router for outgoing messages The underlying org.powertac.common.Broker instance The name of this broker The base time for the current simulation The length of common data arrays
BrokerMain - Class in org.powertac.samplebroker.core: This is the top level of a Power TAC broker implementation.
BrokerMain() - Constructor for class org.powertac.samplebroker.core.BrokerMain
BrokerMessageReceiver - Class in org.powertac.samplebroker.core: Receives incoming jms messages for the broker and deserializes them just in case they are to be consumed within the current JVM process.
BrokerMessageReceiver() - Constructor for class org.powertac.samplebroker.core.BrokerMessageReceiver
BrokerPropertiesService - Class in org.powertac.samplebroker.core: Supports annotation-based configuration of broker components from properties or xml config files.
BrokerPropertiesService() - Constructor for class org.powertac.samplebroker.core.BrokerPropertiesService: Default constructor
BrokerRunner - Class in org.powertac.samplebroker.core: Multi-session broker runner.
BrokerRunner() - Constructor for class org.powertac.samplebroker.core.BrokerRunner
BrokerTournamentService - Class in org.powertac.samplebroker.core: Logs a broker into a tournament server, retrieving tournament-specific and game-specific configuration data from the server.
BrokerTournamentService() - Constructor for class org.powertac.samplebroker.core.BrokerTournamentService

C

configureInstances(Class<?>) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
configureMe(Object) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService

E

exportMessage(String) - Method in interface org.powertac.samplebroker.interfaces.IpcAdapter: Sends an incoming server message, in text form, to an out-of-process broker implementation.

G

getBaseTime() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Returns the simulation base time
getBaseTime() - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Returns the simulation base time
getBroker() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Returns the "real" broker underneath this monstrosity
getBroker() - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Returns the org.powerac.common.Broker instance
getBrokerList() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Returns the broker's list of competing brokers - non-public
getBrokerList() - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Returns the broker's list of competing brokers - non-public
getBrokerQueueName() - Method in class org.powertac.samplebroker.core.BrokerTournamentService
getBrokerUsername() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Returns the username for this broker
getBrokerUsername() - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Returns the broker name (username of the underlying Broker)
getDoubleProperty(String, Double) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
getIntegerProperty(String, Integer) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
getJmsBrokerUrl() - Method in class org.powertac.samplebroker.core.JmsManagementService
getJmsUrl() - Method in class org.powertac.samplebroker.core.BrokerTournamentService
getProperty(String) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
getProperty(String, String) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
getServerQueueName() - Method in class org.powertac.samplebroker.core.BrokerTournamentService
getServerQueueName() - Method in class org.powertac.samplebroker.core.JmsManagementService
getServerTimeOffset() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Returns the computed server time offset after login.
getTimeslotCompleted() - Method in class org.powertac.samplebroker.core.PowerTacBroker
getUsageRecordLength() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Returns the length of the standard data array (24h * 7d)
getUsageRecordLength() - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Returns length of data array used for tracking customer consumption/production

H

handleMessage(BrokerAccept) - Method in class org.powertac.samplebroker.core.PowerTacBroker: BrokerAccept comes out when our authentication credentials are accepted and we become part of the game.
handleMessage(Competition) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Handles the Competition instance that arrives at beginning of game.
handleMessage(SimPause) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Receives the SimPause message, used to pause the clock.
handleMessage(SimResume) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Receives the SimResume message, used to update the clock.
handleMessage(SimStart) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Receives the SimStart message, used to start the clock.
handleMessage(SimEnd) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Receives the SimEnd message, which ends the broker session.
handleMessage(TimeslotUpdate) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Updates the sim clock on receipt of the TimeslotUpdate message, which should be the first to arrive in each timeslot.
handleMessage(TimeslotComplete) - Method in class org.powertac.samplebroker.core.PowerTacBroker: TimeslotComplete is the last message sent by the server in each timeslot.

I

init() - Method in class org.powertac.samplebroker.core.BrokerTournamentService
init(String, String) - Method in class org.powertac.samplebroker.core.JmsManagementService
init() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Sets up the "adapter" broker, initializes the other services, registers for incoming messages.
Initializable - Interface in org.powertac.samplebroker.interfaces: Implementations of this interface have their initialize() methods called at the appropriate point in the broker startup sequence.
initialize() - Method in class org.powertac.samplebroker.core.BrokerMessageReceiver
initialize(BrokerContext) - Method in interface org.powertac.samplebroker.interfaces.Initializable: Initializes a service prior to logging in to the server.
IpcAdapter - Interface in org.powertac.samplebroker.interfaces: Implementations are intended to allow out-of-process broker implementation through an inter-process communication path.

J

JmsManagementService - Class in org.powertac.samplebroker.core: Manages the JMS connection to a simulation server.
JmsManagementService() - Constructor for class org.powertac.samplebroker.core.JmsManagementService

L

login(String, String, String, long) - Method in class org.powertac.samplebroker.core.BrokerTournamentService

M

main(String[]) - Static method in class org.powertac.samplebroker.core.BrokerMain: Sets up the broker.
MessageDispatcher - Class in org.powertac.samplebroker.core: Routes incoming messages to broker components, and outgoing messages to the server.
MessageDispatcher() - Constructor for class org.powertac.samplebroker.core.MessageDispatcher: Default constructor

O

onMessage(Message) - Method in class org.powertac.samplebroker.core.BrokerMessageReceiver
openStreams() - Method in interface org.powertac.samplebroker.interfaces.IpcAdapter: Opens output and input streams.
org.powertac.samplebroker.core - package org.powertac.samplebroker.core: Implementation of the core of a Power TAC broker, including time-keeping, server login and communication, message routing, and session management.
org.powertac.samplebroker.interfaces - package org.powertac.samplebroker.interfaces: Interfaces that can be implemented by broker behavioral modules, connecting them to the core and the server.

P

PowerTacBroker - Class in org.powertac.samplebroker.core: This is the top-level controller for a single broker session.
PowerTacBroker() - Constructor for class org.powertac.samplebroker.core.PowerTacBroker: Default constructor for remote broker deployment
processCmdLine(String[]) - Method in class org.powertac.samplebroker.core.BrokerRunner

R

registerMessageHandler(Object, Class<?>) - Method in class org.powertac.samplebroker.core.MessageDispatcher: Sets up handlers for incoming messages by message type.
registerMessageHandler(Object, Class<?>) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Delegates registrations to the router
registerMessageHandler(Object, Class<?>) - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Delegates registrations to the router
registerMessageListener(MessageListener, String) - Method in class org.powertac.samplebroker.core.JmsManagementService
routeMessage(Object) - Method in class org.powertac.samplebroker.core.MessageDispatcher: Routes incoming messages from the server
run() - Method in class org.powertac.samplebroker.core.PowerTacBroker: Logs in and waits for the sim to end.

S

sendMessage(Object) - Method in class org.powertac.samplebroker.core.MessageDispatcher: Converts outgoing message to XML, sends it to the server
sendMessage(Object) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Sends an outgoing message.
sendMessage(Object) - Method in interface org.powertac.samplebroker.interfaces.BrokerContext: Sends an outgoing message.
sendRawMessage(String) - Method in class org.powertac.samplebroker.core.MessageDispatcher: Sends XML-formatted message to the server without interpretation.
setApplicationContext(ApplicationContext) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
setJmsBrokerUrl(String) - Method in class org.powertac.samplebroker.core.JmsManagementService
setProperty(String, Object) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService: Changes the value of a property (or adds a property).
setServerQueueName(String) - Method in class org.powertac.samplebroker.core.JmsManagementService
setUserConfig(File) - Method in class org.powertac.samplebroker.core.BrokerPropertiesService
shutdown() - Method in class org.powertac.samplebroker.core.JmsManagementService
startMessageImport() - Method in interface org.powertac.samplebroker.interfaces.IpcAdapter: Starts a listener for incoming messages, which will be forwarded to the server.
startSession(PropertiesConfiguration, File, long) - Method in class org.powertac.samplebroker.core.PowerTacBroker: Starts a new session, setting parameters from command-line and from config file.

A B C E G H I J L M O P R S