cosmos 4.3.0 → 4.4.0

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

@@ -12,7 +12,7 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget which creates a scrollable window
   class ScrollwindowWidget < Qt::VBoxLayout
     include Widget
     include LayoutWidget
@@ -31,5 +31,4 @@ module Cosmos
       @parent_layout.addWidget(scroll)
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 require 'cosmos/tools/tlm_viewer/widgets/horizontalline_widget'
 
 module Cosmos
-
+  # Vertically stacks a LabelWidget on top of a HorizontallineWidget
   class SectionheaderWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -29,5 +29,4 @@ module Cosmos
       parent_layout.addWidget(self) if parent_layout
     end
   end
-
-end # module Cosmos
+end

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

@@ -12,9 +12,9 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
-  # SpacerWidget class
-  #
+  # Creates a Qt::SpacerItem which affects the positioning of other
+  # widgets around it. The width and height must be given and the
+  # size policy follows. See the Qt documentation for more details.
   class SpacerWidget < Qt::Widget
     include Widget
 
@@ -49,7 +49,5 @@ module Cosmos
           return Qt::SizePolicy::Minimum
       end
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -12,7 +12,7 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget which creates a Qt::TabWidget to contain TABITEM widgets
   class TabbookWidget < Qt::TabWidget
     include Widget
     include LayoutWidget
@@ -22,5 +22,4 @@ module Cosmos
       parent_layout.addWidget(self) if parent_layout
     end
   end
-
-end # module Cosmos
+end

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

@@ -12,7 +12,7 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget used within the TABBOOK widget to create tabs
   class TabitemWidget < Qt::VBoxLayout
     include Widget
     include LayoutWidget
@@ -24,5 +24,4 @@ module Cosmos
       parent_layout.addTab(w, text.to_s) if parent_layout
     end
   end
-
-end # module Cosmos
+end

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

@@ -13,7 +13,8 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/aging_widget'
 
 module Cosmos
-
+  # Displays a text box with the telemetry value. The box creates scrollbars
+  # if the data content is too large to completely display.
   class TextboxWidget < Qt::TextEdit
     include Widget
     include AgingWidget
@@ -24,6 +25,15 @@ module Cosmos
       setFixedSize(width.to_i, height.to_i)
       setReadOnly(true)
       parent_layout.addWidget(self) if parent_layout
+
+      # Create update flag and don't update when the scroll bars are down
+      @update = true
+      verticalScrollBar().connect(SIGNAL('sliderPressed()')) do
+        @update = false
+      end
+      verticalScrollBar().connect(SIGNAL('sliderReleased()')) do
+        @update = true
+      end
     end
 
     def format_value(data)
@@ -31,6 +41,7 @@ module Cosmos
     end
 
     def value=(data)
+      return unless @update
       scroll_pos = self.verticalScrollBar.value
       self.text = super(data, format_value(data))
       self.setColors(@foreground, @background)
@@ -41,7 +52,5 @@ module Cosmos
       super
       process_aging_settings
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -11,16 +11,15 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
+  # Creates a text field
   class TextfieldWidget < Qt::LineEdit
     include Widget
 
-    def initialize (parent_layout, num_characters = 12, default_text = '')
+    def initialize(parent_layout, num_characters = 12, default_text = '')
       super()
       setText(default_text.to_s)
       setMaxLength(num_characters.to_i)
       parent_layout.addWidget(self) if parent_layout
     end
   end
-
-end # module Cosmos
+end

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

@@ -13,10 +13,7 @@ require 'cosmos/tools/tlm_viewer/widgets/linegraph_widget'
 require 'cosmos/script'
 
 module Cosmos
-
-  # TimegraphWidget class
-  #
-  # This class creates a graph of the supplied data value versus time.
+  # This class creates a graph of the supplied data value versus time
   class TimegraphWidget < LinegraphWidget
 
     def initialize(parent_layout, target_name, packet_name, item_name, num_samples = 100, width = 300, height = 200, point_size = 5, time_item_name = 'PACKET_TIMESECONDS', value_type = :CONVERTED)
