PackageState

java.lang.Object
- agent.State
- - pacworld.PackageState

```
public class PackageState
extends State
```
Represents a state in the package world.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.HashMap<Agent,PacAgentRep>`	`agentReps` Array containing state information for the agents.
`protected Location[]`	`destinations`
`protected PacGUI`	`gui`
`protected int`	`idleCount`
`protected java.lang.Object[][]`	`map` An array to that contains the locations of objects in the world.
`protected int`	`mapSize`
`protected int`	`messageCount`
`protected int`	`nonProductiveCount`
`protected int`	`numAgents`
`protected int`	`numDests`
`protected int`	`numPackages`
`protected int`	`origNumPackages`
`protected int`	`pacCount` The number of moves with a package in hand.
`protected java.util.ArrayList<Package>`	`packages`
`protected long`	`totalMessageLength`
`protected int`	`workCount` The number of actions not including idling.

Constructor Summary

Constructors
Constructor and Description

PackageState()
Construct a new package state.

Constructors
Constructor and Description
`PackageState()` Construct a new package state.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bumped(Agent a)` Return true if the agent bumped into an obstacle on its previous move.
`void`	`display()` Print an output of the state to the screen.
`void`	`dropPackage(Agent a, int dropX, int dropY)`
`protected PacAgentRep`	`getAgentRep(Agent a)`
`java.util.Collection<PacAgentRep>`	`getAgentReps()`
`int`	`getAgentX(Agent a)` Return the X location of the specified agent.
`int`	`getAgentY(Agent a)` Return the Y location of the specified agent.
`Location[]`	`getDestinations()`
`int`	`getIdleCount()`
`static PackageState`	`getInitState(java.util.List<Agent> agts, int numPackages, int numDests, int mapSize)` Return a random initial state for the vacuum world.
`static PackageState`	`getInitState(long seed, java.util.List<Agent> agts, int numPackages, int numDests, int mapSize)` Use the given seed to generate a pseudo-random initial state for the vacuum world.
`java.lang.Object[][]`	`getMap()` Returns the map.
`int`	`getMapSize()`
`int`	`getMessageCount()`
`java.lang.String[]`	`getMessages()`
`int`	`getNonProductiveCount()`
`int`	`getNumDestinations()`
`int`	`getNumPackages()`
`java.lang.Object`	`getObjectAt(int x, int y)` Return the object located at the specified location.
`int`	`getOrigNumPackages()`
`int`	`getPacCount()`
`Package`	`getPackageHeldByAgent(Agent a)` Return the package (if any) held by the specified agent.
`java.util.List<Package>`	`getPackages()`
`long`	`getTotalMessageLength()`
`int`	`getWorkCount()`
`boolean`	`hasObstacle(int x, int y)` Return true if the specified location has an obstacle in it.
`boolean`	`inBounds(int x, int y)` Return true if the location is within bounds of the state's map.
`void`	`pickup(Agent a, Package p)` Modify the state so that the agent is holding the selected package.
`void`	`printState()`
`void`	`repositionAgent(Agent a, int newX, int newY)` Change the agent's position.
`void`	`repositionPackage(Package p, int newX, int newY)` Change a package's position.
`void`	`setBump(Agent a, boolean bump)` Set an indicator that the robot bumped into an obstacle during its previous move.
`void`	`setGUI(PacGUI pg)`
`void`	`setIdleCount(int ic)`
`void`	`setMessage(Agent a, java.lang.String s)` Set whatever message was said by the agent in its previous move.
`void`	`tallyNonProductiveWork()` Increments workCount and nonProductive count.

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

Field Detail

agentReps
```
protected java.util.HashMap<Agent,PacAgentRep> agentReps
```
Array containing state information for the agents.

packages

protected java.util.ArrayList<Package> packages

destinations
```
protected Location[] destinations
```

numAgents
```
protected int numAgents
```

numPackages
```
protected int numPackages
```

origNumPackages
```
protected int origNumPackages
```

mapSize
```
protected int mapSize
```

numDests
```
protected int numDests
```

idleCount
```
protected int idleCount
```

workCount
```
protected int workCount
```
The number of actions not including idling.

pacCount
```
protected int pacCount
```
The number of moves with a package in hand.

messageCount
```
protected int messageCount
```

totalMessageLength
```
protected long totalMessageLength
```

nonProductiveCount
```
protected int nonProductiveCount
```

gui
```
protected PacGUI gui
```

