cosmos 3.0.0

data/lib/cosmos/packets/packet_item.rb

@@ -0,0 +1,317 @@
+# 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/packets/structure_item'
+require 'cosmos/packets/packet_item_limits'
+require 'cosmos/conversions/conversion'
+
+module Cosmos
+
+  # Maintains knowledge of an item in a Packet
+  class PacketItem < StructureItem
+    # @return [String] Printf-style string used to format the item
+    attr_reader :format_string
+
+    # Conversion instance used when reading the PacketItem
+    # @return [Conversion] Read conversion
+    attr_reader :read_conversion
+
+    # Conversion instance used when writing the PacketItem
+    # @return [Conversion] Write conversion
+    attr_reader :write_conversion
+
+    # The id_value type depends on the data_type of the PacketItem
+    # @return Value used to identify a packet
+    attr_reader :id_value
+
+    # States are used to convert from a numeric value to a String.
+    # @return [Hash] Item states given as STATE_NAME => VALUE
+    attr_reader :states
+
+    # @return [String] Description of the item
+    attr_reader :description
+
+    # Returns the fully spelled out units of the item. For example,
+    # if the item represents a voltage, this would return "Voltage".
+    # @return [String] Units of the item
+    attr_reader :units_full
+
+    # Returns the abbreviated units of the item. For example,
+    # if the item represents a voltage, this would return "V".
+    # @return [String] Abbreviated units of the item
+    attr_reader :units
+
+    # The default value type depends on the data_type of the PacketItem
+    # @return Default value for this item
+    attr_accessor :default
+
+    # The valid range of values for this item. Returns nil for items with
+    # data_type of :STRING or :BLOCK items.
+    # @return [Range] Valid range of values or nil
+    attr_reader :range
+
+    # @return [Boolean] Whether this item must be specified or can use its
+    # default value. true if it must be specified.
+    attr_accessor :required
+
+    # States that are hazardous for this item as well as their descriptions
+    # @return [Hash] Hazardous states given as STATE_NAME => DESCRIPTION. If no
+    #   description was given the value will be nil.
+    attr_reader :hazardous
+
+    # Colors associated with states
+    # @return [Hash] State colors given as STATE_NAME => COLOR
+    attr_reader :state_colors
+
+    # The allowable state colors
+    STATE_COLORS = [:GREEN, :YELLOW, :RED]
+
+    # @return [PacketItemLimits] All information regarding limits for this PacketItem
+    attr_reader :limits
+
+    # (see StructureItem#initialize)
+    # It also initializes the attributes of the PacketItem.
+    def initialize(name, bit_offset, bit_size, data_type, endianness, array_size = nil, overflow = :ERROR)
+      super(name, bit_offset, bit_size, data_type, endianness, array_size, overflow)
+      @format_string = nil
+      @read_conversion = nil
+      @write_conversion = nil
+      @id_value = nil
+      @states = nil
+      @description = nil
+      @units_full = nil
+      @units = nil
+      @default = nil
+      @range = nil
+      @required = false
+      @hazardous = nil
+      @state_colors = nil
+      @limits = PacketItemLimits.new
+      @persistence_setting = 1
+      @persistence_count = 0
+      @meta = nil
+    end
+
+    def format_string=(format_string)
+      if format_string
+        raise ArgumentError, "#{@name}: format_string must be a String but is a #{format_string.class}" unless String === format_string
+        raise ArgumentError, "#{@name}: format_string invalid '#{format_string}'" unless format_string =~ /%.*(b|B|d|i|o|u|x|X|e|E|f|g|G|a|A|c|p|s|%)/
+        @format_string = format_string.clone.freeze
+      else
+        @format_string = nil
+      end
+    end
+
+    def read_conversion=(read_conversion)
+      if read_conversion
+        raise ArgumentError, "#{@name}: read_conversion must be a Cosmos::Conversion but is a #{read_conversion.class}" unless Cosmos::Conversion === read_conversion
+        @read_conversion = read_conversion.clone
+      else
+        @read_conversion = nil
+      end
+    end
+
+    def write_conversion=(write_conversion)
+      if write_conversion
+        raise ArgumentError, "#{@name}: write_conversion must be a Cosmos::Conversion but is a #{write_conversion.class}" unless Cosmos::Conversion === write_conversion
+        @write_conversion = write_conversion.clone
+      else
+        @write_conversion = nil
+      end
+    end
+
+    def id_value=(id_value)
+      if id_value
+        @id_value = convert(id_value, @data_type)
+      else
+        @id_value = nil
+      end
+    end
+
+    # Assignment operator for states to make sure it is a Hash with uppercase keys
+    def states=(states)
+      if states
+        raise ArgumentError, "#{@name}: states must be a Hash but is a #{states.class}" unless Hash === states
+
+        # Make sure all states are in upper case
+        upcase_states = {}
+        states.each do |key, value|
+          upcase_states[key.to_s.upcase] = value
+        end
+
+        @states = upcase_states
+        @state_colors ||= {}
+      else
+        @states = nil
+      end
+    end
+
+    def description=(description)
+      if description
+        raise ArgumentError, "#{@name}: description must be a String but is a #{description.class}" unless String === description
+        @description = description.clone.freeze
+      else
+        @description = nil
+      end
+    end
+
+    def units_full=(units_full)
+      if units_full
+        raise ArgumentError, "#{@name}: units_full must be a String but is a #{units_full.class}" unless String === units_full
+        @units_full = units_full.clone.freeze
+      else
+        @units_full = nil
+      end
+    end
+
+    def units=(units)
+      if units
+        raise ArgumentError, "#{@name}: units must be a String but is a #{units.class}" unless String === units
+        @units = units.clone.freeze
+      else
+        @units = nil
+      end
+    end
+
+    def check_default_and_range_data_types
+      if @default and !@write_conversion
+        if @array_size
+          raise ArgumentError, "#{@name}: default must be an Array but is a #{default.class}" unless Array === @default
+        else
+          case data_type
+          when :INT, :UINT
+            raise ArgumentError, "#{@name}: default must be a Integer but is a #{@default.class}" unless Integer === @default
+            if @range
+              raise ArgumentError, "#{@name}: minimum must be a Integer but is a #{@range.first.class}" unless Integer === @range.first
+              raise ArgumentError, "#{@name}: maximum must be a Integer but is a #{@range.last.class}" unless Integer === @range.last
+            end
+          when :FLOAT
+            raise ArgumentError, "#{@name}: default must be a Float but is a #{@default.class}" unless Float === @default or Integer === @default
+            @default = @default.to_f
+            if @range
+              raise ArgumentError, "#{@name}: minimum must be a Float but is a #{@range.first.class}" unless Float === @range.first or Integer === @range.first
+              raise ArgumentError, "#{@name}: maximum must be a Float but is a #{@range.last.class}" unless Float === @range.last or Integer === @range.last
+              @range = ((@range.first.to_f)..(@range.last.to_f))
+            end
+          when :BLOCK, :STRING
+            raise ArgumentError, "#{@name}: default must be a String but is a #{@default.class}" unless String === @default
+            @default = @default.clone.freeze
+          end
+        end
+      end
+    end
+
+    def range=(range)
+      if range
+        raise ArgumentError, "#{@name}: range must be a Range but is a #{range.class}" unless Range === range
+        @range = range.clone.freeze
+      else
+        @range = nil
+      end
+    end
+
+    def hazardous=(hazardous)
+      if hazardous
+        raise ArgumentError, "#{@name}: hazardous must be a Hash but is a #{hazardous.class}" unless Hash === hazardous
+        @hazardous = hazardous.clone
+      else
+        @hazardous = nil
+      end
+    end
+
+    def state_colors=(state_colors)
+      if state_colors
+        raise ArgumentError, "#{@name}: state_colors must be a Hash but is a #{state_colors.class}" unless Hash === state_colors
+        @state_colors = state_colors.clone
+      else
+        @state_colors = nil
+      end
+    end
+
+    def limits=(limits)
+      if limits
+        raise ArgumentError, "#{@name}: limits must be a PacketItemLimits but is a #{limits.class}" unless PacketItemLimits === limits
+        @limits = limits.clone
+      else
+        @limits = nil
+      end
+    end
+
+    def meta
+      @meta ||= {}
+    end
+
+    # Make a light weight clone of this item
+    def clone
+      item = super()
+      item.format_string = self.format_string.clone if self.format_string
+      item.read_conversion = self.read_conversion.clone if self.read_conversion
+      item.write_conversion = self.write_conversion.clone if self.write_conversion
+      item.states = self.states.clone if self.states
+      item.description = self.description.clone if self.description
+      item.units_full = self.units_full.clone if self.units_full
+      item.units = self.units.clone if self.units
+      item.default = self.default.clone if self.default and String === self.default
+      item.hazardous = self.hazardous.clone if self.hazardous
+      item.state_colors = self.state_colors.clone if self.state_colors
+      item.limits = self.limits.clone if self.limits
+      item.meta = self.meta.clone if @meta
+      item
+    end
+    alias dup clone
+
+    def to_hash
+      hash = super()
+      hash['format_string'] = self.format_string
+      if self.read_conversion
+        hash['read_conversion'] = self.read_conversion.to_s
+      else
+        hash['read_conversion'] = nil
+      end
+      if self.write_conversion
+        hash['write_conversion'] = self.write_conversion.to_s
+      else
+        hash['write_conversion'] = nil
+      end
+      hash['id_value'] = self.id_value
+      hash['states'] = self.states
+      hash['description'] = self.description
+      hash['units_full'] = self.units_full
+      hash['units'] = self.units
+      hash['default'] = self.default
+      hash['range'] = self.range
+      hash['required'] = self.required
+      hash['hazardous'] = self.hazardous
+      hash['state_colors'] = self.state_colors
+      hash['limits'] = self.limits.to_hash
+      hash['meta'] = nil
+      hash['meta'] = @meta if @meta
+      hash
+    end
+
+    protected
+
+    # Convert a value into the given data type
+    def convert(value, data_type)
+      case data_type
+      when :INT, :UINT
+        Integer(value)
+      when :FLOAT
+        Float(value)
+      when :STRING, :BLOCK
+        value.to_s.freeze
+      end
+    rescue
+      raise ArgumentError, "#{@name}: Invalid value: #{value} for data type: #{data_type}"
+    end
+
+  end # class PacketItem
+
+end # module Cosmos

