cosmos 3.9.2 → 4.0.0

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

@@ -51,7 +51,7 @@ module Cosmos
 
       @pry_history = []
       @pry_frame = Qt::HBoxLayout.new
-      @pry_frame.setContentsMargins(0,0,0,0)
+      @pry_frame.setContentsMargins(0, 0, 0, 0)
       @pry_frame_label = Qt::Label.new("Pry:")
       @pry_frame.addWidget(@pry_frame_label)
       @pry_text = PryLineEdit.new(self)
@@ -63,7 +63,7 @@ module Cosmos
           pry_text = @pry_text.text
           @pry_history.unshift(pry_text)
           @pry_history_index = 0
-          if pry_text.strip == 'exit' or pry_text.strip == 'quit'
+          if (pry_text.strip == 'exit') || (pry_text.strip == 'quit')
             return_value = false
             self.close
           else
@@ -75,7 +75,7 @@ module Cosmos
             @pry_text.setText(@pry_history[@pry_history_index])
             @pry_history_index += 1
             if @pry_history_index == @pry_history.length
-              @pry_history_index = @pry_history.length-1
+              @pry_history_index = @pry_history.length - 1
             end
           end
         when Qt::Key_Down
@@ -101,7 +101,7 @@ module Cosmos
         Pry.config.pager = false
         Pry.config.color = false
         Pry.config.correct_indent = false
-        Pry.start pry_binding, :input => self, :output => self
+        Pry.start pry_binding, input: self, output: self
         @pry_thread = nil
       end
     end

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

@@ -17,6 +17,9 @@ module Cosmos
     SCREEN_WIDTH_MARGIN = 40
     SCREEN_HEIGHT_MARGIN = 100
 
+    # @param parent [Qt::Widget] Parent of this dialog
+    # @param title [String] Dialog title
+    # @param text [String] Text to display
     # @param parent [Qt::Widget] Parent of this dialog
     # @param title [String] Dialog title
     # @param text [String] Text to display

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

@@ -20,7 +20,7 @@ module Cosmos
   # 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']
+    IGNORED_ITEMS = ['RECEIVED_TIMESECONDS', 'RECEIVED_TIMEFORMATTED', 'RECEIVED_COUNT', 'PKTID', 'CONFIG']
 
     # @return [String] Errors encountered when trying to set the values back
     #   into the packet
@@ -49,7 +49,6 @@ module Cosmos
       super(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
       @target_name = target_name
       @packet_name = packet_name
-      @current_item_name = nil
 
       extend Api if CmdTlmServer.instance
 
@@ -58,7 +57,7 @@ module Cosmos
       else
         @items = packet.read_all_with_limits_states
       end
-      @items.delete_if {|item_name, _, _| ['RECEIVED_TIMESECONDS', 'RECEIVED_TIMEFORMATTED', 'RECEIVED_COUNT'].include?(item_name)}
+      @items.delete_if {|item_name, _, _| IGNORED_ITEMS.include?(item_name)}
 
       setWindowTitle(title)
       Cosmos.load_cosmos_icon
@@ -94,7 +93,7 @@ module Cosmos
           @editors[-1].text = item_value.to_s
         end
         values_layout.addRow(item_name, @editors[-1])
-        if ((@editors.length % 10) == 0 and @items.length > @editors.length)
+        if (@editors.length % 10 == 0) && (@items.length > @editors.length)
           values_layout = Qt::FormLayout.new
           widget = Qt::Widget.new
           widget.layout = values_layout
@@ -125,11 +124,13 @@ module Cosmos
     # Set all user edited items from the dialog back into the packet
     def set_items
       index = 0
+      item_hash = {}
       @items.each do |item_name, _, _|
-        @current_item_name = item_name
-        set_tlm(@target_name, @packet_name, item_name, @editors[index].text)
+        item_hash[item_name] = @editors[index].text
         index += 1
       end
+      # Send to routers, and start new logs (which should inject the META packet)
+      inject_tlm(@target_name, @packet_name, item_hash, :CONVERTED, true, false, true)
     end
 
     # (see #initialize)

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

@@ -58,7 +58,7 @@ module Cosmos
       # @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
+        if !@complete && (@progress != progress_int)
           @progress = progress_int
           Qt.execute_in_main_thread(false) do
             @progress_bar.setValue(progress_int)

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

@@ -151,7 +151,7 @@ module Cosmos
     def update_limits_details(limits_settings, limits_set)
       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]
