Changeset 11943 for trunk

Timestamp:

09/02/11 09:37:04 (13 years ago)

Author:

tbretz

Message:

Added explanatory strings for command line options and events.

File:

• trunk/FACT++/src/biasctrl.cc (modified) (6 diffs)

trunk/FACT++/src/biasctrl.cc

@@ -173 +173 @@
             ostringstream msg;
             msg << hex << setfill('0');
-            msg << "Initial answer received:";
-            msg << " 0x" << setw(2) << (int)answer[0];
-            msg << " 0x" << setw(2) << (int)answer[1];
-            msg << " 0x" << setw(2) << (int)answer[2];
+            msg << "Initial answer received: 0x";
+            msg << setw(2) << (int)answer[2];
+            msg << setw(2) << (int)answer[1];
+            msg << setw(2) << (int)answer[0];
             Message(msg);
 
@@ -1398 +1398 @@
         T::AddEvent("DISCONNECT", kConnected, kAtReference)
             (bind(&StateMachineBias::Disconnect, this))
-            ("disconnect from ethernet");
+            ("disconnect from USB");
 
         T::AddEvent("RECONNECT", "O", kDisconnected, kConnected, kAtReference)
             (bind(&StateMachineBias::Reconnect, this, placeholders::_1))
-            ("(Re)connect ethernet connection to FTM, a new address can be given"
-             "|[host][string]:new ethernet address in the form <host:port>");
+            ("(Re)connect USB connection to Bias power supply, a new address can be given"
+             "|tty[string]:new USB address");
 
 
@@ -1445 +1445 @@
         T::AddEvent("STOP", kConnected, kRamping, kAtReference, kOverCurrent)
             (Wrapper(bind(&ConnectionBias::RampStop, &fBias)))
-            ("");
+            ("Stop an on-going ramping");
 
         T::AddEvent("START", kConnected, kOverCurrent)
             (Wrapper(bind(&ConnectionBias::RampStart, &fBias)))
-            ("");
+            ("Start a ramping if no ramping is in progress and if reference values differ from current voltages");
 
 
@@ -1455 +1455 @@
         T::AddEvent("PRINT_CURRENTS")
             (Wrapper(bind(&ConnectionBias::PrintA, &fBias)))
-            ("");
+            ("Print a table with all current read back with the last request operation");
         T::AddEvent("PRINT_VOLTAGES")
             (Wrapper(bind(&ConnectionBias::PrintV, &fBias)))
-            ("");
+            ("Print a table with all voltages (current and reference voltages as currently in memory)");
         T::AddEvent("PRINT_GAPD_REFERENCE_VOLTAGES")
             (Wrapper(bind(&ConnectionBias::PrintGapd, &fBias)))
-            ("");
+            ("Print the G-APD reference values obtained from file");
 
 
@@ -1489 +1489 @@
     }
 
-    ~StateMachineBias() { T::Warn("Implement rampming at shutdown!"); }
+    ~StateMachineBias() { T::Warn("TODO: Implement rampming at shutdown!"); }
 
     int EvalOptions(Configuration &conf)
@@ -1605 +1605 @@
         ("no-dim,d",        po_bool(),  "Disable dim services")
         ("dev",             var<string>("FTE00FOH"),  "Device address of USB port to bias-power supply")
-        ("quiet,q",         po_bool(),        "Disable printing contents of all received messages (except dynamic data) in clear text.")
-        ("ramp-time",       var<uint16_t>(15),   "")
-        ("ramp-step",       var<uint16_t>(46),   "")
-        ("update-interval", var<uint16_t>(3000), "")
-        ("sync-delay",      var<uint16_t>(333),  "")
-        ("volt-max",        var<float>(75),      "")
+        ("quiet,q",         po_bool(),           "Disable printing contents of all received messages (except dynamic data) in clear text.")
+        ("ramp-time",       var<uint16_t>(15),   "Delay between the answer of one ramping steps and sending the next ramp command to all channels in milliseconds.")
+        ("ramp-step",       var<uint16_t>(46),   "Maximum step in DAC counts during ramping (Volt = DAC*90/4096)")
+        ("update-interval", var<uint16_t>(3000), "Interval between two current requests in milliseconds")
+        ("sync-delay",      var<uint16_t>(333),  "Delay between sending the inital 0's after a newly established connection to synchronize the output stream in milliseconds")
+        ("volt-max",        var<float>(75),      "Upper limit for the voltage which can be applied in Volts")
         ;
     // FIXME: Make sure ramping / request and commands are