cosmos 4.3.0 → 4.4.0

data/lib/cosmos/tools/tlm_viewer/widgets/limits_widget.rb

@@ -12,7 +12,6 @@ require 'ostruct'
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
   # This class is a common base class for LimitsbarWidget and
   # LimitscolumnWidget and should not be instantiated
   class LimitsWidget < Qt::Label
@@ -29,6 +28,8 @@ module Cosmos
       @bar_width = @width - (2 * @x_pad)
       @bar_height = @height - (2 * @y_pad)
       @painter = nil
+      @min_value = nil # no minimum
+      @max_value = nil # no maximum
       setFixedSize(width.to_i, height.to_i)
       parent_layout.addWidget(self) if parent_layout
     end
@@ -48,6 +49,18 @@ module Cosmos
       update()
     end
 
+    def process_settings
+      super
+      @settings.each do |setting_name, setting_values|
+        case setting_name
+        when 'MIN_VALUE'
+          @min_value = setting_values[0].to_f
+        when 'MAX_VALUE'
+          @max_value = setting_values[0].to_f
+        end
+      end
+    end
+
     def paintEvent(event)
       begin
         return if @painter
@@ -73,7 +86,7 @@ module Cosmos
       limits
     end
 
-    def calculate_widths(limits, length)
+    def calculate_widths(limits, length, min_value = nil, max_value = nil)
       red_low = limits[0]
       yellow_low = limits[1]
       yellow_high = limits[2]
@@ -83,24 +96,62 @@ module Cosmos
 
       widths = OpenStruct.new
       # Calculate sizes of limits sections
+      # By default the red low and red high sections are each
+      # 10% of the total bar length. After the value goes beyond
+      # a certain point it just rails on the red section.
       widths.red_low  = (0.1 * length).round
       widths.red_high = (0.1 * length).round
 
-      inner_value_range = red_high - red_low
+      if min_value
+        # If the red low is less than the min value we don't display the red low box
+        if red_low <= min_value
+          red_low = min_value
+          widths.red_low = 0
+        end
+        # Determine if any other limits values need to change
+        yellow_low = min_value if yellow_low <= min_value
+        green_low = min_value if green_low && green_low <= min_value
+        green_high = min_value if green_high && green_high <= min_value
+        yellow_high = min_value if yellow_high <= min_value
+        red_high = min_value if red_high <= min_value
+      end
+      if max_value
+        # If the red high is greater than the max value we don't display the red high box
+        if red_high >= max_value
+          red_high = max_value
+          widths.red_high = 0
+        end
+        # Determine if any other limits values need to change
+        yellow_high = max_value if yellow_high >= max_value
+        green_high = max_value if green_high && green_high >= max_value
+        green_low = max_value if green_low && green_low >= max_value
+        yellow_low = max_value if yellow_low >= max_value
+        red_low = max_value if red_low >= max_value
+      end
 
-      widths.yellow_low  = ((yellow_low - red_low)   / inner_value_range * 0.8 * length).round
-      widths.yellow_high = ((red_high - yellow_high) / inner_value_range * 0.8 * length).round
+      # If red == yellow it means there is no red width
+      widths.red_low = 0 if red_low == yellow_low
+      widths.red_high = 0 if red_high == yellow_high
+      # Start with a scale of 0.8 in case we display the red
+      scale = 0.8
+      # Move the scale up if we're not displaying red
+      scale += 0.1 if widths.red_low == 0
+      scale += 0.1 if widths.red_high == 0
+
+      inner_value_range = red_high - red_low
+      widths.yellow_low  = ((yellow_low - red_low)   / inner_value_range * scale * length).round
+      widths.yellow_high = ((red_high - yellow_high) / inner_value_range * scale * length).round
 
       if green_high
-        widths.green_low  = ((green_low - yellow_low)   / inner_value_range * 0.8 * length).round
-        widths.green_high = ((yellow_high - green_high) / inner_value_range * 0.8 * length).round
+        widths.green_low  = ((green_low - yellow_low)   / inner_value_range * scale * length).round
+        widths.green_high = ((yellow_high - green_high) / inner_value_range * scale * length).round
         widths.blue = length - widths.red_low - widths.yellow_low - widths.green_low -
           widths.green_high - widths.yellow_high - widths.red_high
       else
         widths.green = length - widths.red_low - widths.yellow_low -
           widths.yellow_high - widths.red_high
       end
