aima.core.agent

Interface Environment

All Known Implementing Classes:

AbstractEnvironment, CellWorldEnvironment, MapEnvironment, NondeterministicVacuumEnvironment, VacuumEnvironment, XYEnvironment

public interface Environment

An abstract description of possible discrete Environments in which Agent(s) can perceive and act.

Author:

Ravi Mohan, Ciaran O'Reilly, Mike Stampone

Method Summary

Modifier and Type	Method and Description
void	addAgent(Agent agent) 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.
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.
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).
void	notifyViews(java.lang.String msg) Notify all registered EnvironmentViews of a message.
void	removeAgent(Agent agent) 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() Move the Environment one time step forward.
void	step(int n) Move the Environment n time steps forward.
void	stepUntilDone() Step through time steps until the Environment has no more tasks.

Method Detail

getAgents

java.util.List<Agent> getAgents()

Returns the Agents belonging to this Environment.

Returns:

The Agents belonging to this Environment.

addAgent

void addAgent(Agent agent)

Add an agent to the Environment.

Parameters:

agent - the agent to be added.

removeAgent

void removeAgent(Agent agent)

Remove an agent from the environment.

Parameters:

agent - the agent to be removed.

getEnvironmentObjects

java.util.List<EnvironmentObject> getEnvironmentObjects()

Returns the EnvironmentObjects that exist in this Environment.

Returns:

the EnvironmentObjects that exist in this Environment.

addEnvironmentObject

void addEnvironmentObject(EnvironmentObject eo)

Add an EnvironmentObject to the Environment.

Parameters:

eo - the EnvironmentObject to be added.

removeEnvironmentObject

void removeEnvironmentObject(EnvironmentObject eo)

Remove an EnvironmentObject from the Environment.

Parameters:

eo - the EnvironmentObject to be removed.

step

void step()

Move the Environment one time step forward.

step

void step(int n)

Move the Environment n time steps forward.

Parameters:

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

stepUntilDone

void stepUntilDone()

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

isDone

boolean isDone()

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

Returns:

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

getPerformanceMeasure

double getPerformanceMeasure(Agent forAgent)

Retrieve the performance measure associated with an Agent.

Parameters:

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

Returns:

the performance measure associated with the Agent.

addEnvironmentView

void addEnvironmentView(EnvironmentView ev)

Add a view on the Environment.

Parameters:

ev - the EnvironmentView to be added.

removeEnvironmentView

void removeEnvironmentView(EnvironmentView ev)

Remove a view on the Environment.

Parameters:

ev - the EnvironmentView to be removed.

notifyViews

void notifyViews(java.lang.String msg)

Notify all registered EnvironmentViews of a message.

Parameters:

msg - the message to notify the registered EnvironmentViews with.