expose custom bot movement and harvest probability

- setting bot-type to CUSTOM enables bot parameterization with
  robot-movement-probability, robot-harvest-probability, and
  robot-moves-per-second
- always use toCurrencyString to format currency

Author: alee

src/main/java/edu/asu/commons/foraging/bot/BotType.java

@@ -1,6 +1,5 @@
 package edu.asu.commons.foraging.bot;
 
 public enum BotType {
-    AGGRESSIVE, COOPERATIVE, NORMAL, RANDOM;
-}
-
+    AGGRESSIVE, COOPERATIVE, NORMAL, RANDOM, CUSTOM;
+}

src/main/java/edu/asu/commons/foraging/bot/NormalBot.java

@@ -10,17 +10,20 @@ public class NormalBot extends Bot.SimpleBot {
 
     public final static double MOVEMENT_PROBABILITY = 0.9d;
 
+    private BotType botType = BotType.NORMAL;
+
     public NormalBot() {
         super(ACTIONS_PER_SECOND, MOVEMENT_PROBABILITY, HARVEST_PROBABILITY);
     }
 
     public NormalBot(int actionsPerSecond, double movementProbability, double harvestProbability) {
         super(actionsPerSecond, movementProbability, harvestProbability);
+        botType = BotType.CUSTOM;
     }
 
     @Override
     public BotType getBotType() {
-        return BotType.NORMAL;
+        return botType;
     }
 
 }

src/main/java/edu/asu/commons/foraging/conf/RoundConfiguration.java