-      widths
+      return [red_low, yellow_low, yellow_high, red_high, green_low, green_high], widths
     end
 
     protected
@@ -109,5 +160,4 @@ module Cosmos
       # Do nothing
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/limitsbar_widget.rb

@@ -11,9 +11,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/limits_widget'
 
 module Cosmos
-
+  # Draw a bar which consists of the red low, yellow low, green with potentially
+  # a blue operational limits inside it, yellow high, and red high. Then draw a
+  # vertical black bar with a little black triangle at the current value location.
   class LimitsbarWidget < LimitsWidget
-
     def initialize(parent_layout, target_name, packet_name, item_name, value_type = :CONVERTED, width = 160, height = 25)
       super(parent_layout, target_name, packet_name, item_name, value_type, width, height)
     end
@@ -26,7 +27,7 @@ module Cosmos
       limits = get_limits()
       return unless limits
 
-      widths = calculate_widths(limits, @bar_width)
+      limits, widths = calculate_widths(limits, @bar_width, @min_value, @max_value)
 
       # Set starting points
       x_pos = @x_pad
@@ -77,9 +78,23 @@ module Cosmos
       # Draw line at current value
       red_low = limits[0]
       red_high = limits[3]
-      @bar_scale = (red_high - red_low) / 0.8
-      @low_value = red_low - 0.1 * @bar_scale
-      @high_value = red_high + 0.1 * @bar_scale
+      # Start with a diviser of 0.8 assuming we'll draw red limits
+      diviser = 0.8
+      # If there is a min or max value equal to the min or or max red limit
+      # it means we're not drawing red bar and the diviser increases
+      diviser += 0.1 if @min_value && limits[0] == @min_value
+      diviser += 0.1 if @max_value && limits[3] == @max_value
+      @bar_scale = (red_high - red_low) / diviser
+      if @min_value && @min_value >= red_low
+        @low_value = @min_value
+      else
+        @low_value = red_low - 0.1 * @bar_scale
+      end
+      if @max_value && @max_value <= red_high
+        @high_value = @max_value
+      else
+        @high_value = red_high + 0.1 * @bar_scale
+      end
 
       if @value.is_a?(Float) && (@value.infinite? || @value.nan?)
         if @value.infinite? == 1
@@ -112,5 +127,4 @@ module Cosmos
       additional_drawing(dc)
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/limitscolor_widget.rb

@@ -11,25 +11,31 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
+  # Displays a circle indicating the given telemetry point's limit state
+  # (red, yellow, green, blue). The circle is followed by the telemetry
+  # item name unless nil is passed to the full_label_display.
   class LimitscolorWidget < Qt::Label
     include Widget
 
-    def initialize(parent_layout, target_name, packet_name, item_name, value_type = :CONVERTED, radius = 10, use_full_item_name = false)
+    def initialize(parent_layout, target_name, packet_name, item_name, value_type = :CONVERTED, radius = 10, full_label_display = false)
       super(target_name, packet_name, item_name, value_type)
       @value_type = :CONVERTED if @value_type == :WITH_UNITS
-      use_full_item_name = ConfigParser::handle_true_false(use_full_item_name)
+      full_label_display = ConfigParser::handle_true_false_nil(full_label_display)
       @painter = nil
       @foreground = Cosmos::BLACK
       parent_layout.addWidget(self) if parent_layout
       @font = font()
       metrics = Cosmos.getFontMetrics(@font)
-      if use_full_item_name
+      if full_label_display
         @item_text = "#{@target_name} #{@packet_name} #{@item_name}"
-      else
+        text_width = metrics.width(@item_text)
+      elsif full_label_display == false
         @item_text = @item_name
+        text_width = metrics.width(@item_text)
+      else # no label
+        @item_text = nil
+        text_width = 0
       end
