cosmos 3.9.2 → 4.0.0

data/lib/cosmos/gui/choosers/float_chooser.rb

@@ -12,12 +12,7 @@ require 'cosmos'
 require 'cosmos/gui/choosers/value_chooser'
 
 module Cosmos
-
   class FloatChooserDoubleValidator < Qt::DoubleValidator
-    def initialize(*args)
-      super(*args)
-    end
-
     def fixup(input)
       begin
         value = input.to_f
@@ -34,10 +29,17 @@ module Cosmos
     end
   end
 
+  # Widget which creates a horizontally laid out label and editable float value.
+  # Minimum and maximum values can be specified to perform input validation.
+  # A callback can be specified which is called once the value is changed.
   class FloatChooser < ValueChooser
-    # Callback for a new value entered into the text field
-    attr_accessor :sel_command_callback
-
+    # @param parent (see ValueChooser#initialize)
+    # @param label_text (see ValueChooser#initialize)
+    # @param initial_value (see ValueChooser#initialize)
+    # @param minimum_value [Float] Minimum allowable value
+    # @param maximum_value [Float] Maximum allowable value
+    # @param field_width (see ValueChooser#initialize)
+    # @param fill (see ValueChooser#initialize)
     def initialize(parent, label_text, initial_value,
                    minimum_value = nil, maximum_value = nil,
                    field_width = 20, fill = false)
@@ -52,14 +54,14 @@ module Cosmos
       @value.setValidator(validator)
     end
 
-    # Returns the value as a float
+    # @return [Float] Value as a float. If minimum and/or maximum values were
+    #   specified and the the value falls outside, it will be set to the
+    #   minimum or maximum as appropriate.
     def value
       float_value = @value.text.to_f
       float_value = @minimum_value if @minimum_value && float_value < @minimum_value
       float_value = @maximum_value if @maximum_value && float_value > @maximum_value
       float_value
     end
-
   end
 end
-

data/lib/cosmos/gui/choosers/integer_chooser.rb

@@ -12,12 +12,7 @@ require 'cosmos'
 require 'cosmos/gui/choosers/value_chooser'
 
 module Cosmos
-
   class IntegerChooserIntValidator < Qt::IntValidator
-    def initialize(*args)
-      super(*args)
-    end
-
     def fixup(input)
       begin
         value = input.to_i
@@ -37,10 +32,17 @@ module Cosmos
     end
   end
 
+  # Widget which creates a horizontally laid out label and editable integer value.
+  # Minimum and maximum values can be specified to perform input validation.
+  # A callback can be specified which is called once the value is changed.
   class IntegerChooser < ValueChooser
-    # Callback called when the value changes
-    attr_accessor :sel_command_callback
-
+    # @param parent (see ValueChooser#initialize)
+    # @param label_text (see ValueChooser#initialize)
+    # @param initial_value (see ValueChooser#initialize)
+    # @param minimum_value [Integer] Minimum allowable value
+    # @param maximum_value [Integer] Maximum allowable value
+    # @param field_width (see ValueChooser#initialize)
+    # @param fill (see ValueChooser#initialize)
     def initialize(parent, label_text, initial_value,
                    minimum_value = nil, maximum_value = nil,
                    field_width = 20, fill = false)
@@ -54,14 +56,14 @@ module Cosmos
       @value.setValidator(validator)
     end
 
-    # Returns the value as an integer
+    # @return [Integer] Value as an integer. If minimum and/or maximum values were
+    #   specified and the the value falls outside, it will be set to the
+    #   minimum or maximum as appropriate.
     def value
       integer_value = @value.text.to_i
       integer_value = @minimum_value if @minimum_value && integer_value < @minimum_value
       integer_value = @maximum_value if @maximum_value && integer_value > @maximum_value
       integer_value
     end
-
   end
 end
-

data/lib/cosmos/gui/choosers/string_chooser.rb

@@ -9,45 +9,27 @@
 # attribution addendums as found in the LICENSE.txt
 
 require 'cosmos'
+require 'cosmos/gui/choosers/value_chooser'
 
 module Cosmos
