Diff: trial.h

Revision:

17:0b241aa1f5b6

Parent:

16:33c17c62840e

Child:

19:50663f8815b8

--- a/trial.h	Sat Jun 30 12:28:18 2018 +0000
+++ b/trial.h	Sun Jul 01 13:00:43 2018 +0000
@@ -56,9 +56,20 @@
     
     uint64_t      aud_ticker_cycle;
     
+    /**
+    *   a buffer for recording licking events during the trial.
+    */
     ArrayList<trialtime_t>  licking_events;
+    
+    /**
+    *   a buffer for recording whisking events during the trial.
+    */
     ArrayList<trialtime_t>  whisking_events;
     
+    /**
+    *   initialize the trial parameters according to the given Task parameter set.
+    *   typically called from one of the automaton states.
+    */
     void reset(const Task& task);
     
     /**
@@ -69,10 +80,28 @@
     */
     void assignRandomStim(const Task& task);
     
+    /**
+    *   a callback mechanism for marking (timestamping) the start of the trial.
+    *   called from one of the automaton states.
+    */
     void markTrialStart();
+    
+    /**
+    *   a callback mechanism for marking (timestamping) the end of the waiting period of the trial.
+    *   called from one of the automaton states.
+    */
     void markEndOfWait();
+    
+    /**
+    *   a callback mechanism for marking (timestamping) the end of the trial.
+    *   called from one of the automaton states.
+    */
     void markTrialEnd();
     
+    /**
+    *   output the result of a trial into a serial port through the IO mechanism.
+    *   typically called from one of the automaton states.
+    */
     void writeToSerial();
 };