cosmos 4.3.0 → 4.4.0

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

@@ -12,7 +12,10 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
+  # Create a checkbox. Typically used as a NAMED_WIDGET which is then
+  # referenced by a BUTTON to perform an action. For example:
+  #   NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks'
+  #   BUTTON 'Send' 'if get_named_widget("CHECK").checked? then cmd_no_hazardous_check("INST CLEAR") else cmd("INST CLEAR") end'
   class CheckbuttonWidget < Qt::CheckBox
     include Widget
 
@@ -34,5 +37,4 @@ module Cosmos
       self.isChecked()
     end
   end
-
-end # module Cosmos
+end

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

@@ -11,7 +11,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
+  # Create a combobox. Typically used as a NAMED_WIDGET which is then
+  # referenced by a BUTTON to perform an action. For example:
+  #   NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL
+  #   BUTTON 'Start Collect' 'cmd("INST COLLECT with TYPE #{get_named_widget("COLLECT_TYPE").text}")'
   class ComboboxWidget < Qt::ComboBox
     include Widget
 
@@ -26,5 +29,4 @@ module Cosmos
       self.currentText
     end
   end
-
-end # module Cosmos
+end

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

@@ -12,7 +12,7 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/formatvalue_widget'
 
 module Cosmos
-  # This class implements a value with configurable font values.  The font
+  # This class implements a value with configurable font values. The font
   # can also be updated after it is created.
   # It inherits from the FormatvalueWidget class.
   class FormatfontvalueWidget < FormatvalueWidget

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

@@ -17,19 +17,16 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 
 module Cosmos
-
+  # Displays a formatted telemetry item done by sprintf using the format_string
   class FormatvalueWidget < ValueWidget
-
-    def initialize (parent_layout, target_name, packet_name, item_name, format_string, value_type = :CONVERTED, characters = 12)
+    def initialize(parent_layout, target_name, packet_name, item_name, format_string, value_type = :CONVERTED, characters = 12)
       super(parent_layout, target_name, packet_name, item_name, value_type, characters)
       @format_string = format_string
     end
 
-    def value= (data)
+    def value=(data)
       formatted_data = sprintf(@format_string, data)
       super(formatted_data)
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -12,16 +12,16 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
+  # Layout widget which layouts the enclosed widgets horizontally.
+  # Default spacing is 0 pixels.
   class HorizontalWidget < Qt::HBoxLayout
     include Widget
     include LayoutWidget
 
-    def initialize(parent_layout = nil, hSpacing = 1)
+    def initialize(parent_layout = nil, spacing = 0)
       super()
-      setSpacing(hSpacing.to_i)
+      setSpacing(spacing.to_i)
       parent_layout.addLayout(self) if parent_layout
     end
   end
-
-end #module Cosmos
+end

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

@@ -12,20 +12,19 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
-
-  # HorizontalboxWidget class
-  #
+  # Layout widget which layouts the enclosed widgets horizontally
+  # in a visual box with header text.
+  # Default spacing is 0 pixels
   class HorizontalboxWidget < Qt::HBoxLayout
     include Widget
     include LayoutWidget
 
-    def initialize(parent_layout, title = "", hSpacing = 0)
+    def initialize(parent_layout, title = "", spacing = 0)
       super()
       box = Qt::GroupBox.new(title.to_s)
-      setSpacing(hSpacing.to_i)
+      setSpacing(spacing.to_i)
       box.setLayout(self)
       parent_layout.addWidget(box) if parent_layout
     end
   end
-
-end # module Cosmos
+end

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

@@ -11,7 +11,7 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
+  # Displays a sunken horizontal line
   class HorizontallineWidget < Qt::Frame
     include Widget
 
@@ -20,7 +20,5 @@ module Cosmos
       setFrameStyle(Qt::Frame::HLine | Qt::Frame::Sunken)
       parent_layout.addWidget(self) if parent_layout
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -12,18 +12,20 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
-
-  # LabelWidget class
-  #
+  # Displays a text label
   class LabelWidget < Qt::Label
     include Widget
 
-    def initialize(parent_layout, text)
+    def initialize(parent_layout, text, font_family = nil, point_size = nil, bold = nil, italic = false)
       super()
-      self.text = text.remove_quotes
+      font = self.font
+      font.setFamily(font_family) unless ConfigParser.handle_nil(font_family).nil?
+      font.setPointSize(point_size.to_i) unless ConfigParser.handle_nil(point_size).nil?
+      font.setBold(true) if bold == 'BOLD'
+      font.setItalic(true) if ConfigParser::handle_true_false(italic) == true
+      setFont(font)
+      self.text = text.to_s.remove_quotes
       parent_layout.addWidget(self) if parent_layout
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -15,7 +15,7 @@ require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 require 'cosmos/tools/tlm_viewer/widgets/formatvalue_widget'
 
 module Cosmos
