Changeset 12061

Timestamp:

09/11/11 12:03:40 (13 years ago)

Author:

tbretz

Message:

Added command descriptions.

File:

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

trunk/FACT++/src/biasctrl.cc

@@ -1758 +1758 @@
         T::AddEvent("RESET_OVER_CURRENT_STATUS", kOverCurrent)
             (Wrapper(bind(&ConnectionBias::OverCurrentReset, &fBias)))
-            ("NOT YET TESTED");
+            ("Set all channels in over current state to 0V and send a system reset to reset the over current flags.");
 
 
@@ -1764 +1764 @@
         T::AddEvent("SET_GLOBAL_VOLTAGE", "F:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetGlobalVolt, this, placeholders::_1))
-            ("Set all channels to a new reference voltage. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)");
+            ("Set all channels to a new reference voltage. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)"
+             "|voltage[V]:Global target voltage in volts (will be converted to DAC units)");
 
         T::AddEvent("SET_GLOBAL_DAC", "S:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetGlobalDac, this, placeholders::_1))
-            ("Set all channels to a new DAC reference. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)");
+            ("Set all channels to a new DAC reference. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)"
+             "|voltage[dac]:Global target voltage as DAC counts.");
 
         T::AddEvent("INCREASE_GLOBAL_VOLTAGE", "F:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::IncGlobalVolt, this, placeholders::_1))
-            ("Set all channels to a new reference voltage. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)");
+            ("Set all channels to a new reference voltage. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)"
+             "|offset[V]:Offset to be added to all channels (will be converted to DAC counts)");
 
         T::AddEvent("INCREASE_GLOBAL_DAC", "S:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::IncGlobalDac, this, placeholders::_1))
-            ("Set all channels to a new DAC reference. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)");
+            ("Set all channels to a new DAC reference. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)"
+             "|offset[dac]:Offset to be added to all channels as DAC counts");
 
         T::AddEvent("DECREASE_GLOBAL_VOLTAGE", "F:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::DecGlobalVolt, this, placeholders::_1))
-            ("Set all channels to a new reference voltage. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)");
+            ("Set all channels to a new reference voltage. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)"
+             "|offset[V]:Offset to be subtracted from all channels (will be converted to DAC counts)");
 
         T::AddEvent("DECREASE_GLOBAL_DAC", "S:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::DecGlobalDac, this, placeholders::_1))
-            ("Set all channels to a new DAC reference. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)");
+            ("Set all channels to a new DAC reference. Starts ramping if necessary. (This command is not realized with the GLOBAL SET command.)"
+             "|offset[dac]:Offset to be subtracted from all channels as DAC counts");
 
         T::AddEvent("SET_CHANNEL_VOLTAGE", "S:1;F:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetChannelVolt, this, placeholders::_1))
-            ("Set a single channel a new reference voltage. Starts ramping if necessary.");
+            ("Set a single channel to a new reference voltage. Starts ramping if necessary."
+             "|channel[short]:Channel for which to set the target voltage [0-416]"
+             "|voltage[V]:Target voltage in volts for the given channel (will be converted to DAC units)");
 
         T::AddEvent("SET_CHANNEL_DAC", "S:1;S:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetChannelDac, this, placeholders::_1))
-            ("Set a single channel a new DAC reference value. Starts ramping if necessary.");
+            ("Set a single channel to a new DAC reference value. Starts ramping if necessary."
+             "|channel[short]:Channel for which to set the target voltage [0-416]"
+             "|voltage[dac]:Target voltage in DAC units for the given channel");
 
         T::AddEvent("SET_GLOBAL_GAPD_REFERENCE_VOLTAGE", kConnected, kAtReference, kOverCurrent)
@@ -1800 +1810 @@
         T::AddEvent("SET_CHANNEL_GAPD_REFERENCE_VOLTAGE", "S:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetGapdReferenceCh, this, placeholders::_1))
-            ("Set a single channel channels to its G-APD reference voltage. Starts ramping if necessary.");
+            ("Set a single channel channels to its G-APD reference voltage. Starts ramping if necessary."
+             "|channel[short]:Channel for which to set the target voltage [0-416]");
 
         T::AddEvent("SET_GAPD_REFERENCE_OFFSET", "F:1", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetGapdVoltage, this, placeholders::_1))
-            ("Set all channels to their G-APD reference voltage plus the given offset. Starts ramping if necessary.");
+            ("Set all channels to their G-APD reference voltage plus the given offset. Starts ramping if necessary."
+             "|offset[V]:Offset to be added to teh G-APD reference voltage globally");
 
         T::AddEvent("SET_ZERO_VOLTAGE", kConnected, kAtReference, kOverCurrent)
@@ -1812 +1824 @@
         T::AddEvent("SET_REFERENCE_VOLTAGES", "F:416", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetReferenceVolt, this, placeholders::_1))
-            ("");
+            ("Set all channels to the given new reference voltage. Starts ramping if necessary."
+             "voltage[V]:New reference voltage for all channels");
 
         T::AddEvent("SET_REFERENCE_DACS", "S:416", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::SetReferenceDac, this, placeholders::_1))
-            ("");
+            ("Set all channels to the given new reference voltage. Starts ramping if necessary."
+             "voltage[dac]:New reference voltage for all channels in DAC units");
 
         T::AddEvent("ADD_REFERENCE_VOLTAGES", "F:416", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::AddReferenceVolt, this, placeholders::_1))
-            ("");
+            ("Add the given voltages to the current reference voltages. Starts ramping if necessary."
+             "offset[V]:Offsets to be added to the reference voltage of all channels in volts");
 
         T::AddEvent("ADD_REFERENCE_DACS", "S:416", kConnected, kAtReference, kOverCurrent)
             (bind(&StateMachineBias::AddReferenceDac, this, placeholders::_1))
-            ("");
+            ("Add the given voltages to the current reference voltages. Starts ramping if necessary."
+             "offset[dac]:Offsets to be added to the reference voltage of all channels in DAC units");