@@ -85,7 +82,5 @@ module Cosmos
         self.graph
       end
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -8,20 +8,14 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
-require 'cosmos/tools/tlm_viewer/widgets/widget'
+require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 
 module Cosmos
-
-  class TitleWidget < Qt::Label
-    include Widget
-
-    def initialize(parent_layout, text)
-      super()
-      self.text = text.to_s.remove_quotes
-      setFont(Cosmos.getFont("helvetica", 14, Qt::Font::Bold))
+  # Creates a centered label with the specified font
+  class TitleWidget < LabelWidget
+    def initialize(parent_layout, text, font_name = "Helvetica", point_size = 14, bold = "BOLD", italic = false)
+      super(parent_layout, text, font_name, point_size, bold, italic)
       setAlignment(Qt::AlignCenter)
-      parent_layout.addWidget(self) if parent_layout
     end
   end
-
-end # module Cosmos
+end

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

@@ -15,9 +15,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/limitsbar_widget'
 
 module Cosmos
-
+  # Displays a limits bar with the defined limits and a vertical bar indicating
+  # the current value. A black dot is displayed that indicates the value from X
+  # seconds ago (60s by default).
   class TrendbarWidget < LimitsbarWidget
-
     MAX_TREND_SECONDS = 3600.0
 
     def initialize (parent_layout, target_name, packet_name, item_name, value_type = :CONVERTED, trend_seconds = 60.0, width = 160, height = 25, trend_value_handle = nil)
@@ -30,9 +31,6 @@ module Cosmos
       # Track the total number of samples received.  This will help us to know how many
       # trendlines to plot before we reach the maximum.
       @samples_received = 0
-
-      # The actual difference (delta) between the current value and the desired trend value.
-      @trend_delta = nil
       @trend_points = 1
       @trend_data = [0]
     end
@@ -42,9 +40,8 @@ module Cosmos
       adjust_trend_points_and_data()
     end
 
-    def value= (data)
+    def value=(data)
       @value = data.to_f
-
       @samples_received += 1
 
       # Remove the oldest value off the end (right) and insert on the
@@ -123,8 +120,6 @@ module Cosmos
         adjust_trend_points_and_data()
       end
     end
-
   end
-
-end # module Cosmos
+end
 

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

@@ -21,7 +21,10 @@ require 'cosmos/tools/tlm_viewer/widgets/textfield_widget'
 require 'cosmos/tools/tlm_viewer/widgets/trendbar_widget'
 
 module Cosmos
-
+  # Displays the current value followed by the current trend value
+  # (the current value minus the value X samples ago) followed by a
+  # limits bar with the defined limits. The limits bar shows the current
+  # value as a vertical line and the trend value as a black dot.
   class TrendlimitsbarWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -42,5 +45,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -13,7 +13,9 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/aging_widget'
 
 module Cosmos
-
+  # Displays a telemetry value that ages over time by the background fading
+  # from white to grey if the telemetry value is not changing. A new telemetry
+  # value updates the display back to a white background.
   class ValueWidget < Qt::LineEdit
     include Widget
     include AgingWidget
@@ -37,7 +39,5 @@ module Cosmos
       super
       process_aging_settings
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 require 'cosmos/tools/tlm_viewer/widgets/limitsbar_widget'
 
 module Cosmos
-
+  # Displays a ValueWidget followed by a LimitsbarWidget
   class ValuelimitsbarWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -33,5 +33,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 require 'cosmos/tools/tlm_viewer/widgets/limitscolumn_widget'
 
 module Cosmos
-
+  # Vertically stacks a LimitscolumnWidget on a ValueWidget
   class ValuelimitscolumnWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -33,5 +33,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,12 +14,12 @@ require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 require 'cosmos/tools/tlm_viewer/widgets/rangebar_widget'
 
 module Cosmos
-
+  # Displays a ValueWidget followed by a RangebarWidget
   class ValuerangebarWidget < Qt::Widget
     include Widget
     include MultiWidget
 
