cosmos 3.0.1 → 3.1.0

data/lib/cosmos/tools/cmd_tlm_server/interfaces.rb

@@ -1,127 +1,127 @@
-# 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/cmd_tlm_server/connections'
-
-module Cosmos
-
-  # Controls the interfaces as defined in the Command/Telemetry configuration
-  # file. Interfaces provide the connection between the Command and Telemetry
-  # Server and targets. They send command packets to and receive telemetry
-  # packets from targets.
-  class Interfaces < Connections
-
-    # @param cmd_tlm_server_config [CmdTlmServerConfig] The configuration which
-    #   defines all the routers
-    # @param identified_packet_callback [#call(Packet)] Callback which is called
-    #   when a packet has been  received from the interface and identified.
-    def initialize(cmd_tlm_server_config, identified_packet_callback = nil)
-      super(:INTERFACES, cmd_tlm_server_config)
-      @identified_packet_callback = identified_packet_callback
-    end
-
-    # Determines all targets in the system and maps them to the given interface
-    #
-    # @param interface_name [String] The interface to map all targets to
-    def map_all_targets(interface_name)
-      interface = @config.interfaces[interface_name.upcase]
-      raise "Unknown interface: #{interface_name}" unless interface
-      System.targets.each do |target_name, target|
-        target.interface = interface
-        interface.target_names << target_name
-      end
-    end
-
-    # Maps a target to an interface and unmaps the target from its existing
-    # interface if present.
-    #
-    # @param target_name [String] The name of the target to map
-    # @param interface_name [String] The name of the interface to map the
-    #   target to
-    def map_target(target_name, interface_name)
-      # Find the new interface
-      new_interface = @config.interfaces[interface_name.upcase]
-      raise "Unknown interface: #{interface_name}" unless new_interface
-
-      # Find the target
-      target = System.targets[target_name.upcase]
-      raise "Unknown target: #{target_name}" unless target
-
-      # Find the old interface
-      old_interface = System.targets[target_name.upcase].interface
-
-      # Remove target from old interface
-      old_interface.target_names.delete(target_name.upcase) if old_interface
-
-      # Add target to new interface
-      new_interface.target_names << target_name.upcase unless new_interface.target_names.include? target_name.upcase
-
-      # Update targets
-      System.targets[target_name.upcase].interface = new_interface
-    end
-
-    # Recreate an interface with new initialization parameters
-    #
-    # @param interface_name [String] Name of the interface
-    # @param params [Array] Array of parameters to pass to the interface
-    #   constructor
-    def recreate(interface_name, *params)
-      interface = @config.interfaces[interface_name.upcase]
-      raise "Unknown interface: #{interface_name}" unless interface
-
-      # Build New Interface
-      new_interface = interface.class.new(*params)
-      interface.copy_to(new_interface)
-
-      # Replace interface for targets
-      System.targets.each do |target_name, target|
-        target.interface = new_interface if target.interface == interface
-      end
-
-      # Replace interface for routers
-      @config.routers.each do |router_name, router|
-        if router.interfaces.include?(interface)
-          router.interfaces.delete(interface)
-          router.interfaces << new_interface
-        end
-      end
-
-      # Replace interface in @interfaces array
-      @config.interfaces[interface_name.upcase] = new_interface
-
-      # Make sure there is no thread
-      stop_thread(interface)
-
-      return new_interface
-    end
-
-    protected
-
-    # Start an interface's packet reading thread
-    def start_thread(interface)
-      Logger.info "Creating thread for interface #{interface.name}"
-      interface_thread = InterfaceThread.new(interface)
-      interface_thread.identified_packet_callback = @identified_packet_callback
-      interface_thread.start
-    end
-
-    # Stop an interface's packet reading thread
-    def stop_thread(interface)
-      if interface.thread
-        Logger.info "Killing thread for interface #{interface.name}"
-        to_stop = interface.thread
-        interface.thread = nil
-        to_stop.stop
-      end
-    end
-
-  end # class Interfaces
-
-end # module Cosmos
+# 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/cmd_tlm_server/connections'
+
+module Cosmos
+
+  # Controls the interfaces as defined in the Command/Telemetry configuration
+  # file. Interfaces provide the connection between the Command and Telemetry
+  # Server and targets. They send command packets to and receive telemetry
+  # packets from targets.
+  class Interfaces < Connections
+
+    # @param cmd_tlm_server_config [CmdTlmServerConfig] The configuration which
+    #   defines all the routers
+    # @param identified_packet_callback [#call(Packet)] Callback which is called
+    #   when a packet has been  received from the interface and identified.
+    def initialize(cmd_tlm_server_config, identified_packet_callback = nil)
+      super(:INTERFACES, cmd_tlm_server_config)
+      @identified_packet_callback = identified_packet_callback
+    end
+
+    # Determines all targets in the system and maps them to the given interface
+    #
+    # @param interface_name [String] The interface to map all targets to
+    def map_all_targets(interface_name)
+      interface = @config.interfaces[interface_name.upcase]
+      raise "Unknown interface: #{interface_name}" unless interface
+      System.targets.each do |target_name, target|
+        target.interface = interface
+        interface.target_names << target_name
+      end
+    end
+
+    # Maps a target to an interface and unmaps the target from its existing
+    # interface if present.
+    #
+    # @param target_name [String] The name of the target to map
+    # @param interface_name [String] The name of the interface to map the
+    #   target to
+    def map_target(target_name, interface_name)
+      # Find the new interface
+      new_interface = @config.interfaces[interface_name.upcase]
+      raise "Unknown interface: #{interface_name}" unless new_interface
+
+      # Find the target
+      target = System.targets[target_name.upcase]
+      raise "Unknown target: #{target_name}" unless target
+
+      # Find the old interface
+      old_interface = System.targets[target_name.upcase].interface
+
+      # Remove target from old interface
+      old_interface.target_names.delete(target_name.upcase) if old_interface
+
+      # Add target to new interface
+      new_interface.target_names << target_name.upcase unless new_interface.target_names.include? target_name.upcase
+
+      # Update targets
+      System.targets[target_name.upcase].interface = new_interface
+    end
+
+    # Recreate an interface with new initialization parameters
+    #
+    # @param interface_name [String] Name of the interface
+    # @param params [Array] Array of parameters to pass to the interface
+    #   constructor
+    def recreate(interface_name, *params)
+      interface = @config.interfaces[interface_name.upcase]
+      raise "Unknown interface: #{interface_name}" unless interface
+
+      # Build New Interface
+      new_interface = interface.class.new(*params)
+      interface.copy_to(new_interface)
+
+      # Replace interface for targets
+      System.targets.each do |target_name, target|
+        target.interface = new_interface if target.interface == interface
+      end
+
+      # Replace interface for routers
+      @config.routers.each do |router_name, router|
+        if router.interfaces.include?(interface)
+          router.interfaces.delete(interface)
+          router.interfaces << new_interface
+        end
+      end
+
+      # Replace interface in @interfaces array
+      @config.interfaces[interface_name.upcase] = new_interface
+
+      # Make sure there is no thread
+      stop_thread(interface)
+
+      return new_interface
+    end
+
+    protected
+
+    # Start an interface's packet reading thread
+    def start_thread(interface)
+      Logger.info "Creating thread for interface #{interface.name}"
+      interface_thread = InterfaceThread.new(interface)
+      interface_thread.identified_packet_callback = @identified_packet_callback
+      interface_thread.start
+    end
+
+    # Stop an interface's packet reading thread
+    def stop_thread(interface)
+      if interface.thread
+        Logger.info "Killing thread for interface #{interface.name}"
+        to_stop = interface.thread
+        interface.thread = nil
+        to_stop.stop
+      end
+    end
+
+  end # class Interfaces
+
+end # module Cosmos