-      text_width = metrics.width(@item_text)
       @radius = radius.to_i
       @diameter = @radius * 2
       @text_height = @font.pointSize
@@ -85,18 +91,18 @@ module Cosmos
     def paint_implementation(dc)
       dc.setBrush(Cosmos.getBrush(@foreground))
       dc.drawEllipse(0, 0, @diameter, @diameter)
-      dc.setBrush(Cosmos.getBrush(Cosmos::BLACK))
-      dc.drawText(@left_offset, @text_baseline, @item_text)
-
-      #Additional drawing for subclasses
+      if @item_text
+        dc.setBrush(Cosmos.getBrush(Cosmos::BLACK))
+        dc.drawText(@left_offset, @text_baseline, @item_text)
+      end
+      # Additional drawing for subclasses
       additional_drawing(dc)
     end
 
     protected
 
-    def additional_drawing (dc)
+    def additional_drawing(dc)
       # Do nothing
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/limitscolumn_widget.rb

@@ -11,9 +11,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/limits_widget'
 
 module Cosmos
-
+  # Draw a column which consists of the red low, yellow low, green with potentially
+  # a blue operational limits inside it, yellow high, and red high. Then draw a
+  # horizontal black bar with a little black triangle at the current value location.
   class LimitscolumnWidget < LimitsWidget
-
     def initialize(parent_layout, target_name, packet_name, item_name, value_type = :CONVERTED, width = 30, height = 100)
       super(parent_layout, target_name, packet_name, item_name, value_type, width, height)
     end
@@ -26,7 +27,7 @@ module Cosmos
       limits = get_limits()
       return unless limits
 
-      widths = calculate_widths(limits, @bar_height)
+      limits, widths = calculate_widths(limits, @bar_height, @min_value, @max_value)
 
       # Set starting points
       x_pos = @x_pad
@@ -77,9 +78,23 @@ module Cosmos
       # Draw line at current value
       red_low = limits[0]
       red_high = limits[3]
-      @bar_scale = (red_high - red_low) / 0.8
-      @low_value = red_low - 0.1 * @bar_scale
-      @high_value = red_high + 0.1 * @bar_scale
+      # Start with a diviser of 0.8 assuming we'll draw red limits
+      diviser = 0.8
+      # If there is a min or max value equal to the min or or max red limit
+      # it means we're not drawing red bar and the diviser increases
+      diviser += 0.1 if @min_value && limits[0] == @min_value
+      diviser += 0.1 if @max_value && limits[3] == @max_value
+      @bar_scale = (red_high - red_low) / diviser
+      if @min_value && @min_value >= red_low
+        @low_value = @min_value
+      else
+        @low_value = red_low - 0.1 * @bar_scale
+      end
+      if @max_value && @max_value <= red_high
+        @high_value = @max_value
+      else
+        @high_value = red_high + 0.1 * @bar_scale
+      end
 
       if @value.is_a?(Float) && (@value.infinite? || @value.nan?)
         if @value.infinite? == 1
@@ -112,5 +127,4 @@ module Cosmos
       additional_drawing(dc)
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/linegraph_widget.rb

@@ -13,7 +13,7 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/gui/line_graph/line_graph'
 
 module Cosmos
-
+  # Displays a graph of the given telemetry item
   class LinegraphWidget < LineGraph
     include Widget
 
@@ -59,5 +59,4 @@ module Cosmos
   def get_tooltip_text
     return nil
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/matrixbycolumns_widget.rb

@@ -12,7 +12,9 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget which creates a grid of the specified number of columns.
+  # A new row is created as widgets are added to the grid and exceed the
+  # specified number of columns.
   class MatrixbycolumnsWidget < Qt::GridLayout
     include Widget
     include LayoutWidget
@@ -54,5 +56,4 @@ module Cosmos
       end
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/multi_widget.rb

@@ -11,7 +11,6 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
   # The MultiWidget module must be included after the Widget module by all widget
   # classes that consist of multiple other COSMOS widgets. It overrides methods
   # in the Widget module to support setting all the subwidgets that comprise
@@ -112,5 +111,4 @@ module Cosmos
       end
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/progressbar_widget.rb