-
+  # Displays a LabelWidget followed by a FormatvalueWidget
   class LabelformatvalueWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -35,5 +35,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -0,0 +1,58 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# 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/multi_widget'
+require 'cosmos/tools/tlm_viewer/widgets/horizontal_widget'
+require 'cosmos/tools/tlm_viewer/widgets/label_widget'
+require 'cosmos/tools/tlm_viewer/widgets/led_widget'
+
+module Cosmos
+  # Displays a LabelWidget followed by a LedWidget. The layout of the label with
+  # respect to the LED widget can be controlled by the align parameter.
+  class LabelledWidget < Qt::Widget
+    include Widget
+    include MultiWidget
+
+    def initialize(parent_layout, target_name, packet_name, item_name, value_type = :WITH_UNITS, width = 15, height = 15, align = 'split')
+      super(target_name, packet_name, item_name, value_type)
+      setLayout(Qt::HBoxLayout.new)
+      layout.setSpacing(5)
+      layout.setContentsMargins(0,0,0,0)
+      layout.addStretch(1) if align.downcase == 'right' || align.downcase == 'center'
+      @widgets << LabelWidget.new(layout, item_name.to_s + ':')
+      layout.addStretch(1) if align.downcase == 'split'
+      @widgets << LedWidget.new(layout, target_name, packet_name, item_name, value_type, width, height)
+      layout.addStretch(1) if align.downcase == 'left' || align.downcase == 'center'
+      parent_layout.addWidget(self) if parent_layout
+    end
+
+    def self.takes_value?
+      return true
+    end
+
+    # Normally the user would have to use SUBSETTING to set the label and
+    # led parts of this widget but override set_setting so it's easier
+    def set_setting(setting_name, setting_values)
+      case setting_name.upcase
+      # Only apply TEXTALIGN to the value widget by default. It makes the label
+      # look weird when doing LEFT align which is the most common.
+      when 'TEXTALIGN'
+        @widgets[1].set_setting(setting_name, setting_values)
+      when 'TEXTCOLOR' # Apply this to both widgets automatically
+        @widgets[0].set_setting(setting_name, setting_values)
+      when /_COLOR/
+        @widgets[1].set_setting(setting_name, setting_values)
+      else
+        super(setting_name, setting_values)
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 require 'cosmos/tools/tlm_viewer/widgets/progressbar_widget'
 
 module Cosmos
-
+  # Displays a LabelWidget followed by a ProgressbarWidget
   class LabelprogressbarWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -26,7 +26,7 @@ module Cosmos
       layout.setSpacing(0)
       layout.setContentsMargins(0,0,0,0)
       @widgets << LabelWidget.new(layout, item_name.to_s + ':')
-      @widgets << ProgressbarWidget.new(layout, target_name, packet_name, item_name, scale_factor, width)
+      @widgets << ProgressbarWidget.new(layout, target_name, packet_name, item_name, scale_factor, width, value_type)
       parent_layout.addWidget(self) if parent_layout
     end
 
@@ -34,5 +34,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 require 'cosmos/tools/tlm_viewer/widgets/trendlimitsbar_widget'
 
 module Cosmos
-
+  # Displays a LabelWidget indicating the telemetry item followed by a TrendlimitsbarWidget.
   class LabeltrendlimitsbarWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -33,6 +33,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
-
+end

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

@@ -15,7 +15,8 @@ require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 
 module Cosmos
-
+  # Displays a LabelWidget followed by a ValueWidget. The layout of the label with
+  # respect to the value widget can be controlled by the align parameter.
   class LabelvalueWidget < Qt::Widget
     include Widget
     include MultiWidget

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

@@ -14,9 +14,8 @@ require 'cosmos/tools/tlm_viewer/widgets/label_widget'
 require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 
 module Cosmos
-
-  # LabelvalueWidget class
-  #
+  # Displays a LabelWidget which contains the item's description (instead of its name)
+  # followed by a ValueWidget
   class LabelvaluedescWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -38,5 +37,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/labelvalue_widget'
 require 'cosmos/tools/tlm_viewer/widgets/limitsbar_widget'
 
 module Cosmos
-
+  # Displays a LabelvalueWidget followed by a LimitsbarWidget
   class LabelvaluelimitsbarWidget < 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/labelvaluelimitscolumn_widget.rb

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/labelvalue_widget'
 require 'cosmos/tools/tlm_viewer/widgets/limitsbar_widget'
 
 module Cosmos