map
```
protected java.lang.Object[][] map
```
An array to that contains the locations of objects in the world.

Constructor Detail
- PackageState
```
public PackageState()
```
  Construct a new package state.

Method Detail

getInitState

public static PackageState getInitState(long seed,
                                        java.util.List<Agent> agts,
                                        int numPackages,
                                        int numDests,
                                        int mapSize)

Use the given seed to generate a pseudo-random initial state for the vacuum world.

getInitState

public static PackageState getInitState(java.util.List<Agent> agts,
                                        int numPackages,
                                        int numDests,
                                        int mapSize)

Return a random initial state for the vacuum world.

printState
```
public void printState()
```

getAgentRep

protected PacAgentRep getAgentRep(Agent a)

getAgentX
```
public int getAgentX(Agent a)
```
Return the X location of the specified agent.

getAgentY
```
public int getAgentY(Agent a)
```
Return the Y location of the specified agent.

getPackageHeldByAgent
```
public Package getPackageHeldByAgent(Agent a)
```
Return the package (if any) held by the specified agent. If the agent is not holding a package, return NULL.

pickup
```
public void pickup(Agent a,
                   Package p)
```
Modify the state so that the agent is holding the selected package. If the package is already held by an agent, then do nothing.

repositionAgent

public void repositionAgent(Agent a,
                            int newX,
                            int newY)

Change the agent's position. Update both the list of agent locations and the map.

repositionPackage

public void repositionPackage(Package p,
                              int newX,
                              int newY)

Change a package's position. Update the package's location and the map.

setBump
```
public void setBump(Agent a,
                    boolean bump)
```
Set an indicator that the robot bumped into an obstacle during its previous move.

hasObstacle

public boolean hasObstacle(int x,
                           int y)

Return true if the specified location has an obstacle in it.

getObjectAt
```
public java.lang.Object getObjectAt(int x,
                                    int y)
```
Return the object located at the specified location. If there is no object there, returns null.

bumped
```
public boolean bumped(Agent a)
```
Return true if the agent bumped into an obstacle on its previous move.

inBounds
```
public boolean inBounds(int x,
                        int y)
```
Return true if the location is within bounds of the state's map.

dropPackage

public void dropPackage(Agent a,
                        int dropX,
                        int dropY)

getNumPackages
```
public int getNumPackages()
```

getOrigNumPackages
```
public int getOrigNumPackages()
```

getMapSize
```
public int getMapSize()
```

getIdleCount
```
public int getIdleCount()
```

setIdleCount
```
public void setIdleCount(int ic)
```

getPackages

public java.util.List<Package> getPackages()

getAgentReps

public java.util.Collection<PacAgentRep> getAgentReps()

getMessages

public java.lang.String[] getMessages()

getNumDestinations
```
public int getNumDestinations()
```

getDestinations
```
public Location[] getDestinations()
```

getWorkCount
```
public int getWorkCount()
```

getPacCount
```
public int getPacCount()
```

getMessageCount
```
public int getMessageCount()
```

getTotalMessageLength
```
public long getTotalMessageLength()
```

getNonProductiveCount
```
public int getNonProductiveCount()
```

setMessage

public void setMessage(Agent a,
                       java.lang.String s)

Set whatever message was said by the agent in its previous move.

display
```
public void display()
```
Print an output of the state to the screen.

Specified by:

display in class State

setGUI
```
public void setGUI(PacGUI pg)
```

getMap
```
public java.lang.Object[][] getMap()
```
Returns the map. This is needed for the CustomPanel class.

tallyNonProductiveWork
```
public void tallyNonProductiveWork()
```
Increments workCount and nonProductive count. For use by actions.

Class PackageState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

agentReps

packages

destinations

numAgents

numPackages

origNumPackages

mapSize

numDests

idleCount

workCount

pacCount

messageCount

totalMessageLength

nonProductiveCount

gui

map

Constructor Detail

PackageState

Method Detail

getInitState

getInitState

printState

getAgentRep

getAgentX

getAgentY

getPackageHeldByAgent

pickup

repositionAgent

repositionPackage

setBump

hasObstacle

getObjectAt

bumped

inBounds

dropPackage

getNumPackages

getOrigNumPackages

getMapSize

getIdleCount

setIdleCount

getPackages

getAgentReps

getMessages

getNumDestinations

getDestinations

getWorkCount

getPacCount

getMessageCount

getTotalMessageLength

getNonProductiveCount

setMessage

display

setGUI

getMap

tallyNonProductiveWork