@@ -11,24 +11,29 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
+  # Displays a progress bar based on the given telemetry item. The item should
+  # return a value between 0 and 100 which will be used to update the progress.
+  # You can also set a scale factor to multiply the telemetry item by before
+  # setting the progress.
   class ProgressbarWidget < Qt::ProgressBar
     include Widget
 
     def initialize(parent_layout, target_name, packet_name, item_name, scale_factor = 1.0, width = 80, value_type = :CONVERTED)
       super(target_name, packet_name, item_name, value_type)
       @scale_factor = scale_factor.to_f
-      self.setFixedWidth(width.to_i)
+      setFixedWidth(width.to_i)
       parent_layout.addWidget(self) if parent_layout
     end
 
     def value=(value)
-      setValue((value.to_f * @scale_factor).to_i)
+      value = (value.to_f * @scale_factor).to_i
+      # Truncate to 100 because otherwise it will not display
+      value = 100 if value > 100
+      setValue(value)
     end
 
     def ProgressbarWidget.takes_value?
       return true
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/radiobutton_widget.rb

@@ -12,8 +12,12 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
-  class RadiobuttonWidget < Qt::RadioButton
+  # Create a radio button. Typically used as a NAMED_WIDGET which is then
+  # referenced by a BUTTON to perform an action. For example:
+  #   NAMED_WIDGET ABORT RADIOBUTTON 'Abort' CHECKED
+  #   NAMED_WIDGET CLEAR RADIOBUTTON 'Clear' UNCHECKED
+  #   BUTTON 'Send' 'if get_named_widget("ABORT").checked? then cmd("INST ABORT") else cmd("INST CLEAR") end'
+class RadiobuttonWidget < Qt::RadioButton
     include Widget
 
     def initialize(parent_layout, radiobutton_text, checked = 'UNCHECKED')
@@ -34,5 +38,4 @@ module Cosmos
       self.isChecked()
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/rangebar_widget.rb

@@ -11,10 +11,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/limitsbar_widget'
 
 module Cosmos
-
+  # Display a bar with a vertical current value indicator which moves based
+  # on the value of the given telemetry item
   class RangebarWidget < LimitsbarWidget
-
-    def initialize (parent_layout, target_name, packet_name, item_name, low_value, high_value, value_type = :CONVERTED, width = 160, height = 25)
+    def initialize(parent_layout, target_name, packet_name, item_name, low_value, high_value, value_type = :CONVERTED, width = 160, height = 25)
       super(parent_layout, target_name, packet_name, item_name, value_type, width, height)
       @low_value = low_value.to_s.convert_to_value
       @high_value = high_value.to_s.convert_to_value
@@ -59,7 +59,5 @@ module Cosmos
       #Additional drawing for subclasses
       additional_drawing(dc)
     end
-
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/rangecolumn_widget.rb

@@ -11,9 +11,9 @@
 require 'cosmos/tools/tlm_viewer/widgets/limitscolumn_widget'
 
 module Cosmos
-
+  # Display a column with a horizontal current value indicator which moves based
+  # on the value of the given telemetry item
   class RangecolumnWidget < LimitscolumnWidget
-
     def initialize(parent_layout, target_name, packet_name, item_name, low_value, high_value, value_type = :CONVERTED, width = 30, height = 100)
       super(parent_layout, target_name, packet_name, item_name, value_type, width, height)
       @low_value = low_value.to_s.convert_to_value
@@ -59,7 +59,5 @@ module Cosmos
       #Additional drawing for subclasses
       additional_drawing(dc)
     end
-
   end
-
-end # module Cosmos
+end

data/lib/cosmos/tools/tlm_viewer/widgets/screenshotbutton_widget.rb

@@ -12,7 +12,9 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/gui/utilities/screenshot'
 
 module Cosmos
-
+  # Creates a button that takes a screenshot of the screen it is on.
+  # The output file location can be specified or by default it goes to
+  # the system LOGS directory (output/logs)
   class ScreenshotbuttonWidget < Qt::PushButton
     include Widget
 
@@ -30,5 +32,4 @@ module Cosmos
       end
     end
   end
-
-end # module Cosmos
+end