data/lib/cosmos/tools/cmd_tlm_server/packet_logging.rb

@@ -1,132 +1,132 @@
-# 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
-
-module Cosmos
-
-  # Controls the packet loggers which were configured by CmdTlmServerConfig.
-  # This includes starting and stopping both command and telemetry logging.
-  class PacketLogging
-    # @param cmd_tlm_server_config [CmdTlmServerConfig] The configuration which
-    #   defines the packet loggers
-    def initialize(cmd_tlm_server_config)
-      @config = cmd_tlm_server_config
-    end
-
-    # @param packet_log_writer_name [String] The name of the log writer to
-    #   start or 'ALL' to start all command and telemetry log writers
-    # @param label [String|nil] Label to append to the log file name. See
-    #   {PacketLogWriter#start} for more information.
-    def start(packet_log_writer_name = 'ALL', label = nil)
-      start_cmd(packet_log_writer_name, label)
-      start_tlm(packet_log_writer_name, label)
-    end
-
-    # @param packet_log_writer_name [String] The name of the log writer to
-    #   stop or 'ALL' to stop all command and telemetry log writers
-    def stop(packet_log_writer_name = 'ALL')
-      stop_cmd(packet_log_writer_name)
-      stop_tlm(packet_log_writer_name)
-    end
-
-    # Stop packet logging and kill the logger threads!
-    def shutdown
-      @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
-        packet_log_writer_pair.cmd_log_writer.shutdown
-      end
-      @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
-        packet_log_writer_pair.tlm_log_writer.shutdown
-      end
-    end
-
-    # @param packet_log_writer_name [String] The name of the log writer to
-    #   start or 'ALL' to start all command log writers
-    # @param label [String|nil] Label to append to the log file name. See
-    #   {PacketLogWriter#start} for more information.
-    def start_cmd(packet_log_writer_name = 'ALL', label = nil)
-      if packet_log_writer_name.upcase == 'ALL'
-        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
-          packet_log_writer_pair.cmd_log_writer.start(label)
-        end
-      else
-        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
-        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
-        packet_log_writer_pair.cmd_log_writer.start(label)
-      end
-    end
-
-    # @param packet_log_writer_name [String] The name of the log writer to
-    #   start or 'ALL' to start all telemetry log writers
-    # @param label [String|nil] Label to append to the log file name. See
-    #   {PacketLogWriter#start} for more information.
-    def start_tlm(packet_log_writer_name = 'ALL', label = nil)
-      if packet_log_writer_name.upcase == 'ALL'
-        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
-          packet_log_writer_pair.tlm_log_writer.start(label)
-        end
-      else
-        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
-        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
-        packet_log_writer_pair.tlm_log_writer.start(label)
-      end
-    end
-
-    # @param packet_log_writer_name [String] The name of the log writer to
-    #   stop or 'ALL' to stop all command log writers
-    def stop_cmd(packet_log_writer_name = 'ALL')
-      if packet_log_writer_name.upcase == 'ALL'
-        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
-          packet_log_writer_pair.cmd_log_writer.stop
-        end
-      else
-        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
-        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
-        packet_log_writer_pair.cmd_log_writer.stop
-      end
-    end
-
-    # @param packet_log_writer_name [String] The name of the log writer to
-    #   stop or 'ALL' to stop all telemetry log writers
-    def stop_tlm(packet_log_writer_name = 'ALL')
-      if packet_log_writer_name.upcase == 'ALL'
-        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
-          packet_log_writer_pair.tlm_log_writer.stop
-        end
-      else
-        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
-        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
-        packet_log_writer_pair.tlm_log_writer.stop
-      end
-    end
-
-    # @param packet_log_writer_name [String] The name of the command log writer
-    # @return [String] The command log writer filename
-    def cmd_filename(packet_log_writer_name = 'DEFAULT')
-      packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
-      raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
-      return packet_log_writer_pair.cmd_log_writer.filename
-    end
-
-    # @param packet_log_writer_name [String] The name of the telemetry log writer
-    # @return [String] The telemetry log writer filename
-    def tlm_filename(packet_log_writer_name = 'DEFAULT')
-      packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
-      raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
-      return packet_log_writer_pair.tlm_log_writer.filename
-    end
-
-    # @return [Hash<String, PacketLogWriterPair>] Packet log writer hash. Each
-    #   pair encapsulates a command and telemetry log writer.
-    def all
-      @config.packet_log_writer_pairs
-    end
-
-  end # class PacketLogging
-
-end # module Cosmos
+# 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
+
+module Cosmos
+
+  # Controls the packet loggers which were configured by CmdTlmServerConfig.
+  # This includes starting and stopping both command and telemetry logging.
+  class PacketLogging
+    # @param cmd_tlm_server_config [CmdTlmServerConfig] The configuration which
+    #   defines the packet loggers
+    def initialize(cmd_tlm_server_config)
+      @config = cmd_tlm_server_config
+    end
+
+    # @param packet_log_writer_name [String] The name of the log writer to
+    #   start or 'ALL' to start all command and telemetry log writers
+    # @param label [String|nil] Label to append to the log file name. See
+    #   {PacketLogWriter#start} for more information.
+    def start(packet_log_writer_name = 'ALL', label = nil)
+      start_cmd(packet_log_writer_name, label)
+      start_tlm(packet_log_writer_name, label)
+    end
+
+    # @param packet_log_writer_name [String] The name of the log writer to
+    #   stop or 'ALL' to stop all command and telemetry log writers
+    def stop(packet_log_writer_name = 'ALL')
+      stop_cmd(packet_log_writer_name)
+      stop_tlm(packet_log_writer_name)
+    end
+
+    # Stop packet logging and kill the logger threads!
+    def shutdown
+      @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
+        packet_log_writer_pair.cmd_log_writer.shutdown
+      end
+      @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
+        packet_log_writer_pair.tlm_log_writer.shutdown
+      end
+    end
+
+    # @param packet_log_writer_name [String] The name of the log writer to
+    #   start or 'ALL' to start all command log writers
+    # @param label [String|nil] Label to append to the log file name. See
+    #   {PacketLogWriter#start} for more information.
+    def start_cmd(packet_log_writer_name = 'ALL', label = nil)
+      if packet_log_writer_name.upcase == 'ALL'
+        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
+          packet_log_writer_pair.cmd_log_writer.start(label)
+        end
+      else
+        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
+        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
+        packet_log_writer_pair.cmd_log_writer.start(label)
+      end
+    end
+
+    # @param packet_log_writer_name [String] The name of the log writer to
+    #   start or 'ALL' to start all telemetry log writers
+    # @param label [String|nil] Label to append to the log file name. See
+    #   {PacketLogWriter#start} for more information.
+    def start_tlm(packet_log_writer_name = 'ALL', label = nil)
+      if packet_log_writer_name.upcase == 'ALL'
+        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
+          packet_log_writer_pair.tlm_log_writer.start(label)
+        end
+      else
+        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
+        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
+        packet_log_writer_pair.tlm_log_writer.start(label)
+      end
+    end
+
+    # @param packet_log_writer_name [String] The name of the log writer to
+    #   stop or 'ALL' to stop all command log writers
+    def stop_cmd(packet_log_writer_name = 'ALL')
+      if packet_log_writer_name.upcase == 'ALL'
+        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
+          packet_log_writer_pair.cmd_log_writer.stop
+        end
+      else
+        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
+        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
+        packet_log_writer_pair.cmd_log_writer.stop
+      end
+    end
+
+    # @param packet_log_writer_name [String] The name of the log writer to
+    #   stop or 'ALL' to stop all telemetry log writers
+    def stop_tlm(packet_log_writer_name = 'ALL')
+      if packet_log_writer_name.upcase == 'ALL'
+        @config.packet_log_writer_pairs.each do |name, packet_log_writer_pair|
+          packet_log_writer_pair.tlm_log_writer.stop
+        end
+      else
+        packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
+        raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
+        packet_log_writer_pair.tlm_log_writer.stop
+      end
+    end
+
+    # @param packet_log_writer_name [String] The name of the command log writer
+    # @return [String] The command log writer filename
+    def cmd_filename(packet_log_writer_name = 'DEFAULT')
+      packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
+      raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
+      return packet_log_writer_pair.cmd_log_writer.filename
+    end
+
+    # @param packet_log_writer_name [String] The name of the telemetry log writer
+    # @return [String] The telemetry log writer filename
+    def tlm_filename(packet_log_writer_name = 'DEFAULT')
+      packet_log_writer_pair = @config.packet_log_writer_pairs[packet_log_writer_name.upcase]
+      raise "Unknown packet log writer: #{packet_log_writer_name}" unless packet_log_writer_pair
+      return packet_log_writer_pair.tlm_log_writer.filename
+    end
+
+    # @return [Hash<String, PacketLogWriterPair>] Packet log writer hash. Each
+    #   pair encapsulates a command and telemetry log writer.
+    def all
+      @config.packet_log_writer_pairs
+    end
+
+  end # class PacketLogging
+
+end # module Cosmos