-    def initialize (parent_layout, target_name, packet_name, item_name, low_value, high_value, value_type = :WITH_UNITS, characters = 12, width = 160, height = 25)
+    def initialize(parent_layout, target_name, packet_name, item_name, low_value, high_value, value_type = :WITH_UNITS, characters = 12, width = 160, height = 25)
       super(target_name, packet_name, item_name, value_type)
       setLayout(Qt::HBoxLayout.new())
       layout.setSpacing(1)
@@ -33,5 +33,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 require 'cosmos/tools/tlm_viewer/widgets/rangecolumn_widget'
 
 module Cosmos
-
+  # Vertically stacks a Rangecolumnwidget over a ValueWidget
   class ValuerangecolumnWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -33,5 +33,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -15,22 +15,23 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget which layouts the enclosed widgets vertically.
+  # Default spacing is 3 pixels and widgets are packed by inserting
+  # a stretch at the end of the added widgets.
   class VerticalWidget < Qt::VBoxLayout
     include Widget
     include LayoutWidget
 
-    def initialize(parent_layout = nil, vSpacing = 3, vPack = true)
+    def initialize(parent_layout = nil, spacing = 3, pack = true)
       super()
-      setSpacing(vSpacing.to_i)
+      setSpacing(spacing.to_i)
       parent_layout.addLayout(self) if parent_layout
-      @v_pack = ConfigParser::handle_true_false(vPack)
+      @pack = ConfigParser::handle_true_false(pack)
     end
 
     def process_settings
       super()
-      addStretch(1) if @v_pack
+      addStretch(1) if @pack
     end
   end
-
-end # module Cosmos
+end

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

@@ -15,24 +15,26 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget which layouts the enclosed widgets vertically
+  # in a visual box with header text.
+  # Default spacing is 3 pixels and widgets are packed by inserting
+  # a stretch at the end of the added widgets.
   class VerticalboxWidget < Qt::VBoxLayout
     include Widget
     include LayoutWidget
 
-    def initialize(parent_layout = nil, title = "", vSpacing = 3, vPack = true)
+    def initialize(parent_layout = nil, title = "", spacing = 3, pack = true)
       super()
       box = Qt::GroupBox.new(title.to_s)
-      setSpacing(vSpacing.to_i)
+      setSpacing(spacing.to_i)
       box.setLayout(self)
       parent_layout.addWidget(box) if parent_layout
-      @v_pack = ConfigParser::handle_true_false(vPack)
+      @pack = ConfigParser::handle_true_false(pack)
     end
 
     def process_settings
       super()
-      addStretch(1) if @v_pack
+      addStretch(1) if @pack
     end
   end
-
-end # module Cosmos
+end

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

@@ -154,53 +154,48 @@ module Cosmos
     end
 
     def process_settings
-      errors = ""
       sheet = []
       @settings.each do |setting_name, setting_values|
