burlap.mdp.singleagent.environment.extensions

Class EnvironmentServer

java.lang.Object

burlap.mdp.singleagent.environment.extensions.EnvironmentServer

All Implemented Interfaces:

Environment, EnvironmentDelegation, EnvironmentServerInterface

Direct Known Subclasses:

EnvironmentServer.StateSettableEnvironmentServer

public class EnvironmentServer
extends java.lang.Object
implements EnvironmentServerInterface, EnvironmentDelegation

A EnvironmentServerInterface implementation that delegates all Environment interactions and request to a provided Environment delegate. This class will also intercept all interactions through the executeAction(Action) and resetEnvironment() methods and tell all EnvironmentOutcome instances registered with this server about the event.

Author:

James MacGlashan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentServer.StateSettableEnvironmentServer

Nested classes/interfaces inherited from interface burlap.mdp.singleagent.environment.extensions.EnvironmentDelegation

EnvironmentDelegation.Helper

Field Summary

Fields

Modifier and Type	Field and Description
protected Environment	delegate the Environment delegate that handles all primary Environment functionality.
protected java.util.List<EnvironmentObserver>	observers The EnvironmentObserver objects that will be notified of Environment events.

Constructor Summary

Constructors

Constructor and Description
EnvironmentServer(Environment delegate, EnvironmentObserver... observers)

Method Summary

Modifier and Type	Method and Description
void	addObservers(EnvironmentObserver... observers) Adds one or more EnvironmentObservers
void	clearAllObservers() Clears all EnvironmentObservers from this server.
static EnvironmentServer	constructor(Environment delegate, EnvironmentObserver... observers) Constructs an EnvironmentServer or EnvironmentServer.StateSettableEnvironmentServer, based on whether the input delegate implements StateSettableEnvironment.
static EnvironmentServerInterface	constructServerOrAddObservers(Environment env, EnvironmentObserver... observers) If the input Environment is an instance EnvironmentServerInterface, then all the input observers are added to it and it is returned.
State	currentObservation() Returns the current observation of the environment as a State.
EnvironmentOutcome	executeAction(Action ga) Executes the specified action in this environment
Environment	getEnvironmentDelegate() Returns the Environment delegate that handles all Environment functionality
boolean	isInTerminalState() Returns whether the environment is in a terminal state that prevents further action by the agent.
double	lastReward() Returns the last reward returned by the environment
java.util.List<EnvironmentObserver>	observers() Returns all EnvironmentObservers registered with this server.
void	removeObservers(EnvironmentObserver... observers) Removes one or more EnvironmentObservers from this server.
void	resetEnvironment() Resets this environment to some initial state, if the functionality exists.
void	setEnvironmentDelegate(Environment delegate) Sets the Environment delegate that handles all Environment functionality

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected Environment delegate

the Environment delegate that handles all primary Environment functionality.

observers

protected java.util.List<EnvironmentObserver> observers

The EnvironmentObserver objects that will be notified of Environment events.

Constructor Detail

EnvironmentServer

public EnvironmentServer(Environment delegate,
                         EnvironmentObserver... observers)

Method Detail

constructServerOrAddObservers

public static EnvironmentServerInterface constructServerOrAddObservers(Environment env,
                                                                       EnvironmentObserver... observers)

If the input Environment is an instance EnvironmentServerInterface, then all the input observers are added to it and it is returned. Otherwise, a new EnvironmentServer is created around it, with all of the observers added.

Parameters:

env - the Environment that will have observers added to it

observers - the EnvironmentObserver objects to add.

Returns:

the input Environment or an EnvironmentServer.

constructor

public static EnvironmentServer constructor(Environment delegate,
                                            EnvironmentObserver... observers)

Constructs an EnvironmentServer or EnvironmentServer.StateSettableEnvironmentServer, based on whether the input delegate implements StateSettableEnvironment.

Parameters:

delegate - the delegate Environment for most environment interactions.

observers - the EnvironmentObserver objects notified of Environment events.

Returns:

an EnvironmentServer or EnvironmentServer.StateSettableEnvironmentServer.

getEnvironmentDelegate

public Environment getEnvironmentDelegate()

Returns the Environment delegate that handles all Environment functionality

Specified by:

getEnvironmentDelegate in interface EnvironmentDelegation

Returns:

the Environment delegate

setEnvironmentDelegate

public void setEnvironmentDelegate(Environment delegate)

Sets the Environment delegate that handles all Environment functionality

Specified by:

setEnvironmentDelegate in interface EnvironmentDelegation

Parameters:

delegate - the Environment delegate

addObservers

public void addObservers(EnvironmentObserver... observers)

Adds one or more EnvironmentObservers

Specified by:

addObservers in interface EnvironmentServerInterface

Parameters:

observers - and EnvironmentObserver

clearAllObservers

public void clearAllObservers()

Clears all EnvironmentObservers from this server.

Specified by:

clearAllObservers in interface EnvironmentServerInterface

removeObservers

public void removeObservers(EnvironmentObserver... observers)

Removes one or more EnvironmentObservers from this server.

Specified by:

removeObservers in interface EnvironmentServerInterface

Parameters:

observers - the EnvironmentObservers to remove.

observers

public java.util.List<EnvironmentObserver> observers()

Returns all EnvironmentObservers registered with this server.

Specified by:

observers in interface EnvironmentServerInterface

Returns:

all EnvironmentObservers registered with this server.

currentObservation

public State currentObservation()

Description copied from interface: Environment

Returns the current observation of the environment as a State.

Specified by:

currentObservation in interface Environment

Returns:

the current observation of the environment as a State.

executeAction

public EnvironmentOutcome executeAction(Action ga)

Description copied from interface: Environment

Executes the specified action in this environment

Specified by:

executeAction in interface Environment

Parameters:

ga - the Action that is to be performed in this environment.

Returns:

the resulting observation and reward transition from applying the given GroundedAction in this environment.

lastReward

public double lastReward()

Description copied from interface: Environment

Returns the last reward returned by the environment

Specified by:

lastReward in interface Environment

Returns:

the last reward returned by the environment

isInTerminalState

public boolean isInTerminalState()

Description copied from interface: Environment

Returns whether the environment is in a terminal state that prevents further action by the agent.

Specified by:

isInTerminalState in interface Environment

Returns:

true if the current environment is in a terminal state; false otherwise.

resetEnvironment

public void resetEnvironment()

Description copied from interface: Environment

Resets this environment to some initial state, if the functionality exists.

Specified by:

resetEnvironment in interface Environment