PackageWorld

java.lang.Object
- agent.Environment
- - pacworld.PackageWorld

```
public class PackageWorld
extends Environment
```
A simulator for the package delivery world environment.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.io.PrintWriter`	`actLog`
`protected float`	`avgEffort`
`protected static boolean`	`batch` Run in batch mode? If true, then simulation automatically runs when started and doesn't display a summary dialog window.
`protected int`	`count` The number of turns (each agent's sense/act pair is a turn)
`static int`	`DEFAULT_NUM_AGENTS`
`static int`	`DEFAULT_NUM_DESTINATIONS` Number of destinations.
`static int`	`DEFAULT_NUM_PACKAGES` Number of packages.
`static int`	`DEFAULT_WORLD_SIZE` The length (and width) of the world.
`protected int`	`delivered` The number of packages successfully delivered.
`protected PackageState`	`initState`
`static int`	`MAX_NUM_DESTINATIONS`
`protected float`	`msgLengthPerTurn`
`protected int`	`numAgents`
`protected int`	`numDestinations`
`protected int`	`numPackages`
`PacGUI`	`pg` The GUI that displays the current world
`protected float`	`thinkPerTurn`
`protected long`	`thinkTime` The number of milliseconds used by agents to process percepts and choose actions.
`protected int`	`worldSize`

Fields inherited from class agent.Environment
agents, state

Constructor Summary

Constructors
Constructor and Description

PackageWorld()

PackageWorld(java.io.PrintWriter actLog)

Constructors
Constructor and Description
`PackageWorld()`
`PackageWorld(java.io.PrintWriter actLog)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAgent(Agent agent)` Add a new agent to the environment.
`java.util.List<Agent>`	`getAgents()` Returns a list of the agents in the environment.
`int`	`getNumAgents()` Return the number of agents in the environment.
`protected Percept`	`getPercept(Agent agt)` Create a percept for an agent.
`int`	`getPerformanceMeasure(Agent a)` Return the performance measure of the agent in the current environment.
`java.lang.String`	`getScoreMsg()` Returns a string containing score information for the agent team.
`int`	`getTeamPerformanceMeasure()` Return the performance measure of a team of agents in a cooperative environment.
`int`	`getWorldSize()` Return the size of the grid for the environment.
`protected boolean`	`isComplete()` The simulation is complete when all packages have been delivered or nothing has happened for two cycles or no packages have been picked up or dropped off for 5 * n cycles.
`void`	`logMessage(java.lang.String message)` Outputs a message to the log and the GUI.
`static void`	`main(java.lang.String[] args)` Starts the program.
`void`	`resetAgents()` Clears all agents from the environment.
`void`	`setGUI(PacGUI gui)` Associate a GUI with the environment.
`void`	`start(State initState)` Run the simulation starting from a given state.
`protected void`	`updateState(Agent a, Action action)` Execute an agent's action and update the environment's state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - thinkTime
```
protected long thinkTime
```
    The number of milliseconds used by agents to process percepts and choose actions.
  - DEFAULT_NUM_AGENTS
```
public static int DEFAULT_NUM_AGENTS
```
  - DEFAULT_WORLD_SIZE
```
public static int DEFAULT_WORLD_SIZE
```
    The length (and width) of the world. The world must be a square.
  - DEFAULT_NUM_PACKAGES
```
public static int DEFAULT_NUM_PACKAGES
```
    Number of packages.
  - DEFAULT_NUM_DESTINATIONS
```
public static int DEFAULT_NUM_DESTINATIONS
```
    Number of destinations.
  - MAX_NUM_DESTINATIONS
```
public static int MAX_NUM_DESTINATIONS
```
  - numAgents
```
protected int numAgents
```
  - worldSize
```
protected int worldSize
```
  - numPackages
```
protected int numPackages
```
  - numDestinations
```
protected int numDestinations
```
  - actLog
```
public static java.io.PrintWriter actLog
```
  - pg
```
public PacGUI pg
```
    The GUI that displays the current world
  - initState
```
protected PackageState initState
```
  - count
```
protected int count
```
    The number of turns (each agent's sense/act pair is a turn)
  - delivered
```
protected int delivered
```
    The number of packages successfully delivered.
  - avgEffort
```
protected float avgEffort
```
  - msgLengthPerTurn
```
protected float msgLengthPerTurn
```
  - thinkPerTurn
```
protected float thinkPerTurn
```
  - batch
```
protected static boolean batch
```
    Run in batch mode? If true, then simulation automatically runs when started and doesn't display a summary dialog window.
- Constructor Detail
  - PackageWorld
```
public PackageWorld()
```
  - PackageWorld
```
public PackageWorld(java.io.PrintWriter actLog)
```
- Method Detail
  - addAgent
```
public void addAgent(Agent agent)
```
    Add a new agent to the environment. Note, the agents List is actually an ArrayList of PacAgentReps.
    
    Specified by:
    
    addAgent in class Environment
  - getAgents
```
public java.util.List<Agent> getAgents()
```
    Returns a list of the agents in the environment.
  - resetAgents
```
public void resetAgents()
```
    Clears all agents from the environment.
  - getScoreMsg
```
public java.lang.String getScoreMsg()
```
    Returns a string containing score information for the agent team.
  - isComplete
```
protected boolean isComplete()
```
    The simulation is complete when all packages have been delivered or nothing has happened for two cycles or no packages have been picked up or dropped off for 5 * n cycles.
    
    Specified by:
    
    isComplete in class Environment
  - getPerformanceMeasure
```
public int getPerformanceMeasure(Agent a)
```
    Return the performance measure of the agent in the current environment. Since this is a team environment, we only return the team's performance measure, regardless of the agent.
    
    Specified by:
    
    getPerformanceMeasure in class Environment
  - getTeamPerformanceMeasure
```
public int getTeamPerformanceMeasure()
```
    Return the performance measure of a team of agents in a cooperative environment. Higher values are considered better.
    
    Specified by:
    
    getTeamPerformanceMeasure in class Environment
  - getPercept
```
protected Percept getPercept(Agent agt)
```
    Create a percept for an agent. This implements the see: S -> P function.
    
    Specified by:
    
    getPercept in class Environment
  - updateState
```
protected void updateState(Agent a,
                           Action action)