@@ -399,7 +399,7 @@ public boolean isLabDollarsEnabled() {
 
     public String toCurrencyString(double amount) {
         if (isLabDollarsEnabled()) {
-            return String.format("%d lab dollars", amount);
+            return String.format("%s lab dollars", amount);
         }
         NumberFormat currencyFormat = NumberFormat.getCurrencyInstance();
         return currencyFormat.format(amount) + " " + currencyFormat.getCurrency().getCurrencyCode();
@@ -897,29 +897,27 @@ public String getClientDebriefing() {
 
     public String generateClientDebriefing(ClientData data, boolean showExitInstructions) {
         ST st = createStringTemplate(getClientDebriefing());
-        NumberFormat formatter = NumberFormat.getCurrencyInstance();
-        populateClientEarnings(data, getParentConfiguration(), formatter, showExitInstructions);
+        populateClientEarnings(data, getParentConfiguration(), isTrustGameEnabled());
         st.add("clientData", data);
         // FIXME: replace showExitInstructions within client debriefing with a ExitInstructions template?
         st.add("showExitInstructions", showExitInstructions);
-        st.add("showUpPayment", formatter.format(getParentConfiguration().getShowUpPayment()));
+        st.add("showUpPayment", toCurrencyString(getParentConfiguration().getShowUpPayment()));
         return st.render();
     }
 
-    private void populateClientEarnings(ClientData data, ServerConfiguration serverConfiguration, NumberFormat formatter, boolean includeTrustGame) {
-        data.setGrandTotalIncome(formatter.format(serverConfiguration.getTotalIncome(data, includeTrustGame)));
-        data.setCurrentIncome(formatter.format(tokensToDollars(data.getCurrentTokens())));
-        data.setQuizEarnings(formatter.format(serverConfiguration.getQuizEarnings(data)));
-        data.setTrustGameEarnings(formatter.format(data.getTrustGameIncome()));
+    private void populateClientEarnings(ClientData data, ServerConfiguration serverConfiguration, boolean includeTrustGame) {
+        data.setGrandTotalIncome(toCurrencyString(serverConfiguration.getTotalIncome(data, includeTrustGame)));
+        data.setCurrentIncome(toCurrencyString(tokensToDollars(data.getCurrentTokens())));
+        data.setQuizEarnings(toCurrencyString(serverConfiguration.getQuizEarnings(data)));
+        data.setTrustGameEarnings(toCurrencyString(data.getTrustGameIncome()));
     }
 
     public String generateFacilitatorDebriefing(ServerDataModel serverDataModel) {
         ST template = createStringTemplate(getFacilitatorDebriefingTemplate());
         template.add("lastRound", serverDataModel.isLastRound());
         ServerConfiguration serverConfiguration = getParentConfiguration();
-        NumberFormat formatter = NumberFormat.getCurrencyInstance();
         for (ClientData data : serverDataModel.getClientDataMap().values()) {
-            populateClientEarnings(data, serverConfiguration, formatter, true);
+            populateClientEarnings(data, serverConfiguration, true);
         }
         template.add("clientDataList", serverDataModel.getClientDataMap().values());
         return template.render();
@@ -1003,7 +1001,11 @@ public int getRobotMovesPerSecond() {
      * making a move
      */
     public double getRobotHarvestProbability() {
-        return getDoubleProperty("robot-harvest-probability", 0.5d);
+        return getDoubleProperty("robot-harvest-probability", getParentConfiguration().getRobotHarvestProbability());
+    }
+
+    public double getRobotMovementProbability() {
+        return getDoubleProperty("robot-movement-probability", getParentConfiguration().getRobotMovementProbability());
     }
 
     public String getTokenImagePath() {

src/main/java/edu/asu/commons/foraging/conf/ServerConfiguration.java

@@ -256,4 +256,11 @@ public int getMaximumOccupancyPerCell() {
         return getIntProperty("max-cell-occupancy", 1);
     }
 
+    public double getRobotHarvestProbability() {
+        return getDoubleProperty("robot-harvest-probability", 0.6d);
+    }
+
+    public double getRobotMovementProbability() {
+        return getDoubleProperty("robot-movement-probability", 0.9d);
+    }
 }

src/main/java/edu/asu/commons/foraging/model/GroupDataModel.java

@@ -924,10 +924,23 @@ public void setImposedStrategy(Strategy imposedStrategy) {
 
     public void addBots(int botsPerGroup, BotType botType) {
         int size = clients.size();
+        RoundConfiguration configuration = getRoundConfiguration();
+        double movementProbability = configuration.getRobotMovementProbability();
+        double harvestProbability = configuration.getRobotHarvestProbability();
+        int actionsPerSecond = configuration.getRobotMovesPerSecond();
         synchronized (bots) {
             bots.clear();
+
             for (int i = 0; i < botsPerGroup; i++) {
-                Bot bot = BotFactory.getInstance().create(botType, size + i + 1, this);
+                int botNumber = size + i + 1;
+                Bot bot = null;
+                switch (botType) {
+                    case CUSTOM:
+                        bot = BotFactory.getInstance().create(botNumber, this, actionsPerSecond, movementProbability, harvestProbability);
+                        break;
+                    default:
+                        bot = BotFactory.getInstance().create(botType, size + i + 1, this);
+                }
                 bot.initialize(serverDataModel.getRoundConfiguration());
                 bots.add(bot);
             }

src/main/resources/configuration/asu/2016/fmri.pretest/round1.xml

@@ -7,8 +7,8 @@
 <entry key='clients-per-group'>2</entry>
 <entry key="resource-depth">9</entry>
 <entry key="resource-width">9</entry>
-<entry key='bot-type'>COOPERATIVE</entry>
 <entry key='regrowth-rate'>0.05</entry>
+<entry key='robot-harvest-probability'>0.4</entry>
 <entry key='repeat'>5</entry>
 <entry key="instructions">
 <![CDATA[

src/main/resources/configuration/asu/2016/fmri.pretest/round2.xml

@@ -7,7 +7,7 @@
 <entry key='clients-per-group'>2</entry>
 <entry key="resource-depth">9</entry>
 <entry key="resource-width">9</entry>
-<entry key='bot-type'>NORMAL</entry>
+<entry key='robot-harvest-probability'>0.7</entry>
 <entry key='regrowth-rate'>0.1</entry>
 <entry key='repeat'>5</entry>
 <entry key="instructions">

src/main/resources/configuration/asu/2016/fmri.pretest/round3.xml

@@ -7,7 +7,7 @@
 <entry key='clients-per-group'>2</entry>
 <entry key="resource-depth">9</entry>
 <entry key="resource-width">9</entry>
-<entry key='bot-type'>AGGRESSIVE</entry>
+<entry key='robot-harvest-probability'>1.0</entry>
 <entry key='regrowth-rate'>0.15</entry>
 <entry key='repeat'>5</entry>
 <entry key="instructions">

src/main/resources/configuration/asu/2016/fmri.pretest/server.xml

@@ -17,6 +17,7 @@
 <entry key="default-round-duration">40</entry>
 <entry key="use-background-texture">false</entry>
 <entry key='use-lab-dollars'>true</entry>
+<entry key='bot-type'>CUSTOM</entry>
 <entry key="use-token-image">true</entry>
 <entry key='token-image-path'>images/green-diamond.png</entry>
 <entry key="use-avatar-image">false</entry>
@@ -65,7 +66,7 @@ Please <b>wait quietly</b> and <b>do not close this window, open any other appli
 You will appear on the screen as a blue circle <img width='25' height='25' src="@CODEBASE_URL@/images/blue-circle.png"></img>. 
 You can move by pressing the four arrow keys on your keyboard to move up, down, left, or right.  You must press a key
 for each and every move. As you move around you can collect tokens 
-<img width='25' height='25' src="@CODEBASE_URL@/images/green-diamond.png"></img> and earn <b>{dollarsPerToken} lab dollars</b>
+<img width='25' height='25' src="@CODEBASE_URL@/images/green-diamond.png"></img> and earn <b>{dollarsPerToken}</b>
 for each collected token.  To collect a token, move your avatar over it and <b>press the space bar</b>.  Simply moving
 your avatar over a token does <b>not collect</b> that token.
 </p>