-        begin
-          case setting_name
-          when 'TEXTALIGN'
-            sheet << "qproperty-alignment:Align#{setting_values[0].capitalize}"
-          when 'PADDING'
-            sheet << "padding:#{setting_values[0]}"
-          when 'MARGIN'
-            sheet << "margin:#{setting_values[0]}"
-          when 'BACKCOLOR'
-            case setting_values.size
-            when 1 # color name
-              sheet << "background-color:#{setting_values[0]}"
-            when 3 # RGB values
-              sheet << "background-color:rgb(#{setting_values[0].to_i},#{setting_values[1].to_i},#{setting_values[2].to_i})"
-            end
-          when 'TEXTCOLOR'
-            case setting_values.size
-            when 1 # color name
-              sheet << "color:#{setting_values[0]}"
-            when 3 # RGB values
-              sheet << "color:rgb(#{setting_values[0].to_i},#{setting_values[1].to_i},#{setting_values[2].to_i})"
-            end
-          when 'BORDERCOLOR'
-            # Setting the color requires a defined width and style
-            sheet << "border-width:1px"
-            sheet << "border-style:solid"
-            case setting_values.size
-            when 1 # color name
-              sheet << "border-color:#{setting_values[0]}"
-            when 3 # RGB values
-              sheet << "border-color:rgb(#{setting_values[0].to_i}, #{setting_values[1].to_i}, #{setting_values[2].to_i})"
-            end
-          when 'WIDTH'
-            sheet << "min-width:#{setting_values[0].to_i}px"
-            sheet << "max-width:#{setting_values[0].to_i}px"
-          when 'HEIGHT'
-            sheet << "min-height:#{setting_values[0].to_i}px"
-            sheet << "max-height:#{setting_values[0].to_i}px"
-          when 'RAW'
-            next if setting_values[0] == '' # ignore the blank default
-            sheet << setting_values[0]
+        case setting_name
+        when 'TEXTALIGN'
+          sheet << "qproperty-alignment:Align#{setting_values[0].capitalize}"
+        when 'PADDING'
+          sheet << "padding:#{setting_values[0]}"
+        when 'MARGIN'
+          sheet << "margin:#{setting_values[0]}"
+        when 'BACKCOLOR'
+          case setting_values.size
+          when 1 # color name
+            sheet << "background-color:#{setting_values[0]}"
+          when 3 # RGB values
+            sheet << "background-color:rgb(#{setting_values[0].to_i},#{setting_values[1].to_i},#{setting_values[2].to_i})"
+          end
+        when 'TEXTCOLOR'
+          case setting_values.size
+          when 1 # color name
+            sheet << "color:#{setting_values[0]}"
+          when 3 # RGB values
+            sheet << "color:rgb(#{setting_values[0].to_i},#{setting_values[1].to_i},#{setting_values[2].to_i})"
+          end
+        when 'BORDERCOLOR'
+          # Setting the color requires a defined width and style
+          sheet << "border-width:1px"
+          sheet << "border-style:solid"
+          case setting_values.size
+          when 1 # color name
+            sheet << "border-color:#{setting_values[0]}"
+          when 3 # RGB values
+            sheet << "border-color:rgb(#{setting_values[0].to_i}, #{setting_values[1].to_i}, #{setting_values[2].to_i})"
           end
-        rescue => err
-          errors << "Error processing settings due to: #{err}"
+        when 'WIDTH'
+          sheet << "min-width:#{setting_values[0].to_i}px"
+          sheet << "max-width:#{setting_values[0].to_i}px"
+        when 'HEIGHT'
+          sheet << "min-height:#{setting_values[0].to_i}px"
+          sheet << "max-height:#{setting_values[0].to_i}px"
+        when 'RAW'
+          next if setting_values[0] == '' # ignore the blank default
+          sheet << setting_values[0]
         end
       end
       # Only apply the stylesheet if we have settings to apply and this is a widget (not a layout)
@@ -215,7 +210,6 @@ module Cosmos
           pw.setStyleSheet("QWidget##{pw.objectName} { #{sheet.join(';')} }")
         end
       end
-      errors
     end
 
     def context_menu
@@ -249,7 +243,7 @@ module Cosmos
 
       graph = Qt::Action.new("Graph #{@target_name} #{@packet_name} #{@item_name}", menu)
       graph.connect(SIGNAL('triggered()')) do
-        TlmGraphDialog.new(self, target_name, packet_name, item_name)
+        TlmGraphDialog.new(self, target_name, packet_name, item_name, @screen.replay_flag.visible)
       end
       menu.addAction(graph)
 
@@ -258,5 +252,19 @@ module Cosmos
       point.dispose
       menu.dispose
     end
+
+    # Requires the @screen to be set so must not be called in initialize()
+    def get_image(image_name)
+      return nil unless @screen
+      target_screen_dir = File.join(::Cosmos::USERPATH, 'config', 'targets', @screen.original_target_name.upcase, 'screens')
+
+      if File.exist?(File.join(target_screen_dir, image_name))
+        return Qt::Image.new(File.join(target_screen_dir, image_name))
+      elsif Cosmos.data_path(image_name)
+        return Qt::Image.new(Cosmos.data_path(image_name))
+      else
+        raise "Can't find the file #{image_name} in #{target_screen_dir} or the cosmos data directory."
+      end
+    end
   end
 end