data/lib/cosmos/packets/packet_item_limits.rb

@@ -0,0 +1,128 @@
+# 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/packets/limits_response'
+
+module Cosmos
+
+  # Maintains knowledge of limits for a PacketItem
+  class PacketItemLimits
+    # Array of all limit states
+    LIMITS_STATES = [:RED, :RED_HIGH, :RED_LOW, :YELLOW, :YELLOW_HIGH, :YELLOW_LOW, :GREEN, :GREEN_HIGH, :GREEN_LOW, :BLUE, :STALE, nil]
+    # Array of all limit states which should be considered in error
+    OUT_OF_LIMITS_STATES = [:RED, :RED_HIGH, :RED_LOW, :YELLOW, :YELLOW_HIGH, :YELLOW_LOW]
+
+    # Hash of arrays - Hash key is uppercase symbol designating limits set.
+    # :DEFAULT limits set is required if item has limits. nil indicates the
+    # item does not have limits. For defined limits, each array in the hash
+    # contains [:RED_LOW, :YELLOW_LOW, :YELLOW_HIGH, :RED_HIGH,
+    # :GREEN_LOW (optional), GREEN_HIGH (optional)].
+    # @return [Hash{Symbol=>Array}] Hash of all the limits defined for this
+    #   item. Must include a hash key of :DEFAULT which returns the default
+    #   limits.
+    attr_reader :values
+
+    # Every item effectively always has "limits" enabled because it can go from
+    # :STALE to nil as needed. This flag indicates whether an item with defined
+    # limit values can transition from nil to the various other states.
+    #
+    # @return [Boolean] Whether limits are enabled on this item
+    attr_accessor :enabled
+
+    # Current limits state of the item. One of nil, :STALE, :BLUE, :GREEN,
+    # :GREEN_HIGH, :GREEN_LOW, :YELLOW, :YELLOW_HIGH, :YELLOW_LOW,
+    # :RED, :RED_HIGH, :RED_LOW. Items initialize to :STALE and change states
+    # as the item value changes. If the limits are disabled the state changes
+    # to nil. If a packet becomes stale the items state changes to :STALE.
+    # @return [Symbol, nil] Current limits state of the item
+    attr_reader :state
+
+    # @return [LimitsResponse] Response method to be called on limits changes
+    attr_reader :response
+
+    # @return [Integer] Number of out of limits samples at which the limits
+    #   state will change
+    attr_reader :persistence_setting
+
+    # Current persistent count. The count will be reset to zero if the limits
+    # state hasn't changed (i.e. remained :GREEN).
+    # @return [Integer] Current running persistence count
+    attr_reader :persistence_count
+
+    # Create a PacketItemLimits
+    def initialize
+      @values = nil
+      @enabled = false
+      @state = :STALE
+      @response = nil
+      @persistence_setting = 1
+      @persistence_count = 0
+    end
+
+    def values=(values)
+      if values
+        raise ArgumentError, "values must be a Hash but is a #{values.class}" unless Hash === values
+        raise ArgumentError, "values must be a Hash with a :DEFAULT key" unless values.keys.include?(:DEFAULT)
+        @values = values.clone
+      else
+        @values = nil
+      end
+    end
+
+    def state=(state)
+      raise ArgumentError, "state must be one of #{LIMITS_STATES} but is #{state}" unless LIMITS_STATES.include?(state)
+      @state = state
+    end
+
+    def response=(response)
+      if response
+        raise ArgumentError, "response must be a Cosmos::LimitsResponse but is a #{response.class}" unless Cosmos::LimitsResponse === response
+        @response = response.clone
+      else
+        @response = nil
+      end
+    end
+
+    def persistence_setting=(persistence_setting)
+      raise ArgumentError, "persistence_setting must be a Fixnum but is a #{persistence_setting.class}" unless Fixnum === persistence_setting
+      @persistence_setting = persistence_setting
+    end
+
+    def persistence_count=(persistence_count)
+      raise ArgumentError, "persistence_count must be a Fixnum but is a #{persistence_count.class}" unless Fixnum === persistence_count
+      @persistence_count = persistence_count
+    end
+
+    # Make a light weight clone of this limits
+    def clone
+      limits = super()
+      limits.values = self.values.clone if self.values
+      limits.response = self.response.clone if self.response
+      limits
+    end
+    alias dup clone
+
+    def to_hash
+      hash = {}
+      hash['values'] = self.values
+      hash['enabled'] = self.enabled
+      hash['state'] = self.state
+      if self.response
+        hash['response'] = self.response.to_s
+      else
+        hash['response'] = nil
+      end
+      hash['persistence_setting'] = self.persistence_setting
+      hash['persistence_count'] = self.persistence_count
+      hash
+    end
+
+  end
+end # module Cosmos