-
+  # Vertically stacks a LabelWidget, LimitscolumnWidget, and ValueWidget
   class LabelvaluelimitscolumnWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -34,5 +34,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -14,7 +14,7 @@ require 'cosmos/tools/tlm_viewer/widgets/labelvalue_widget'
 require 'cosmos/tools/tlm_viewer/widgets/rangebar_widget'
 
 module Cosmos
-
+  # Displays a LabelvalueWidget followed by a RangebarWidget
   class LabelvaluerangebarWidget < 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/labelvaluerangecolumn_widget.rb

@@ -15,7 +15,7 @@ require 'cosmos/tools/tlm_viewer/widgets/value_widget'
 require 'cosmos/tools/tlm_viewer/widgets/rangecolumn_widget'
 
 module Cosmos
-
+  # Vertically stacks a LabelWidget, RangecolumnWidgetk and ValueWidget
   class LabelvaluerangecolumnWidget < Qt::Widget
     include Widget
     include MultiWidget
@@ -35,5 +35,4 @@ module Cosmos
       return true
     end
   end
-
-end # module Cosmos
+end

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

@@ -9,9 +9,9 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
+  # Module to be included by all layout widgets which will add a class
+  # method named layout_manager? that returns true
   module LayoutWidget
-
     module ClassMethods
       def layout_manager?
         return true
@@ -28,7 +28,5 @@ module Cosmos
     def complete
       # Normally do nothing
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -0,0 +1,108 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'ostruct'
+require 'cosmos/tools/tlm_viewer/widgets/widget'
+
+module Cosmos
+  # This class implements a LED which changes color based on telemetry values.
+  # By default TRUE is green and FALSE is red and all other values are black.
+  # Additional values can be added by using the LED_COLOR setting. For example:
+  #   LED INST PARAMS VALUE3 RAW
+  #     SETTING LED_COLOR 0 GREEN
+  #     SETTING LED_COLOR 1 RED
+  #     SETTING LED_COLOR ANY ORANGE # All other values are ORANGE
+  class LedWidget < Qt::Label
+    include Widget
+
+    def self.takes_value?
+      return true
+    end
+
+    @@brushes = {}
+
+    def initialize(parent_layout, target_name, packet_name, item_name, value_type = :CONVERTED, width = 15, height = 15)
+      super(target_name, packet_name, item_name, value_type)
+      @width = width.to_i
+      @height = height.to_i
+      # Add some sensible defaults, all others must be added using settings
+      @colors = {"TRUE" => "green", "FALSE" => "red"}
+      @painter = nil
+      @color = nil
+      @brush = nil
+      setFixedSize(width.to_i + 3, height.to_i + 3)
+      parent_layout.addWidget(self) if parent_layout
+    end
+
+    # Override set_setting so we can deconflict the LED_COLOR settings
+    # and allow the user to use it multiple times. By default each time
+    # a SETTING name is used it overrides the previous setting.
+    def set_setting(setting_name, setting_values)
+      if setting_name.upcase == 'LED_COLOR'
+        @settings["#{setting_name.upcase}_#{setting_values.join('_')}"] = setting_values
+      else
+        super(setting_name, setting_values)
+      end
+    end
+
+    def process_settings
+      super
+      @settings.each do |setting_name, setting_values|
+        begin
+          if setting_name =~ /^LED_COLOR/
+            @colors[setting_values[0]] = setting_values[1]
+          end
+        rescue => err
+          puts "Error Processing Settings!: #{err}"
+        end
+      end
+    end
+
+    def value=(data)
+      super(data)
+      @color = @colors[data.to_s] # Returns nil if not found
+      @color = @colors['ANY'] unless @color # Check for ANY value
+      @color = @color ? Cosmos::getColor(@color) : Cosmos::BLACK # default to black
+      @brush = @@brushes[@color]
+      unless @brush
+        gradient = Qt::RadialGradient.new(5, 5, 50, 5, 5)
+        gradient.setColorAt(0, @color)
+        gradient.setColorAt(1, Cosmos::BLACK)
+        @brush = Qt::Brush.new(gradient)
+        @@brushes[@color] = @brush
+      end
+      update() # Fire the paintEvent handler
+    end
+
+    def paintEvent(event)
+      begin
+        return if @painter
+        @painter = Qt::Painter.new(self)
+        @painter.setRenderHint(Qt::Painter::Antialiasing, true)
+        # Seems like on initialization sometimes we get some weird bad conditions so check for them
+        if @painter.isActive and @painter.paintEngine
+          paint_implementation(@painter)
+        end
+        @painter.dispose
+        @painter = nil
+      rescue Exception => err
+        Cosmos.handle_fatal_exception(err)
+      end
+    end
+
+    protected
+
+    def paint_implementation(painter)
+      painter.setPen(Qt::NoPen)
+      painter.setBrush(@brush)
+      painter.drawEllipse(1, 1, @width, @height)
+    end
+  end
+end