Diff: states.h

Revision:

11:897ecd5413e0

Parent:

9:e136394bdb39

Child:

20:4c06d3041337

--- a/states.h	Tue Jun 19 10:11:23 2018 +0000
+++ b/states.h	Thu Jun 21 17:57:22 2018 +0000
@@ -3,13 +3,22 @@
 
 #include "mbed.h"
 
-const uint16_t TRIGGER_DUR_MS = 2;
+/**
+*   internally gates the machine to accept licking.
+*   used in Report/Associate modes.
+*/
+void gateReward();
 
 struct Delay {
     static void setup();
     static void teardown();
 };
 
+/**
+*   used except for the Pair mode.
+*   lick is not allowed during this period.
+*   if the animal licks, the state transits to Abort.
+*/
 struct Prepare {
     static void setup();
     static void teardown();
@@ -20,11 +29,19 @@
     static void teardown();
 };
 
+/**
+*   used for the Pair mode during the visual cue presentation.
+*   jumps to either WithResp or NoResp, depending on whether or not
+*   the animal licked during this period.
+*/
 struct Paired {
     static void setup();
     static void teardown();
 };
 
+/**
+*   used except for the Pair mode to present reward-related conditioning cue(s).
+*/
 struct Cued {
     static void setup();
     static void gate();