-
-  class StringChooser < Qt::Widget
-
+  # Widget which creates a horizontally laid out label and editable string value.
+  # A callback can be specified which is called once the value is changed.
+  class StringChooser < ValueChooser
+    # @param parent (see ValueChooser#initialize)
+    # @param label_text (see ValueChooser#initialize)
+    # @param initial_value (see ValueChooser#initialize)
+    # @param field_width (see ValueChooser#initialize)
+    # @param fill (see ValueChooser#initialize)
+    # @param read_only [Boolean] Whether the string is editable
+    # @param alignment [Integer] The alignment of the string value field
     def initialize(
       parent, label_text, initial_value,
-      field_width = 20, fill = false, read_only = false, alignment = Qt::AlignLeft | Qt::AlignVCenter
+      field_width = 20, fill = false, read_only = false,
+      alignment = Qt::AlignLeft | Qt::AlignVCenter
     )
-      super(parent)
-      layout = Qt::HBoxLayout.new(self)
-      layout.setContentsMargins(0,0,0,0)
-      @string_label = Qt::Label.new(label_text)
-      @string_label.setSizePolicy(Qt::SizePolicy::Fixed, Qt::SizePolicy::Fixed) if fill
-      if fill
-        layout.addWidget(@string_label)
-      else
-        layout.addWidget(@string_label, 1)
-      end
-      layout.addStretch unless fill
-      @string_value = Qt::LineEdit.new(initial_value.to_s)
-      @string_value.setMinimumWidth(field_width)
-      @string_value.setReadOnly(true) if read_only
-      @string_value.setAlignment(alignment)
-      layout.addWidget(@string_value)
-      setLayout(layout)
-    end
-
-    # Returns the text field as a string
-    def string
-      @string_value.text
+      super(parent, label_text, initial_value, field_width, fill)
+      @value.setReadOnly(true) if read_only
+      @value.setAlignment(alignment)
     end
-    alias value string
-
-    # Sets the value
-    def value=(new_value)
-      @string_value.setText(new_value.to_s)
-    end
-
-  end # class StringChooser
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/choosers/telemetry_chooser.rb

@@ -13,13 +13,11 @@ require 'cosmos/gui/qt'
 require 'cosmos/system/system'
 
 module Cosmos
-
   # Provides dropdowns to select from all the defined Targets, Packets, and
   # Items. Callbacks can be added when any of the dropdown values are changed
   # as well as when the select button is pressed. Provides an option to orient
   # the dropdowns horizontally or vertically.
   class TelemetryChooser < Qt::Widget
-
     # Width of the button in the Combobox
     COMBOBOX_BUTTON_WIDTH = 30
 
@@ -44,6 +42,14 @@ module Cosmos
     # Label for the item
     attr_accessor :item_label
 
+    # Custom error which we raise and catch
+    class NotFoundError < StandardError
+      # @param msg [String] The error message
+      def initialize(msg)
+        super(msg)
+      end
+    end
+
     # @param parent [Qt::Widget] Parent of this widget
     # @param orientation [Integer] Must be Qt::Horizontal or Qt::Vertical
     # @param choose_item [Boolean] Whether to allow choosing items. Choosing
@@ -52,6 +58,8 @@ module Cosmos
     #   You can disable the button if you just want to implement the dropdown
     #   change callbacks.
     # @param support_latest [Boolean] Whether to add LATEST to the list of packets
+    # @param fill [Boolean] Whether to allow this widget to take all available
+    #   space or have a fixed width/height
     def initialize(
       parent,
       orientation = Qt::Horizontal,
@@ -60,7 +68,6 @@ module Cosmos
       support_latest = false,
       fill = false
     )
-
       super(parent)
       if orientation == Qt::Horizontal
         # Horizontal Frame for overall widget
@@ -69,7 +76,7 @@ module Cosmos
         # Vertical Frame for overall widget
         @overall_frame = Qt::VBoxLayout.new(self)
       end
