Some minor integration work:

- Travel distance tracking added to map Agents
- MapEnvironment now checks whether a road exists before moving the Agent
- Use of dynamic attribute name constants unified
- Documentation improved

Author: Ruediger.Lunde

src/aima/gui/applications/search/map/AbstractMapAgentController.java

@@ -9,98 +9,104 @@
 import aima.search.map.DynAttributeNames;
 import aima.search.map.Scenario;
 
-
 /**
- * Provides a useful base class for agent application controller
- * implementations in the context of route planning agent application
- * development.
- * To get it ready to work, all you need to do is, to provide implementations
- * for the four abstract methods.
- * See {@link RoutePlanningAgentAppDemo} for an example.
+ * Provides a useful base class for agent application controller implementations
+ * in the context of route planning agent application development. To get it
+ * ready to work, all you need to do is, to provide implementations for the four
+ * abstract methods. See {@link RoutePlanningAgentAppDemo} for an example.
+ * 
  * @author R. Lunde
  */
 public abstract class AbstractMapAgentController extends AgentAppController {
 	/** A scenario. */
 	protected Scenario scenario;
 	/**
-	 * Some location names. For routing problems, only one location should
-	 * be specified.
+	 * Some location names. For routing problems, only one location should be
+	 * specified.
 	 */
 	protected List<String> destinations;
 	/** Search method to be used. */
 	protected aima.search.framework.Search search;
 	/** Heuristic function to be used when performing informed search. */
 	protected AdaptableHeuristicFunction heuristic;
-	
+
 	/** Clears the model's tour history. */
+	@Override
 	public void clearAgent() {
 		((AbstractMapAgentModel) model).clearTourHistory();
 		frame.modelChanged();
 	}
-	
-	/** 
-	 * Performs necessary preparations for running the agent. The behavior is
-	 * strongly influenced by the abstract methods {@link #selectScenarioAndDest(int, int)},
-	 * {@link #prepareModel()} and {@link #createHeuristic(int)}.
+
+	/**
+	 * Template method, which performs necessary preparations for running the
+	 * agent. The behavior is strongly influenced by the primitive operations
+	 * {@link #selectScenarioAndDest(int, int)}, {@link #prepareModel()} and
+	 * {@link #createHeuristic(int)}.
 	 */
+	@Override
 	public void prepareAgent() {
 		MapAgentFrame.SelectionState state = frame.getSelection();
-		selectScenarioAndDest(
-				state.getValue(MapAgentFrame.SCENARIO_SEL),
-				state.getValue(MapAgentFrame.DESTINATION_SEL));
+		selectScenarioAndDest(state.getValue(MapAgentFrame.SCENARIO_SEL), state
+				.getValue(MapAgentFrame.DESTINATION_SEL));
 		prepareModel();
 		search = SearchFactory.getInstance().createSearch(
 				state.getValue(MapAgentFrame.SEARCH_SEL),
 				state.getValue(MapAgentFrame.SEARCH_MODE_SEL));
-		heuristic = createHeuristic(
-				state.getValue(MapAgentFrame.HEURISTIC_SEL));
+		heuristic = createHeuristic(state.getValue(MapAgentFrame.HEURISTIC_SEL));
 		scenario.getEnv().registerView(model);
 	}
-	
-	/** Starts the agent and updates the status bar of the frame. */
+
+	/**
+	 * Template method, which calls {@link #startAgent()} and then updates the
+	 * status bar of the frame.
+	 */
+	@Override
 	public void runAgent() {
 		startAgent();
 		List agents = scenario.getEnv().getAgents();
 		if (agents.size() == 1) {
 			Agent agent = (Agent) agents.get(0);
-			String status =
-				(String) agent.getAttribute(DynAttributeNames.AGENT_STATUS);
-			Integer travelDistance =
-				(Integer) agent.getAttribute(DynAttributeNames.AGENT_TRAVEL_DISTANCE);
-			if (status != null && travelDistance != null)
-				frame.setStatus("Task " + status + "; travel distance " + travelDistance);
+			String status = (String) agent
+					.getAttribute(DynAttributeNames.AGENT_STATUS);
+			Integer travelDistance = (Integer) agent
+					.getAttribute(DynAttributeNames.AGENT_TRAVEL_DISTANCE);
+			StringBuffer statusMsg = new StringBuffer("Task ");
+			if (status != null)
+				statusMsg.append(status);
 			else
-				frame.setStatus("Task completed.");
+				statusMsg.append("completed");
+			if (travelDistance != null)
+				statusMsg.append("; travel distance " + travelDistance);
+			statusMsg.append(".");
+			frame.setStatus(statusMsg.toString());
 		}
 	}
-	
-	
-	/////////////////////////////////////////////////////////////////
+
+	// ///////////////////////////////////////////////////////////////
 	// abstract methods
-	
+
 	/**
-	 * Template method, responsible for assigning values
-	 * to attributes {@link #scenario} and {@link #destinations}.
+	 * Primitive operation, responsible for assigning values to attributes
+	 * {@link #scenario} and {@link #destinations}.
 	 */
 	abstract protected void selectScenarioAndDest(int scenarioIdx, int destIdx);
-	
+
 	/**
-	 * Template method, responsible for preparing the model.
-	 * Scenario and destinations are already selected when
-	 * this method is called.
+	 * Primitive operation, responsible for preparing the model. Scenario and
+	 * destinations are already selected when this method is called.
 	 */
 	abstract protected void prepareModel();
-	
+
 	/**
 	 * Factory method, responsible for creating a heuristic function.
 	 */
 	abstract protected AdaptableHeuristicFunction createHeuristic(int heuIdx);
 
 	/**
-	 * Template method, responsible for creating and starting the agent.
-	 * Scenario, destinations are selected before as well
-	 * as search method and search heuristic.
+	 * Primitive operation, responsible for creating and starting the agent.
+	 * Scenario, destinations are selected before as well as search method and
+	 * search heuristic.
 	 */
 	protected abstract void startAgent();
-	
+
 }

