net.powermatcher.core

Class BaseAgentEndpoint.Connected

java.lang.Object

net.powermatcher.core.BaseAgentEndpoint.Connected

All Implemented Interfaces:

Agent.Status, AgentEndpoint.Status

Enclosing class:

BaseAgentEndpoint

public static class BaseAgentEndpoint.Connected
extends java.lang.Object
implements AgentEndpoint.Status

The BaseAgentEndpoint.Connected object describes the current status and configuration of an AgentEndpoint. This status can be queried through the Agent.getStatus() method and will give a snapshot of the state at that time.

Constructor Summary

Constructors

Constructor and Description
BaseAgentEndpoint.Connected(Session session) Creates a new BaseAgentEndpoint.Connected object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClusterId()
MarketBasis	getMarketBasis()
Session	getSession()
boolean	isConnected() For a agent to be connect, the Agent.setContext(FlexiblePowerContext) has been called and the agent has been configured with a clusterId (and usually a market basis).

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAgentEndpoint.Connected

public BaseAgentEndpoint.Connected(Session session)

Creates a new BaseAgentEndpoint.Connected object.

Parameters:

session - the current Session of the AgentEndpoint.

Method Detail

getClusterId

public java.lang.String getClusterId()

Specified by:

getClusterId in interface Agent.Status

Returns:

the id of the cluster, as received from its Agent parent.

getMarketBasis

public MarketBasis getMarketBasis()

Specified by:

getMarketBasis in interface Agent.Status

Returns:

the current MarketBasis on which this Agent is running and basing its Bids and Prices.

getSession

public Session getSession()

Specified by:

getSession in interface AgentEndpoint.Status

Returns:

the current Session for the connection from this AgentEndpoint to the MatcherEndpoint.

isConnected

public boolean isConnected()

Description copied from interface: Agent.Status

For a agent to be connect, the Agent.setContext(FlexiblePowerContext) has been called and the agent has been configured with a clusterId (and usually a market basis). Only if this is true should the agent be used normally. For an AgentEndpoint this means that it has been connected through a Session. For a MatcherEndpoint is can be connected simply by having a MarketBasis configured (e.g. for an Auctioneer).

Specified by:

isConnected in interface Agent.Status

Returns:

true when the agent is connected to the cluster.