-      @overall_frame.setContentsMargins(0,0,0,0)
+      @overall_frame.setContentsMargins(0, 0, 0, 0)
 
       # Target Selection
       @target_layout = Qt::HBoxLayout.new
@@ -120,8 +127,6 @@ module Cosmos
       end
 
       if select_button
-        # Select Button
-        #@overall_frame.addStretch()
         @select_button = Qt::PushButton.new('Select')
         @select_button.connect(SIGNAL('clicked()')) do
           @select_button_callback.call(target_name(), packet_name(), item_name()) if @select_button_callback
@@ -137,118 +142,117 @@ module Cosmos
       @support_latest = support_latest
     end
 
-    # Update items
+    # Update all items in all comboboxes. If a previous item was selected that
+    # item will be reselected if it still exists.
     def update
       current_target_name = target_name()
       current_packet_name = packet_name()
       current_item_name = item_name()
       update_targets()
-      if current_target_name and current_packet_name and (current_item_name or !@item_combobox)
+      if current_target_name && current_packet_name && (current_item_name || !@item_combobox)
         begin
           set_item(current_target_name, current_packet_name, current_item_name)
-        rescue Exception
+        rescue NotFoundError
           # Oh well - Tried to keep the same item
         end
       end
     end
 
-    # Set the text of the button
-    def button_text=(button_text)
-      @select_button.setText(button_text)
+    # @param text [String] Select button text
+    def button_text=(text)
+      @select_button.setText(text)
     end
 
-    # Returns the selected target name
+    # @return [String] Selected target name
     def target_name
       @target_combobox.text
     end
 
-    # Returns the selected packet name
+    # @return [String] Selected packet name
     def packet_name
       @packet_combobox.text
     end
 
-    # Returns the selected item name
+    # @return [String] Selected item name
     def item_name
-      if @item_combobox
-        @item_combobox.text
-      else
-        nil
-      end
+      @item_combobox ? @item_combobox.text : nil
     end
 
-    # Returns the list of all target names in the target combobox
+    # @return [Array<String>] List of all target names in the target combobox
     def target_names
       target_names_array = []
-      @target_combobox.each {|item_text, item_data| target_names_array << item_text}
+      @target_combobox.each {|item_text, _item_data| target_names_array << item_text}
       target_names_array
     end
 
-    # Returns the list of all packet names in the packet combobox
+    # @return [Array<String>] List of all packet names in the packet combobox
     def packet_names
       packet_names_array = []
-      @packet_combobox.each {|item_text, item_data| packet_names_array << item_text}
+      @packet_combobox.each {|item_text, _item_data| packet_names_array << item_text}
       packet_names_array
     end
 
-    # Returns the list of all item names in the item combobox
+    # @return [Array<String>] List of all item names in the item combobox
     def item_names
       item_names_array = []
       if @item_combobox
-        @item_combobox.each {|item_text, item_data| item_names_array << item_text}
+        @item_combobox.each {|item_text, _item_data| item_names_array << item_text}
       end
       item_names_array
     end
 
-    # Sets the current packet
+    # Sets the packet combobox
+    # @param target_name [String] Name of the target
+    # @param packet_name [String] Name of the packet
     def set_packet(target_name, packet_name)
       # Select desired target
       index = 0
       found = false
-      @target_combobox.each do |item_text, item_data|
-        if target_name.upcase == item_text.upcase
+      @target_combobox.each do |item_text, _item_data|
+        if target_name.casecmp(item_text).zero?
           found = true
           break
         end
         index += 1
       end
-      Kernel.raise "TelemetryChooser unknown target_name #{target_name}" unless found
+      raise NotFoundError, "TelemetryChooser unknown target_name #{target_name}" unless found
       @target_combobox.setCurrentIndex(index)
       update_packets()
 
       # Select desired packet
       index = 0
       found = false
-      @packet_combobox.each do |item_text, item_data|
-        if packet_name.upcase == item_text.upcase
+      @packet_combobox.each do |item_text, _item_data|
+        if packet_name.casecmp(item_text).zero?
           found = true
           break
         end
         index += 1
       end