+      if limits_settings[0][4] && limits_settings[0][5]
         label_text << " GL/#{limits_settings[0][4]} GH/#{limits_settings[0][5]}"
       end
       if @limits_labels[limits_set]

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

@@ -0,0 +1,114 @@
+# 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
+
+# This file contains the implementation and TlmGraphDialog class.   This class
+# is used to open a telemetry grapher to graph a telemetry item, typically on 
+# a right click.
+
+require 'cosmos'
+require 'cosmos/gui/qt'
+require 'cosmos/gui/choosers/integer_chooser'
+require 'cosmos/script'
+
+module Cosmos
+  # Dialog which allows the user to start graphing the given item.  If the
+  # item is a fixed-size array, this allows the user to determine whether to 
+  # graph a single index within the array or all indices within the array.
+  # If the item is a variable-sized array, this allows the user to select a
+  # single index to graph.
+  class TlmGraphDialog
+    # @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)
+      packet, item = System.telemetry.packet_and_item(target_name, packet_name, item_name)
+
+      num_array_elements = 0
+      if item.array_size
+        if item.array_size > 0
+          # Fixed size array
+          num_array_elements = item.array_size / item.bit_size
+        else
+          # Variable size array
+          num_array_elements = -1
+        end
+      end
+      
+      item_string = ""
+
+      if num_array_elements != 0
+        dialog = Qt::Dialog.new(parent, Qt::WindowTitleHint | Qt::WindowSystemMenuHint)
+        dialog.setWindowTitle("Select array index")
+        dialog_layout = Qt::VBoxLayout.new
+        dialog_layout.addWidget(Qt::Label.new("#{target_name} #{packet_name} #{item_name} is an array."))
+        
+        if num_array_elements > 0
+          dialog_layout.addWidget(Qt::Label.new("Select array index to graph or graph all:"))
+          index_chooser = IntegerChooser.new(parent, 'Array Index:', 0, 0, num_array_elements-1)
+        else
+          dialog_layout.addWidget(Qt::Label.new("Select array index to graph:"))
+          index_chooser = IntegerChooser.new(parent, 'Array Index:', 0, 0)  
+        end
+        dialog_layout.addWidget(index_chooser)
+
+        checkbox = nil
+        if num_array_elements > 0
+          check_layout = Qt::HBoxLayout.new
+          check_label = Qt::Label.new("Graph all:")
+          checkbox = Qt::CheckBox.new
+          checkbox.setChecked(false)
+          check_label.setBuddy(checkbox)
+          check_layout.addWidget(check_label)
+          check_layout.addWidget(checkbox)
+          dialog_layout.addLayout(check_layout)
+        end
+
+        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
+          indices_to_graph = [index_chooser.value.to_i]
+          if num_array_elements > 0 and checkbox.isChecked()
+            indices_to_graph = (0..num_array_elements-1).to_a
+          end
+          indices_to_graph.each {|i| item_string << "-i \"#{target_name} #{packet_name} #{item_name}[#{i}]\" "}
+        else
+          # Cancel - graph nothing.
+          item_string = ""
+        end
+        dialog.dispose
+      else
+        # This is not an array item, we don't need to create a dialog box...
+        item_string << "-i \"#{target_name} #{packet_name} #{item_name}\" "
+      end
+
+      # Start grapher if necessary.
+      if !item_string.empty?
+        if Kernel.is_windows?
+          Cosmos.run_process("rubyw tools/TlmGrapher #{item_string} --system #{File.basename(System.initial_filename)}")
+        elsif Kernel.is_mac? and File.exist?("tools/mac/TlmGrapher.app")
+          Cosmos.run_process("open tools/mac/TlmGrapher.app --args #{item_string} --system #{File.basename(System.initial_filename)}")
+        else
+          Cosmos.run_process("ruby tools/TlmGrapher #{item_string} --system #{File.basename(System.initial_filename)}")
+        end
+      end
+    end
+  end
+end

