aima.core.agent.impl

Class AbstractEnvironment

java.lang.Object

aima.core.agent.impl.AbstractEnvironment

All Implemented Interfaces:

Environment, EnvironmentViewNotifier

Direct Known Subclasses:

CellWorldEnvironment, MapEnvironment, VacuumEnvironment, XYEnvironment

public abstract class AbstractEnvironment
extends java.lang.Object
implements Environment, EnvironmentViewNotifier

Author:

Ravi Mohan, Ciaran O'Reilly

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<Agent>	agents
protected java.util.Set<EnvironmentObject>	envObjects
protected java.util.Map<Agent,java.lang.Double>	performanceMeasures
protected java.util.Set<EnvironmentView>	views

Constructor Summary

Constructors

Constructor and Description
AbstractEnvironment()

Method Summary

Modifier and Type	Method and Description
void	addAgent(Agent a) Add an agent to the Environment.
void	addEnvironmentObject(EnvironmentObject eo) Add an EnvironmentObject to the Environment.
void	addEnvironmentView(EnvironmentView ev) Add a view on the Environment.
void	createExogenousChange() Method for implementing dynamic environments in which not all changes are directly caused by agent action execution.
abstract void	executeAction(Agent agent, Action action)
java.util.List<Agent>	getAgents() Returns the Agents belonging to this Environment.
java.util.List<EnvironmentObject>	getEnvironmentObjects() Returns the EnvironmentObjects that exist in this Environment.
abstract Percept	getPerceptSeenBy(Agent anAgent)
double	getPerformanceMeasure(Agent forAgent) Retrieve the performance measure associated with an Agent.
boolean	isDone() Returns true if the Environment is finished with its current task(s).
protected void	notifyEnvironmentViews(Agent agent)
protected void	notifyEnvironmentViews(Agent agent, Action action)
void	notifyViews(java.lang.String msg) Notify all registered EnvironmentViews of a message.
void	removeAgent(Agent a) Remove an agent from the environment.
void	removeEnvironmentObject(EnvironmentObject eo) Remove an EnvironmentObject from the Environment.
void	removeEnvironmentView(EnvironmentView ev) Remove a view on the Environment.
void	step() Central template method for controlling agent simulation.
void	step(int n) Move the Environment n time steps forward.
void	stepUntilDone() Step through time steps until the Environment has no more tasks.
protected void	updatePerformanceMeasure(Agent forAgent, double addTo)

Methods inherited from class java.lang.Object

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

Field Detail

envObjects

protected java.util.Set<EnvironmentObject> envObjects

agents

protected java.util.Set<Agent> agents

views

protected java.util.Set<EnvironmentView> views

performanceMeasures

protected java.util.Map<Agent,java.lang.Double> performanceMeasures

Constructor Detail

AbstractEnvironment

public AbstractEnvironment()

Method Detail

executeAction

public abstract void executeAction(Agent agent,
                                   Action action)

getPerceptSeenBy

public abstract Percept getPerceptSeenBy(Agent anAgent)

createExogenousChange

public void createExogenousChange()

Method for implementing dynamic environments in which not all changes are directly caused by agent action execution. The default implementation does nothing.

getAgents

public java.util.List<Agent> getAgents()

Description copied from interface: Environment

Returns the Agents belonging to this Environment.

Specified by:

getAgents in interface Environment

Returns:

The Agents belonging to this Environment.

addAgent

public void addAgent(Agent a)

Description copied from interface: Environment

Add an agent to the Environment.

Specified by:

addAgent in interface Environment

Parameters:

a - the agent to be added.

removeAgent

public void removeAgent(Agent a)

Description copied from interface: Environment

Remove an agent from the environment.

Specified by:

removeAgent in interface Environment

Parameters:

a - the agent to be removed.

getEnvironmentObjects

public java.util.List<EnvironmentObject> getEnvironmentObjects()

Description copied from interface: Environment

Returns the EnvironmentObjects that exist in this Environment.

Specified by:

getEnvironmentObjects in interface Environment

Returns:

the EnvironmentObjects that exist in this Environment.

addEnvironmentObject

public void addEnvironmentObject(EnvironmentObject eo)

Description copied from interface: Environment

Add an EnvironmentObject to the Environment.

Specified by:

addEnvironmentObject in interface Environment

Parameters:

eo - the EnvironmentObject to be added.

removeEnvironmentObject

public void removeEnvironmentObject(EnvironmentObject eo)

Description copied from interface: Environment

Remove an EnvironmentObject from the Environment.

Specified by:

removeEnvironmentObject in interface Environment

Parameters:

eo - the EnvironmentObject to be removed.

step

public void step()

Central template method for controlling agent simulation. The concrete behavior is determined by the primitive operations getPerceptSeenBy(Agent), executeAction(Agent, Action), and createExogenousChange().

Specified by:

step in interface Environment

step

public void step(int n)

Description copied from interface: Environment

Move the Environment n time steps forward.

Specified by:

step in interface Environment

Parameters:

n - the number of time steps to move the Environment forward.

stepUntilDone

public void stepUntilDone()

Description copied from interface: Environment

Step through time steps until the Environment has no more tasks.

Specified by:

stepUntilDone in interface Environment

isDone

public boolean isDone()

Description copied from interface: Environment

Returns true if the Environment is finished with its current task(s).

Specified by:

isDone in interface Environment

Returns:

true if the Environment is finished with its current task(s).

getPerformanceMeasure

public double getPerformanceMeasure(Agent forAgent)

Description copied from interface: Environment

Retrieve the performance measure associated with an Agent.

Specified by:

getPerformanceMeasure in interface Environment

Parameters:

forAgent - the Agent for which a performance measure is to be retrieved.

Returns:

the performance measure associated with the Agent.

addEnvironmentView

public void addEnvironmentView(EnvironmentView ev)

Description copied from interface: Environment

Add a view on the Environment.

Specified by:

addEnvironmentView in interface Environment

Parameters:

ev - the EnvironmentView to be added.

removeEnvironmentView

public void removeEnvironmentView(EnvironmentView ev)

Description copied from interface: Environment

Remove a view on the Environment.

Specified by:

removeEnvironmentView in interface Environment

Parameters:

ev - the EnvironmentView to be removed.

notifyViews

public void notifyViews(java.lang.String msg)

Description copied from interface: Environment

Notify all registered EnvironmentViews of a message.

Specified by:

notifyViews in interface Environment

Specified by:

notifyViews in interface EnvironmentViewNotifier

Parameters:

msg - the message to notify the registered EnvironmentViews with.

updatePerformanceMeasure

protected void updatePerformanceMeasure(Agent forAgent,
                                        double addTo)

notifyEnvironmentViews

protected void notifyEnvironmentViews(Agent agent)

notifyEnvironmentViews

protected void notifyEnvironmentViews(Agent agent,
                                      Action action)