-      Kernel.raise "TelemetryChooser unknown packet_name #{packet_name}" unless found
+      raise NotFoundError, "TelemetryChooser unknown packet_name #{packet_name}" unless found
       @packet_combobox.setCurrentIndex(index)
       update_items()
     end
 
-    # Sets the current item
+    # Sets the item combobox
+    # @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 set_item(target_name, packet_name, item_name)
-      # Set the desired packet
       set_packet(target_name, packet_name)
+      return unless @item_combobox
 
-      # Select desired item
-      if @item_combobox
-        index = 0
-        found = false
-        @item_combobox.each do |item_text, item_data|
-          if item_name.upcase == item_text.upcase
-            found = true
-            break
-          end
-          index += 1
+      index = 0
+      found = false
+      @item_combobox.each do |item_text, _item_data|
+        if item_name.casecmp(item_text).zero?
+          found = true
+          break
         end
-        Kernel.raise "TelemetryChooser unknown item_name #{item_name}" unless found
-        @item_combobox.setCurrentIndex(index)
+        index += 1
       end
+      raise NotFoundError, "TelemetryChooser unknown item_name #{item_name}" unless found
+      @item_combobox.setCurrentIndex(index)
     end
 
     protected
@@ -305,22 +309,18 @@ module Cosmos
 
     # Updates the item names based on a change
     def update_items
-      return unless target_name() and packet_name()
-      if @item_combobox
-        @item_combobox.clearItems()
-        item_names = System.telemetry.item_names(target_name(), packet_name())
-        item_names.sort!
-        item_names.each do |name|
-          @item_combobox.addItem(name)
-        end
-        if item_names.length > 20
-          @item_combobox.setMaxVisibleItems(20)
-        else
-          @item_combobox.setMaxVisibleItems(item_names.length)
-        end
+      return unless target_name() && packet_name() && @item_combobox
+      @item_combobox.clearItems()
+      item_names = System.telemetry.item_names(target_name(), packet_name())
+      item_names.sort!
+      item_names.each do |name|
+        @item_combobox.addItem(name)
+      end
+      if item_names.length > 20
+        @item_combobox.setMaxVisibleItems(20)
+      else
+        @item_combobox.setMaxVisibleItems(item_names.length)
       end
     end
-
-  end # class TelemetryChooser
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/choosers/value_chooser.rb

@@ -11,18 +11,24 @@
 require 'cosmos'
 
 module Cosmos
-
+  # Widget which creates a horizontally laid out label and editable value.
+  # A callback can be specified which is called once the value is changed.
   class ValueChooser < Qt::Widget
-
     # Callback for a new value entered into the text field
     attr_accessor :sel_command_callback
 
+    # @param parent [Qt::Widget] Widget to parent this widget to
+    # @param label_text [String] Text to place in the label
+    # @param initial_value [String] Initial value to put in the value box
+    # @param field_width [Integer] Minimum width of the value field
+    # @param fill [Boolean] Whether to make this widget fill up the horizontal
+    #   space allocated to it or be fixed width.
     def initialize(parent, label_text, initial_value, field_width = 20, fill = false)
       super(parent)
       @field_width = field_width
 
       layout = Qt::HBoxLayout.new(self)
-      layout.setContentsMargins(0,0,0,0)
+      layout.setContentsMargins(0, 0, 0, 0)
 
       @label = Qt::Label.new(label_text)
       @label.setSizePolicy(Qt::SizePolicy::Fixed, Qt::SizePolicy::Fixed) if fill
@@ -47,21 +53,15 @@ module Cosmos
       @sel_command_callback = nil
     end
 
-    # Returns the value as a string
-    def string
-      @value.text
-    end
-
-    # Returns the value as a string
+    # @return [String] The value as a string
     def value
-      string()
+      @value.text
     end
+    alias string value
 
-    # Sets the value of the text field
-    def value=(new_value)
-      @value.setText(new_value.to_s)
+    # @param value [#to_s] String to set the value to
+    def value=(value)
+      @value.setText(value.to_s)
     end
-
   end
 end
-