data/lib/cosmos/gui/line_graph/line_graph.rb

@@ -9,7 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 require 'cosmos'
-require 'cosmos/ext/line_graph'
+require 'cosmos/ext/line_graph' # Only supported with MRI
 require 'cosmos/gui/qt'
 require 'cosmos/gui/dialogs/exception_dialog'
 require 'cosmos/gui/line_graph/lines'
@@ -18,10 +18,11 @@ require 'cosmos/gui/line_graph/line_graph_scaling'
 require 'cosmos/gui/line_graph/line_graph_popups'
 
 module Cosmos
-
-  # GUI object to display a line graph
+  # Widget which displays a line graph. Graph provides decorations such as
+  # titles, labels, grid lines, and a legend. Mouse tracking is provided to allow
+  # popups on graph values. Automatic scaling is provided to scale the X and Y
+  # axis according to the data values.
   class LineGraph < Qt::Widget
-
     # Create attr_accessors that automatically set the redraw_needed flag when
     # they are set
     def self.attr_accessor_with_redraw(*symbols)
@@ -250,7 +251,7 @@ module Cosmos
       @in_update_graph_size = false
 
       # Time of previous left button release
-      @previous_left_button_release_time = Time.now
+      @previous_left_button_release_time = Time.now.sys
 
       # List of line colors to use
       @color_list = ['blue','red','green','darkorange', 'gold', 'purple', 'hotpink', 'lime', 'cornflowerblue', 'brown', 'coral', 'crimson', 'indigo', 'tan', 'lightblue', 'cyan', 'peru', 'maroon','orange','navy','teal','black']
@@ -321,7 +322,7 @@ module Cosmos
     end # def mousePressEvent
 
     def mouseReleaseEvent(event)
-      left_button_release_time = Time.now
+      left_button_release_time = Time.now.sys
 
       if @error and ((left_button_release_time - @previous_left_button_release_time) < DOUBLE_CLICK_SECONDS)
         @pre_error_callback.call(self) if @pre_error_callback
@@ -477,7 +478,5 @@ module Cosmos
       @horizontal_lines << [y_value, color, axis]
       @redraw_needed = true
     end
-
-  end # class LineGraph
-end # module Cosmos
-
+  end
+end

data/lib/cosmos/gui/line_graph/line_graph_dialog.rb

@@ -13,12 +13,15 @@ require 'cosmos/gui/qt'
 require 'cosmos/gui/line_graph/line_graph'
 
 module Cosmos
-
+  # Creates a dialog with a {LineGraph} in it
   class LineGraphDialog < Qt::Dialog
-
+    # @return [LineGraph] The dialog line graph
     attr_accessor :line_graph
 
-    def initialize (title, width=400, height=300) 
+    # @param title [String] Dialog title
+    # @param width [Integer] Dialog width
+    # @param height [Integer] Dialog height
+    def initialize(title, width = 400, height = 300)
       super(Qt::CoreApplication.instance.activeWindow)
       self.window_title = title
       @layout = Qt::VBoxLayout.new
@@ -30,5 +33,4 @@ module Cosmos
       resize(width, height)
     end
   end
-
-end # end module Cosmos
+end

data/lib/cosmos/gui/line_graph/line_graph_drawing.rb

@@ -9,8 +9,6 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
-  # LineGraph class continued
   class LineGraph < Qt::Widget
     # Pixels for a label tick
     LABEL_TICK_SIZE = 3
@@ -248,7 +246,7 @@ module Cosmos
       if !@show_popup_x_y && @unix_epoch_x_values
         # Determine if the value is a time stamp and should be converted
         if value > 1 && value < 2147483647
-          time = Time.at(value)
+          time = Time.at(value).sys
           time = time.utc if @utc_time
           if full_date
             time.formatted # full date with day, month, year