src/aima/gui/applications/search/map/MapAgentModel.java

@@ -8,43 +8,48 @@
 import aima.search.map.Scenario;
 
 /**
- * Provides a ready-to-use implementation of a model for route planning
- * agent applications. It is based on a scenario description and a
- * list of destinations. Some features are not used. Subclasses
- * can support those features by overriding the methods
- * {@link #hasSignpost(String)}, {@link #hasInfos(String)}, and
- * {@link #hasObjects(String)}.
+ * Provides a ready-to-use implementation of a model for route planning agent
+ * applications. It is based on a scenario description and a list of
+ * destinations. Some features are not used. Subclasses can support those
+ * features by overriding the methods {@link #hasSignpost(String)},
+ * {@link #hasInfos(String)}, and {@link #hasObjects(String)}.
+ * 
  * @author R. Lunde
  */
 public class MapAgentModel extends AbstractMapAgentModel {
 	/** A scenario. */
 	protected Scenario scenario;
 	/** A list of location names, possibly null. */
 	protected List<String> destinations;
-	
+
 	/**
 	 * Assigns values to the attributes {@link #scenario} and
-	 * {@link #destinations}, clears the history and informs
-	 * all interested listeners about the model change.
-	 * @param s A scenario or null.
-	 * @param d List of location names or null.
+	 * {@link #destinations}, clears the history and informs all interested
+	 * listeners about the model change.
+	 * 
+	 * @param s
+	 *            A scenario or null.
+	 * @param d
+	 *            List of location names or null.
 	 */
 	public void prepare(Scenario s, List<String> d) {
 		scenario = s;
 		destinations = d;
 		clearTourHistory();
 		fireModelChanged();
 	}
-	
+
 	/** Checks whether there is a scenario available. */
+	@Override
 	public boolean isEmpty() {
 		return scenario == null;
 	}
-	
+
 	/**
-	 * Returns all location names mentioned in the environment map
-	 * or in the agent map.
+	 * Returns all location names mentioned in the environment map or in the
+	 * agent map.
 	 */
+	@Override
 	public List<String> getLocations() {
 		List<String> result = scenario.getEnvMap().getLocations();
 		if (!result.containsAll(scenario.getAgentMap().getLocations())) {
@@ -55,34 +60,46 @@ public List<String> getLocations() {
 		}
 		return result;
 	}
+
+	@Override
 	public Map getAgentMap() {
 		return scenario.getAgentMap();
 	}
+
+	@Override
 	public Map getEnvMap() {
 		return scenario.getEnvMap();
 	}
+
+	@Override
 	public Agent getAgent() {
 		return (Agent) scenario.getEnv().getAgents().get(0);
 	}
+
+	@Override
 	public boolean isStart(String loc) {
 		return scenario.getInitAgentLocation() == loc;
 	}
+
+	@Override
 	public boolean isDestination(String loc) {
 		return destinations != null && destinations.contains(loc);
 	}
+
+	@Override
 	public double[] getLocCoords(String loc) {
 		return scenario.getEnvMap().getXY(loc);
 	}
+
 	/** Always returns false. */
-	public boolean hasSignpost(String loc) {
-		return false;
-	}
-	/** Always returns false. */
+	@Override
 	public boolean hasInfos(String loc) {
 		return false; // not implemented yet
 	}
+
 	/** Always returns false. */
+	@Override
 	public boolean hasObjects(String loc) {
-		return false;
+		return false; // not implemented yet
 	}
 }

src/aima/search/map/MapAgent.java

@@ -66,7 +66,7 @@ public void setHeuristicFunction(HeuristicFunction heuristicFunction) {
 	//
 	@Override
 	protected Object updateState(Percept p) {
-		currentLocation = (String) p.getAttribute("In");
+		currentLocation = (String) p.getAttribute(DynAttributeNames.PERCEPT_IN);
 
 		return currentLocation;
 	}

src/aima/search/map/MapEnvironment.java

@@ -14,9 +14,6 @@
  */
 
 public class MapEnvironment extends Environment {
-	public static final String STATE_IN = "In";
-
-	private static final String LOCATION = "location";
 
 	private Map aMap = null;
 
@@ -26,19 +23,28 @@ public MapEnvironment(Map aMap) {
 
 	public void addAgent(Agent a, String startLocation) {
 		super.addAgent(a);
-		a.setAttribute(LOCATION, startLocation);
+		a.setAttribute(DynAttributeNames.AGENT_LOCATION, startLocation);
+		a.setAttribute(DynAttributeNames.AGENT_TRAVEL_DISTANCE, 0);
 	}
 
 	@Override
 	public void executeAction(Agent a, String act) {
-		if (!Agent.NO_OP.equals(act)) {
-			a.setAttribute(LOCATION, act);
+		String currLoc = (String) a
+				.getAttribute(DynAttributeNames.AGENT_LOCATION);
+		Integer distance = aMap.getDistance(currLoc, act);
+		if (distance != null) {
+			int currTD = (Integer) a
+					.getAttribute(DynAttributeNames.AGENT_TRAVEL_DISTANCE);
+			a.setAttribute(DynAttributeNames.AGENT_TRAVEL_DISTANCE, currTD
+					+ distance);
+			a.setAttribute(DynAttributeNames.AGENT_LOCATION, act);
 		}
 	}
 
 	@Override
 	public Percept getPerceptSeenBy(Agent anAgent) {
-		return new Percept(STATE_IN, anAgent.getAttribute(LOCATION));
+		return new Percept(DynAttributeNames.PERCEPT_IN, anAgent
+				.getAttribute(DynAttributeNames.AGENT_LOCATION));
 	}
 
 	public Map getMap() {

src/aima/search/map/MapGoalTest.java

@@ -24,7 +24,7 @@ public boolean isGoalState(Object currentState) {
 		String location = currentState.toString();
 		if (currentState instanceof Percept) {
 			location = (String) ((Percept) currentState)
-					.getAttribute(MapEnvironment.STATE_IN);
+					.getAttribute(DynAttributeNames.PERCEPT_IN);
 		}
 
 		return goalState.equals(location);

src/aima/search/map/MapStepCostFunction.java

@@ -33,9 +33,9 @@ public Double calculateStepCost(Object fromCurrentState,
 		String toLoc = toNextState.toString();
 		if (fromCurrentState instanceof Percept) {
 			fromLoc = (String) ((Percept) fromCurrentState)
-					.getAttribute(MapEnvironment.STATE_IN);
+					.getAttribute(DynAttributeNames.PERCEPT_IN);
 			toLoc = (String) ((Percept) toNextState)
-					.getAttribute(MapEnvironment.STATE_IN);
+					.getAttribute(DynAttributeNames.PERCEPT_IN);
 		}
 
 		Integer distance = map.getDistance(fromLoc, toLoc);

src/aima/search/map/MapSuccessorFunction.java

@@ -30,7 +30,7 @@ public List getSuccessors(Object currentState) {
 		String location = currentState.toString();
 		if (currentState instanceof Percept) {
 			location = (String) ((Percept) currentState)
-					.getAttribute(MapEnvironment.STATE_IN);
+					.getAttribute(DynAttributeNames.PERCEPT_IN);
 		}
 
 		List<String> linkedLocations = map.getLocationsLinkedTo(location);