```
    Execute an agent's action and update the environment's state.
    
    Overrides:
    
    updateState in class Environment
  - getWorldSize
```
public int getWorldSize()
```
    Return the size of the grid for the environment.
  - getNumAgents
```
public int getNumAgents()
```
    Return the number of agents in the environment.
  - setGUI
```
public void setGUI(PacGUI gui)
```
    Associate a GUI with the environment.
  - start
```
public void start(State initState)
```
    Run the simulation starting from a given state. This consists of a sense-act loop for each agent.
    
    Overrides:
    
    start in class Environment
  - logMessage
```
public void logMessage(java.lang.String message)
```
    Outputs a message to the log and the GUI.
  - main
```
public static void main(java.lang.String[] args)
```
    Starts the program.

Class PackageWorld

Field Summary

Fields inherited from class agent.Environment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

thinkTime

DEFAULT_NUM_AGENTS

DEFAULT_WORLD_SIZE

DEFAULT_NUM_PACKAGES

DEFAULT_NUM_DESTINATIONS

MAX_NUM_DESTINATIONS

numAgents

worldSize

numPackages

numDestinations

actLog

pg

initState

count

delivered

avgEffort

msgLengthPerTurn

thinkPerTurn

batch

Constructor Detail

PackageWorld

PackageWorld

Method Detail

addAgent

getAgents

resetAgents

getScoreMsg

isComplete

getPerformanceMeasure

getTeamPerformanceMeasure

getPercept

updateState

getWorldSize

getNumAgents

setGUI

start

logMessage

main