@@ -519,7 +517,5 @@ module Cosmos
       end
       text
     end
-
-  end # end class LineGraph
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/line_graph/line_graph_popups.rb

@@ -9,10 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
-  # LineGraph class continued
   class LineGraph < Qt::Widget
-
     # Builds popups associated with an x value
     def build_popups_from_x_value(x_value)
       # Clear any existing popups
@@ -110,8 +107,6 @@ module Cosmos
           next_graph_y += @popups[popup_index][4] + 2
         end
       end
-    end # def adjust_popup_positions
-
-  end # class LineGraph
-end # module Cosmos
-
+    end
+  end
+end

data/lib/cosmos/gui/line_graph/line_graph_scaling.rb

@@ -9,10 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
-  # LineGraph class continued
   class LineGraph < Qt::Widget
-
     # Spacer between items
     GRAPH_SPACER = 5
 
@@ -451,7 +448,5 @@ module Cosmos
       end
       return scale
     end
-
-  end # class LineGraph
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/line_graph/overview_graph.rb

@@ -12,9 +12,14 @@ require 'cosmos'
 require 'cosmos/gui/line_graph/line_graph'
 
 module Cosmos
-
+  # The overview graph provides a graph which contains the entire graph
+  # history. It provides a window with draggable bars that expands the viewport
+  # on graph. Expanding this viewport results in a callback that can be used to
+  # adjust the view on a different graph.
   class OverviewGraph < LineGraph
+    # Default zoom when pressing the up or down arrow keys
     DEFAULT_ZOOM_FACTOR = 0.1 # 10 percent
+    # Default pan when pressing the left or right arrow keys
     DEFAULT_PAN_FACTOR  = 0.1 # 10 percent
 
     # Minimum allowed size of the window in seconds plotted

data/lib/cosmos/gui/opengl/earth_model.rb

@@ -12,11 +12,14 @@ require 'cosmos'
 require 'cosmos/gui/opengl/texture_mapped_sphere'
 
 module Cosmos
-
+  # Three dimensional model of the earth by mapping a picture of the earth onto
+  # a sphere.
   class EarthModel < TextureMappedSphere
+    # @param x (see TextureMappedSphere#initialize)
+    # @param y (see TextureMappedSphere#initialize)
+    # @param z (see TextureMappedSphere#initialize)
     def initialize(x, y, z)
       super(x, y, z, File.join(::Cosmos::PATH, 'data', 'EarthMap1024x512.gif'))
     end
   end
-
-end # module Cosmos
+end

data/lib/cosmos/gui/opengl/gl_bounds.rb

@@ -9,9 +9,9 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
+  # Defines the boundary for a {GlScene}.
   class GlBounds
-    def initialize (x0, x1, y0, y1, z0, z1)
+    def initialize(x0, x1, y0, y1, z0, z1)
       @x0 = x0
       @x1 = x1
       @y0 = y0
@@ -20,7 +20,10 @@ module Cosmos
       @z1 = z1
     end
 
-    def [] (index)
+    # @param index [Integer] 0 based index into the bounds variables. Bounds
+    #   are returned in the following order: x0, x1, y0, y1, z0, z1.
+    # @return [Integer] Boundary value
+    def [](index)
       case index
       when 0
         @x0
@@ -39,29 +42,14 @@ module Cosmos
       end
     end
 
+    # @return [Array<Integer, Integer, Integer>] The center of the bounds
     def center
       [(@x0 + @x1) / 2.0, (@y0 + @y1) / 2.0, (@z0 + @z1) / 2.0]
     end
 
+    # @return [Integer] The longest dimension of the bounds
     def longest
-      x = @x1 - @x0
-      y = @y1 - @y0
-      z = @z1 - @z0
-      if x > y
-        if x > z
-          x
-        else
-          z
-        end
-      else
-        if y > z
-          y
-        else
-          z
-        end
-      end
+      [@x1 - @x0, @y1 - @y0, @z1 - @z0].max
     end
-
-  end # class Bounds
-
-end # module Cosmos
+  end
+end