Changeset 13160

Timestamp:

03/21/12 14:33:59 (13 years ago)

Author:

tbretz

Message:

Some clean up to the commands.

File:

• trunk/FACT++/src/fadctrl.cc (modified) (10 diffs)

trunk/FACT++/src/fadctrl.cc

@@ -724 +724 @@
         return T::GetCurrentState();
     }
-
+/*
     int StartRun(const EventImp &evt, bool start)
     {
@@ -735 +735 @@
         return T::GetCurrentState();
     }
-
+*/
     int PhaseShift(const EventImp &evt)
     {
@@ -861 +861 @@
         return T::GetCurrentState();
     }
-
+/*
     int Test(const EventImp &evt)
     {
@@ -871 +871 @@
 
         return T::GetCurrentState();
-    }
+    }*/
 
 
@@ -1642 +1642 @@
         T::AddEvent("SEND_N_TRIGGERS", "I", FAD::kConnecting, FAD::kConnected, FAD::kWritingData)
             (bind(&StateMachineFAD::SendTriggers, this, placeholders::_1))
-            ("Issue software triggers");
+            ("Issue N software triggers (note that these are the triggers sent, not the triggers executed)"
+             "|N[int]: Number of triggers to be sent to the board.");
+        /*
         T::AddEvent("START_RUN", "", FAD::kConnecting, FAD::kConnected, FAD::kWritingData)
             (bind(&StateMachineFAD::StartRun, this, placeholders::_1, true))
@@ -1649 +1651 @@
             (bind(&StateMachineFAD::StartRun, this, placeholders::_1, false))
             ("");
+            */
         T::AddEvent("PHASE_SHIFT", "S:1", FAD::kConnecting, FAD::kConnected, FAD::kWritingData)
             (bind(&StateMachineFAD::PhaseShift, this, placeholders::_1))
-            ("Adjust ADC phase (in 'steps')");
+            ("Adjust ADC phase (in 'steps')"
+             "|phase[short]");
 
         T::AddEvent("RESET_EVENT_COUNTER", FAD::kConnecting, FAD::kConnected, FAD::kWritingData)
             (bind(&StateMachineFAD::Cmd, this, FAD::kCmdResetEventCounter))
-            ("");
+            ("Reset the FAD boards' event counter to 0.");
 
         T::AddEvent("SET_RUN_NUMBER", "X:1", FAD::kConnecting, FAD::kConnected, FAD::kWritingData)
             (bind(&StateMachineFAD::SetRunNumber, this, placeholders::_1))
-            ("");
+            ("Sent a new run-number to the boards"
+             "|num[int]:Run number");
 
         T::AddEvent("SET_MAX_MEMORY", "S:1")
@@ -1688 +1693 @@
         T::AddEvent("CONFIGURE", "X:2;C", FAD::kConnected, FAD::kConfigured, FAD::kWritingData)
             (bind(&StateMachineFAD::StartConfigure, this, placeholders::_1))
-            ("");
+            ("Configure a new run. If the internla trigger is enabled this might even start a new run."
+             "|time_max[s]:Maximum time before the run is closed in seconds (0: unlimited)"
+             "|num_max[int]:Maximum number of events before the run is closed in seconds (0: unlimited)"
+             "|run_type[string]:Run type which describes the runs");
 
         T::AddEvent("RESET_CONFIGURE", FAD::kConfiguring1, FAD::kConfiguring2, FAD::kConfigured)
             (bind(&StateMachineFAD::ResetConfig, this))
-            ("");
+            ("If configuration failed and the fadctrl is waiting for something, use this to reset the state.");
 
         // Verbosity commands
@@ -1707 +1715 @@
         T::AddEvent("SET_DATA_OUTPUT", "B:1")
             (bind(&StateMachineFAD::SetDataOutput, this, placeholders::_1))
-            ("");
+            ("Enable or disable printing of the received adc data to the console"
+             "|dataout[bool]:disable or enable data output for received data (yes/no)");
 
         T::AddEvent("SET_DEBUG_TX", "B:1")
@@ -1716 +1725 @@
         T::AddEvent("SET_DEBUG_EVENT_BUILDER_OUT", "B:1")
             (bind(&StateMachineFAD::SetDebugEb, this, placeholders::_1))
-            ("");
+            ("Enable or disable the debug output from the event builder"
+             "|enable[bool]:Enable/Disable (yes/no)");
 
         T::AddEvent("PRINT_EVENT", "S:1")
@@ -1763 +1773 @@
             ("Close all run files opened by the EventBuilder.");
 
-        T::AddEvent("TEST", "S:1")
-           (bind(&StateMachineFAD::Test, this, placeholders::_1))
-            ("");
+        //T::AddEvent("TEST", "S:1")
+        //   (bind(&StateMachineFAD::Test, this, placeholders::_1))
+        //    ("");