cosmos 3.8.3 → 3.9.1

data/lib/cosmos/gui/dialogs/pry_dialog.rb

@@ -17,7 +17,7 @@ Cosmos.catch_fatal_exception do
 end
 
 module Cosmos
-
+  # Class to intercept keyPressEvents
   class PryLineEdit < Qt::LineEdit
     attr_accessor :keyPressCallback
     def keyPressEvent(event)
@@ -26,7 +26,11 @@ module Cosmos
     end
   end
 
+  # Creates a dialog with a {http://pryrepl.org pry instance}.
   class PryDialog < Qt::Dialog
+    # @param parent [Qt::Widget] Parent to this dialog
+    # @param pry_binding [Object] Ruby binding
+    # @param title [String] Dialog title
     def initialize(parent, pry_binding, title = 'Pry Dialog')
       super(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
       setMinimumWidth(700)
@@ -102,6 +106,8 @@ module Cosmos
       end
     end
 
+    # @param text [String] Text to append to the dialog and send to the pry
+    #   instance
     def sendToPry(text)
       @text_edit.appendPlainText(text)
       @queue << text
@@ -159,7 +165,5 @@ module Cosmos
     def graceful_kill
       sendToPry("throw :breakout")
     end
-
-  end # class PryDialog
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/dialogs/scroll_text_dialog.rb

@@ -11,8 +11,11 @@
 require 'cosmos/gui/qt'
 
 module Cosmos
-
+  # Dialog which creates a read only list of text
   class ScrollTextDialog < Qt::Dialog
+    # @param parent [Qt::Widget] Parent of this dialog
+    # @param title [String] Dialog title
+    # @param text [String] Text to display
     def initialize(parent, title, text)
       super(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
       setMinimumWidth(700)
@@ -32,6 +35,5 @@ module Cosmos
       self.exec
       self.dispose
     end
-  end # class ScrollTextDialog
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/dialogs/select_dialog.rb

@@ -13,42 +13,47 @@ require 'cosmos/gui/qt'
 require 'cosmos/gui/choosers/combobox_chooser'
 
 module Cosmos
-
-  class SelectDialog
+  # Dialog which displays a label and comobox of items along with Ok and Cancel
+  # buttons.
+  class SelectDialog < Qt::Dialog
+    # @return [String] The current combobox item when the dialog was accepte
+    #   with the Ok button
     attr_accessor :result
 
+    # @param parent [Qt::Widget] Parent of this dialog
+    # @param label_text [String] Text to display for the label
+    # @param items [Array<String>] Items to display in the combobox
+    # @param title [String] Dialog title
     def initialize(parent, label_text, items, title = 'Select Item')
+      super(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
       @result = nil
 
-      dialog = Qt::Dialog.new(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
-      dialog.setWindowTitle(title)
-      dialog_layout = Qt::VBoxLayout.new
-
-      chooser = ComboboxChooser.new(dialog, label_text, items)
-      dialog_layout.addWidget(chooser)
+      setWindowTitle(title)
+      layout = Qt::VBoxLayout.new
+      chooser = ComboboxChooser.new(self, label_text, items)
+      layout.addWidget(chooser)
 
       button_layout = Qt::HBoxLayout.new
       ok = Qt::PushButton.new("Ok")
       ok.connect(SIGNAL('clicked()')) do
-        dialog.accept()
+        accept()
       end
       button_layout.addWidget(ok)
       cancel = Qt::PushButton.new("Cancel")
       cancel.connect(SIGNAL('clicked()')) do
-        dialog.reject()
+        reject()
       end
       button_layout.addWidget(cancel)
-      dialog_layout.addLayout(button_layout)
+      layout.addLayout(button_layout)
 
-      dialog.setLayout(dialog_layout)
-      dialog.raise
-      if dialog.exec == Qt::Dialog::Accepted
+      setLayout(layout)
+      self.raise
+      if self.exec == Qt::Dialog::Accepted
         @result = chooser.string
       else
         @result = nil
       end
-      dialog.dispose
+      self.dispose
     end
-  end # class TlmEditDialog
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/dialogs/set_tlm_dialog.rb

@@ -14,14 +14,38 @@ require 'cosmos/tools/cmd_tlm_server/cmd_tlm_server'
 require 'cosmos/tools/cmd_tlm_server/api'
 
 module Cosmos
-
+  # Dialog which parses the specified packet and creates labels and values for
+  # each packet item. Items with states are displayed as comboboxes. The user
+  # can change any of the values and upon clicking the done button the values
+  # are written back into the packet.
   class SetTlmDialog < Qt::Dialog
+    # @return [Array<String>] Items which should not be displayed in the dialog
     IGNORED_ITEMS = ['RECEIVED_TIMESECONDS', 'RECEIVED_TIMEFORMATTED', 'RECEIVED_COUNT']
 
+    # @return [String] Errors encountered when trying to set the values back
+    #   into the packet
     attr_reader :error_label
+    # @return [String] Name of the item which has encountered an error
     attr_accessor :current_item_name
 
-    def initialize(parent, title, done_label, cancel_label, target_name, packet_name, packet = nil)
+    # @param parent [Qt::Widget] Parent of this dialog
+    # @param title [String] Dialog title
+    # @param done_button [String] Text to place on the button which will close
+    #   the dialog and update the packet
+    # @param cancel_button [String] Text to place on the button which will close
+    #   the dialog without setting the packet
+    # @param target_name [String] Name of the target
+    # @param packet_name [String] Name of the packet
+    # @param packet [Packet] If the packet is given the items will be taken
+    #   from the packet instead of using the target_name and packet_name to look
+    #   up the packet from the system.
+    def initialize(parent,
+                   title,
+                   done_button,
+                   cancel_button,
+                   target_name,
+                   packet_name,
+                   packet = nil)
       super(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
       @target_name = target_name
       @packet_name = packet_name
@@ -85,12 +109,12 @@ module Cosmos
 
       button_layout = Qt::HBoxLayout.new
       # Create Done Button
-      done_button = Qt::PushButton.new(done_label)
+      done_button = Qt::PushButton.new(done_button)
       connect(done_button, SIGNAL('clicked()'), self, SLOT('accept()'))
       button_layout.addWidget(done_button)
 
       # Create Cancel Button
-      cancel_button = Qt::PushButton.new(cancel_label)
+      cancel_button = Qt::PushButton.new(cancel_button)
       connect(cancel_button, SIGNAL('clicked()'), self, SLOT('reject()'))
       button_layout.addWidget(cancel_button)
       layout.addLayout(button_layout)
@@ -98,6 +122,7 @@ module Cosmos
       self.setLayout(layout)
     end
 
+    # Set all user edited items from the dialog back into the packet
     def set_items
       index = 0
       @items.each do |item_name, _, _|
@@ -107,8 +132,9 @@ module Cosmos
       end
     end
 
-    def self.execute(parent, title, done_label, cancel_label, target_name, packet_name, packet = nil)
-      dialog = self.new(parent, title, done_label, cancel_label, target_name, packet_name, packet)
+    # (see #initialize)
+    def self.execute(parent, title, done_button, cancel_button, target_name, packet_name, packet = nil)
+      dialog = self.new(parent, title, done_button, cancel_button, target_name, packet_name, packet)
       begin
         dialog.raise
         if dialog.exec == Qt::Dialog::Accepted
@@ -125,7 +151,5 @@ module Cosmos
       end
       result
     end
-
-  end # class SetTlmDialog
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/dialogs/splash.rb

@@ -15,10 +15,12 @@ require 'cosmos/gui/qt_tool'
 require 'cosmos/gui/dialogs/exception_dialog'
 
 module Cosmos
-
+  # Provides a single class method which creates a splash screen dialog box.
+  # This dialog has both a text message box and progress bar.
   class Splash
-
+    # Creates a dialog with a message box and a progress bar.
     class SplashDialogBox < Qt::Dialog
+      # @param parent [Qt::Widget] The dialog parent
       def initialize(parent)
         super(parent, Qt::WindowTitleHint | Qt::CustomizeWindowHint)
         setWindowTitle(parent.windowTitle)
@@ -43,6 +45,8 @@ module Cosmos
         @complete = false
       end
 
+      # @param message [String] Text to place in the message box. Text is
+      #   replaced and not appended.
       def message=(message)
         unless @complete
           Qt.execute_in_main_thread(false) do
@@ -51,6 +55,7 @@ module Cosmos
         end
       end
 
+      # @param progress [Float] Set the progress bar to a percentage from 0 to 1
       def progress=(progress)
         progress_int = (progress * 100).to_i
         if !@complete and @progress != progress_int
@@ -61,14 +66,18 @@ module Cosmos
         end
       end
 
+      # @return [Method] message= method
       def message_callback
         method(:message=)
       end
 
+      # @return [Method] progress= method
       def progress_callback
         method(:progress=)
       end
 
+      # Override keyPressEvent to prevent Esc from closing the splash dialog
+      # @param event [Qt::KeyEvent] Pressed key event
       def keyPressEvent(event)
         # Don't allow the Escape key to close this dialog
         if event.key == Qt::Key_Escape
@@ -79,6 +88,10 @@ module Cosmos
       end
     end
 
+    # @param parent [Qt::Widget] Dialog parent
+    # @param wait_for_complete [Boolean] Whether to call dialog.exec and block
+    #   other threads from running until this dialog is closed
+    # @yieldparam dialog [SplashDialogBox] The dialog box
     def self.execute(parent, wait_for_complete = false, &block)
       # Create the dialog and show it
       dialog = SplashDialogBox.new(parent)
@@ -122,14 +135,11 @@ module Cosmos
       end
       if wait_for_complete
         dialog.exec
-
-        # Need to make sure all Qt.execute_in_main_thread() have completed before disposing or
-        # we will segfault
+        # Need to make sure all Qt.execute_in_main_thread() have completed
+        # before disposing or we will segfault
         Qt::RubyThreadFix.queue.pop.call until Qt::RubyThreadFix.queue.empty?
-
         dialog.dispose
       end
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/gui/dialogs/tlm_details_dialog.rb

@@ -13,15 +13,23 @@
 
 require 'cosmos'
 require 'cosmos/gui/dialogs/details_dialog'
+require 'cosmos/packets/packet'
 
 module Cosmos
-
+  # Creates a dialog which shows the details of the given telemetry item.
   class TlmDetailsDialog < DetailsDialog
     slots 'value_update_timeout()'
 
+    # Period for the update thread which updates the dialog values
     VALUE_UPDATE_PERIOD_MS = 1000
-    VALUE_TYPES = [:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
 
+    # @param parent (see DetailsDialog#initialize)
+    # @param target_name (see DetailsDialog#initialize)
+    # @param packet_name (see DetailsDialog#initialize)
+    # @param item_name (see DetailsDialog#initialize)
+    # @param packet [Packet] If a Packet is given the dialog will read the
+    #   value from the given packet and will not update. If the packet
+    #   parameters is nil the value will be read continously from the System.
     def initialize(parent, target_name, packet_name, item_name, packet = nil)
       super(parent, target_name, packet_name, item_name)
 
@@ -116,14 +124,12 @@ module Cosmos
     end
 
     def value_update_timeout
-      begin
-        # Gather updated values
-        values, limits_states, limits_settings, limits_set = get_tlm_values(@item_array, VALUE_TYPES)
-        update_limits_details(limits_settings, limits_set)
-        update_text_fields(values, limits_states[0])
-      rescue DRb::DRbConnError
-        # Just do nothing
-      end
+      # Gather updated values
+      values, limits_states, limits_settings, limits_set = get_tlm_values(@item_array, Packet::VALUE_TYPES)
+      update_limits_details(limits_settings, limits_set)
+      update_text_fields(values, limits_states[0])
+    rescue DRb::DRbConnError
+      # Just do nothing
     end
 
     protected
@@ -143,44 +149,35 @@ module Cosmos
     end
 
     def update_limits_details(limits_settings, limits_set)
-      if limits_settings[0]
-        label_text = "RL/#{limits_settings[0][0]} YL/#{limits_settings[0][1]} YH/#{limits_settings[0][2]} RH/#{limits_settings[0][3]}"
-        if limits_settings[0][4] and limits_settings[0][5]
-          label_text << " GL/#{limits_settings[0][4]} GH/#{limits_settings[0][5]}"
-        end
-        if @limits_labels[limits_set]
-          @limits_labels[limits_set].text = label_text
-        elsif @limits_layout
-          label = Qt::Label.new(label_text)
-          @limits_labels[limits_set] = label
-          @limits_layout.addRow(tr("#{limits_set}:"), label)
-        end
+      return unless limits_settings[0]
+      label_text = "RL/#{limits_settings[0][0]} YL/#{limits_settings[0][1]} YH/#{limits_settings[0][2]} RH/#{limits_settings[0][3]}"
+      if limits_settings[0][4] and limits_settings[0][5]
+        label_text << " GL/#{limits_settings[0][4]} GH/#{limits_settings[0][5]}"
+      end
+      if @limits_labels[limits_set]
+        @limits_labels[limits_set].text = label_text
+      elsif @limits_layout
+        label = Qt::Label.new(label_text)
+        @limits_labels[limits_set] = label
+        @limits_layout.addRow(tr("#{limits_set}:"), label)
       end
     end
 
     def determine_limits_color(limit_state)
-      color = nil
       case limit_state
-      when :RED, :RED_HIGH
-        color = Cosmos::RED
-      when :RED_LOW
-        color = Cosmos::RED
-      when :YELLOW, :YELLOW_HIGH
-        color = Cosmos::YELLOW
-      when :YELLOW_LOW
-        color = Cosmos::YELLOW
-      when :GREEN, :GREEN_HIGH
-        color = Cosmos::GREEN
-      when :GREEN_LOW
-        color = Cosmos::GREEN
+      when :RED, :RED_HIGH, :RED_LOW
+        Cosmos::RED
+      when :YELLOW, :YELLOW_HIGH, :YELLOW_LOW
+        Cosmos::YELLOW
+      when :GREEN, :GREEN_HIGH, :GREEN_LOW
+        Cosmos::GREEN
       when :BLUE
-        color = Cosmos::BLUE
+        Cosmos::BLUE
       when :STALE
-        color = Cosmos::PURPLE
+        Cosmos::PURPLE
       else
-        color = Cosmos::BLACK
+        Cosmos::BLACK
       end
-      color
     end
 
     def update_text_fields(values, limits_state)
@@ -200,7 +197,5 @@ module Cosmos
       @limits_state.setColors(color, Cosmos::WHITE)
       @limits_state.text = limits_state.to_s
     end
-
-  end # class TlmDetailsDialog
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/dialogs/tlm_edit_dialog.rb

@@ -16,66 +16,64 @@ require 'cosmos/gui/qt'
 require 'cosmos/script'
 
 module Cosmos
-
-  # TlmEditDialog class
-  #
+  # Dialog which allows the user to enable or disable limits checking for the
+  # given item.
   class TlmEditDialog
-    def initialize (parent, target_name, packet_name, item_name)
+    # @param parent [Qt::Widget] Dialog parent
+    # @param target_name [String] Name of the target
+    # @param packet_name [String] Name of the packet
+    # @param item_name [String] Name of the item
+    def initialize(parent, target_name, packet_name, item_name)
       begin
-        begin
-          limits_enabled = limits_enabled?(target_name, packet_name, item_name)
-        rescue RuntimeError
-          # Error most likely due to LATEST packet - Ignore
-          limits_enabled = nil
-        end
+        limits_enabled = limits_enabled?(target_name, packet_name, item_name)
+      rescue RuntimeError
+        # Error most likely due to LATEST packet - Ignore
+        limits_enabled = nil
+      end
 
-        unless limits_enabled.nil?
-          dialog = Qt::Dialog.new(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
-          dialog.setWindowTitle("Edit Settings for #{target_name} #{packet_name} #{item_name}")
-          dialog_layout = Qt::VBoxLayout.new
-          dialog_layout.addWidget(Qt::Label.new("Warning: Edits affect all COSMOS tools, not just this application!"))
+      # Check for nil because true and false are both valid values
+      if limits_enabled.nil?
+        Qt::MessageBox.information(parent, "Edit Settings for #{target_name} #{packet_name} #{item_name}",
+          'No Editable Fields for this Item')
+        return
+      end
+
+      dialog = Qt::Dialog.new(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
+      dialog.setWindowTitle("Edit Settings for #{target_name} #{packet_name} #{item_name}")
+      dialog_layout = Qt::VBoxLayout.new
+      dialog_layout.addWidget(Qt::Label.new("Warning: Edits affect all COSMOS tools, not just this application!"))
 
-          check_layout = Qt::HBoxLayout.new
-          check_label = Qt::Label.new("Limits Checking Enabled:")
-          checkbox = Qt::CheckBox.new
-          checkbox.setChecked(limits_enabled)
-          check_label.setBuddy(checkbox)
-          check_layout.addWidget(check_label)
-          check_layout.addWidget(checkbox)
-          dialog_layout.addLayout(check_layout)
+      check_layout = Qt::HBoxLayout.new
+      check_label = Qt::Label.new("Limits Checking Enabled:")
+      checkbox = Qt::CheckBox.new
+      checkbox.setChecked(limits_enabled)
+      check_label.setBuddy(checkbox)
+      check_layout.addWidget(check_label)
+      check_layout.addWidget(checkbox)
+      dialog_layout.addLayout(check_layout)
 
-          button_layout = Qt::HBoxLayout.new
-          ok = Qt::PushButton.new("Ok")
-          ok.connect(SIGNAL('clicked()')) do
-            dialog.accept()
-          end
-          button_layout.addWidget(ok)
-          cancel = Qt::PushButton.new("Cancel")
-          cancel.connect(SIGNAL('clicked()')) do
-            dialog.reject()
-          end
-          button_layout.addWidget(cancel)
-          dialog_layout.addLayout(button_layout)
+      button_layout = Qt::HBoxLayout.new
+      ok = Qt::PushButton.new("Ok")
+      ok.connect(SIGNAL('clicked()')) { dialog.accept }
+      button_layout.addWidget(ok)
+      cancel = Qt::PushButton.new("Cancel")
+      cancel.connect(SIGNAL('clicked()')) { dialog.reject }
+      button_layout.addWidget(cancel)
+      dialog_layout.addLayout(button_layout)
 
-          dialog.setLayout(dialog_layout)
-          dialog.show
-          dialog.raise
-          if dialog.exec == Qt::Dialog::Accepted
-            if checkbox.isChecked()
-              enable_limits(target_name, packet_name, item_name)
-            else
-              disable_limits(target_name, packet_name, item_name)
-            end
-          end
-          dialog.dispose
+      dialog.setLayout(dialog_layout)
+      dialog.show
+      dialog.raise
+      if dialog.exec == Qt::Dialog::Accepted
+        if checkbox.isChecked()
+          enable_limits(target_name, packet_name, item_name)
         else
-          Qt::MessageBox.information(parent, "Edit Settings for #{target_name} #{packet_name} #{item_name}",
-            'No Editable Fields for this Item')
+          disable_limits(target_name, packet_name, item_name)
         end
-      rescue DRb::DRbConnError
-        #Just do nothing
       end
+      dialog.dispose
+    rescue DRb::DRbConnError
+      # Just do nothing
     end
-  end # class TlmEditDialog
-
-end # module Cosmos
+  end
+end