openc3 5.18.0 → 5.19.0

data/lib/openc3/models/widget_model.rb

@@ -73,9 +73,11 @@ module OpenC3
     def self.handle_config(parser, keyword, parameters, plugin: nil, needs_dependencies: false, scope:)
       case keyword
       when 'WIDGET'
-        parser.verify_num_parameters(1, 2, "WIDGET <Name> <Label>")
+        parser.verify_num_parameters(1, 3, "WIDGET <Name> <Label> <Select Items (true/false)>")
         # Label is optional and if it doesn't exist nil is fine
-        return self.new(name: parameters[0], plugin: plugin, label: parameters[1], needs_dependencies: needs_dependencies, scope: scope)
+        # Select Items is optional and if it doesn't exist nil is fine
+        items = ConfigParser.handle_true_false_nil(parameters[2])
+        return self.new(name: parameters[0], plugin: plugin, label: parameters[1], items: items, needs_dependencies: needs_dependencies, scope: scope)
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Widget: #{keyword} #{parameters.join(" ")}")
       end
@@ -87,6 +89,7 @@ module OpenC3
       updated_at: nil,
       plugin: nil,
       label: nil,
+      items: false,
       needs_dependencies: false,
       disable_erb: nil,
       scope:
@@ -96,6 +99,8 @@ module OpenC3
       @filename = @full_name + '.umd.min.js'
       @bucket_key = 'widgets/' + @full_name + '/' + @filename
       @label = label
+      # Ensure items is a boolean because it could be nil
+      @items = items ? true : false
       @needs_dependencies = needs_dependencies
       @disable_erb = disable_erb
     end
@@ -106,8 +111,9 @@ module OpenC3
         'updated_at' => @updated_at,
         'plugin' => @plugin,
         'label' => @label,
+        'items' => @items,
         'needs_dependencies' => @needs_dependencies,
-        'disable_erb' => @disable_erb
+        'disable_erb' => @disable_erb,
       }
     end
 
@@ -155,8 +161,8 @@ module OpenC3
       bucket = Bucket.getClient()
       bucket.delete_object(bucket: ENV['OPENC3_TOOLS_BUCKET'], key: @bucket_key)
       bucket.delete_object(bucket: ENV['OPENC3_TOOLS_BUCKET'], key: @bucket_key + '.map')
-    rescue Exception => error
-      Logger.error("Error undeploying widget model #{@name} in scope #{@scope} due to #{error}")
+    rescue Exception => e
+      Logger.error("Error undeploying widget model #{@name} in scope #{@scope} due to #{e}")
     end
   end
 end

data/lib/openc3/operators/operator.rb

@@ -105,7 +105,7 @@ module OpenC3
     def cmd_line
       # In ProcessManager processes, the process_definition is the actual thing run
       # e.g. OpenC3::ProcessManager.instance.spawn(["ruby", "/openc3/bin/openc3cli", "load", ...])
-      # However, if the MicroserviceOperator is spawning the proceses it sets
+      # However, if the MicroserviceOperator is spawning the processes it sets
       # process_definition = ["ruby", "plugin_microservice.rb"]
       # which then calls exec(*@config["cmd"]) to actually run
       # So check if the @config['cmd'] is defined to give the user more info in the log
@@ -195,12 +195,14 @@ module OpenC3
       if @process
         stdout = @process.io.stdout.extract
         if stdout.length > 0
-          STDOUT.puts "STDOUT #{stdout.length} bytes from #{cmd_line()}:"
+          message = "STDOUT #{stdout.length} bytes from #{cmd_line()}:"
+          STDOUT.puts Logger.build_log_data(Logger::INFO_LEVEL, message, user: nil, type: OpenC3::Logger::LOG, url: nil).as_json(:allow_nan => true).to_json(:allow_nan => true)
           STDOUT.puts stdout
         end
         stderr = @process.io.stderr.extract
         if stderr.length > 0
-          STDERR.puts "STDERR #{stderr.length} bytes from #{cmd_line()}:"
+          message = "STDERR #{stderr.length} bytes from #{cmd_line()}:"
+          STDERR.puts Logger.build_log_data(Logger::ERROR_LEVEL, message, user: nil, type: OpenC3::Logger::LOG, url: nil).as_json(:allow_nan => true).to_json(:allow_nan => true)
           STDERR.puts stderr
         end
       end

data/lib/openc3/packets/command_validator.rb

@@ -0,0 +1,48 @@
+# encoding: ascii-8bit
+
+# Copyright 2024 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+# This file implements a class to handle command validation
+
+require 'openc3/api/api'
+
+module OpenC3
+  # This class defines methods which are called when a command is sent.
+  # This class must be subclassed and the pre_check or
+  # post_check methods implemented. Do NOT use this class directly.
+  class CommandValidator
+    attr_reader :args
+    include Api
+
+    def initialize(command = nil)
+      @command = command
+      @args = []
+    end
+
+    def pre_check(command)
+      # Return true to indicate Success, false to indicate Failure,
+      # and nil to indicate Unknown. The second value is the optional message.
+      return [true, nil]
+    end
+
+    def post_check(command)
+      # Return true to indicate Success, false to indicate Failure,
+      # and nil to indicate Unknown. The second value is the optional message.
+      return [true, nil]
+    end
+  end
+end

data/lib/openc3/packets/commands.rb

@@ -30,7 +30,7 @@ module OpenC3
   #
   # This should not be confused with the Api module which implements the JSON
   # API that is used by tools when accessing the Server. The Api module always
-  # provides Ruby primatives where the PacketConfig class can return actual
+  # provides Ruby primitives where the PacketConfig class can return actual
   # Packet or PacketItem objects. While there are some overlapping methods between
   # the two, these are separate interfaces into the system.
   class Commands
@@ -115,7 +115,7 @@ module OpenC3
         target = System.targets[target_name]
         if target and target.cmd_unique_id_mode
           # Iterate through the packets and see if any represent the buffer
-          target_packets.each do |packet_name, packet|
+          target_packets.each do |_packet_name, packet|
             if packet.identify?(packet_data)
               identified_packet = packet
               break
@@ -147,7 +147,7 @@ module OpenC3
     end
 
     # Returns a copy of the specified command packet with the parameters
-    # initialzed to the given params values.
+    # initialized to the given params values.
     #
     # @param target_name (see #packet)
     # @param packet_name (see #packet)
@@ -195,7 +195,7 @@ module OpenC3
         items = packet.read_all(:FORMATTED)
         raw = false
       end
-      items.delete_if { |item_name, item_value| ignored_parameters.include?(item_name) }
+      items.delete_if { |item_name, _item_value| ignored_parameters.include?(item_name) }
       return build_cmd_output_string(packet.target_name, packet.packet_name, items, raw)
     end
 
@@ -207,7 +207,7 @@ module OpenC3
       end
       target_name = 'UNKNOWN' unless target_name
       cmd_name = 'UNKNOWN' unless cmd_name
-      output_string << target_name + ' ' + cmd_name
+      output_string << (target_name + ' ' + cmd_name)
       if cmd_params.nil? or cmd_params.empty?
         output_string << '")'
       else
@@ -247,7 +247,7 @@ module OpenC3
           params << "#{key} #{value}"
         end
         params = params.join(", ")
-        output_string << ' with ' + params + '")'
+        output_string << (' with ' + params + '")')
       end
       return output_string
     end
@@ -291,14 +291,6 @@ module OpenC3
       cmd_pkt_hazardous?(build_cmd(target_name, packet_name, params, false, false, false))
     end
 
-    def clear_counters
-      @config.commands.each do |target_name, target_packets|
-        target_packets.each do |packet_name, packet|
-          packet.received_count = 0
-        end
-      end
-    end
-
     def all
       @config.commands
     end

data/lib/openc3/packets/packet.rb

@@ -104,6 +104,9 @@ module OpenC3
     # @return [Boolean] Whether to ignore overlapping items
     attr_accessor :ignore_overlap
 
+    # @return [Validator] Instance of class used to validate commands
+    attr_accessor :validator
+
     # @return [Boolean] If this packet should be used for identification
     attr_reader :virtual
 
@@ -111,7 +114,7 @@ module OpenC3
     VALUE_TYPES = [:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
 
     if RUBY_ENGINE != 'ruby' or ENV['OPENC3_NO_EXT']
-      # Creates a new packet by initalizing the attributes.
+      # Creates a new packet by initializing the attributes.
       #
       # @param target_name [String] Name of the target this packet is associated with
       # @param packet_name [String] Name of the packet
@@ -122,7 +125,7 @@ module OpenC3
       #   subclass of PacketItem)
       def initialize(target_name = nil, packet_name = nil, default_endianness = :BIG_ENDIAN, description = nil, buffer = nil, item_class = PacketItem)
         super(default_endianness, buffer, item_class)
-        # Explictly call the defined setter methods
+        # Explicitly call the defined setter methods
         self.target_name = target_name
         self.packet_name = packet_name
         self.description = description
@@ -148,6 +151,7 @@ module OpenC3
         @packet_time = nil
         @ignore_overlap = false
         @virtual = false
+        @validator = nil
       end
 
       # Sets the target name this packet is associated with. Unidentified packets
@@ -325,7 +329,7 @@ module OpenC3
       synchronize() do
         begin
           internal_buffer_equals(buffer)
-        rescue RuntimeError
+        rescue RuntimeError => e
           Logger.instance.error "#{@target_name} #{@packet_name} received with actual packet length of #{buffer.length} but defined length of #{@defined_length}"
         end
         @read_conversion_cache.clear if @read_conversion_cache
@@ -511,20 +515,20 @@ module OpenC3
 
     # Define an item in the packet. This creates a new instance of the
     # item_class as given in the constructor and adds it to the items hash. It
-    # also resizes the buffer to accomodate the new item.
+    # also resizes the buffer to accommodate the new item.
     #
     # @param name [String] Name of the item. Used by the items hash to retrieve
     #   the item.
     # @param bit_offset [Integer] Bit offset of the item in the raw buffer
     # @param bit_size [Integer] Bit size of the item in the raw buffer
     # @param data_type [Symbol] Type of data contained by the item. This is
-    #   dependant on the item_class but by default see StructureItem.
+    #   dependent on the item_class but by default see StructureItem.
     # @param array_size [Integer] Set to a non nil value if the item is to
     #   represented as an array.
     # @param endianness [Symbol] Endianness of this item. By default the
-    #   endianness as set in the constructure is used.
+    #   endianness as set in the constructor is used.
     # @param overflow [Symbol] How to handle value overflows. This is
-    #   dependant on the item_class but by default see StructureItem.
+    #   dependent on the item_class but by default see StructureItem.
     # @param format_string [String] String to pass to Kernel#sprintf
     # @param read_conversion [Conversion] Conversion to apply when reading the
     #   item from the packet buffer
@@ -540,7 +544,7 @@ module OpenC3
     end
 
     # Add an item to the packet by adding it to the items hash. It also
-    # resizes the buffer to accomodate the new item.
+    # resizes the buffer to accommodate the new item.
     #
     # @param item [PacketItem] Item to add to the packet
     # @return [PacketItem] The same packet item
@@ -553,7 +557,7 @@ module OpenC3
 
     # Define an item at the end of the packet. This creates a new instance of the
     # item_class as given in the constructor and adds it to the items hash. It
-    # also resizes the buffer to accomodate the new item.
+    # also resizes the buffer to accommodate the new item.
     #
     # @param name (see #define_item)
     # @param bit_size (see #define_item)
@@ -1064,9 +1068,12 @@ module OpenC3
       if @accessor.class.to_s != 'OpenC3::BinaryAccessor'
         config << "  ACCESSOR #{@accessor.class} #{@accessor.args.map { |a| a.to_s.quote_if_necessary }.join(" ")}\n"
       end
+      if @validator
+        config << "  VALIDATOR #{@validator.class} #{@validator.args.map { |a| a.to_s.quote_if_necessary }.join(" ")}\n"
+      end
       # TODO: Add TEMPLATE_ENCODED so this can always be done inline regardless of content
       if @template
-        config << "  TEMPLATE '#{@template}'"
+        config << "  TEMPLATE '#{@template}'\n"
       end
       config << "  ALLOW_SHORT\n" if @short_buffer_allowed
       config << "  HAZARDOUS #{@hazardous_description.to_s.quote_if_necessary}\n" if @hazardous
@@ -1106,21 +1113,21 @@ module OpenC3
       end
 
       if @response
-        config << "  RESPONSE #{@response[0].to_s.quote_if_necessary} #{@response[1].to_s.quote_if_necessary}"
+        config << "  RESPONSE #{@response[0].to_s.quote_if_necessary} #{@response[1].to_s.quote_if_necessary}\n"
       end
       if @error_response
-        config << "  ERROR_RESPONSE #{@error_response[0].to_s.quote_if_necessary} #{@error_response[1].to_s.quote_if_necessary}"
+        config << "  ERROR_RESPONSE #{@error_response[0].to_s.quote_if_necessary} #{@error_response[1].to_s.quote_if_necessary}\n"
       end
       if @screen
-        config << "  SCREEN #{@screen[0].to_s.quote_if_necessary} #{@screen[1].to_s.quote_if_necessary}"
+        config << "  SCREEN #{@screen[0].to_s.quote_if_necessary} #{@screen[1].to_s.quote_if_necessary}\n"
       end
       if @related_items
         @related_items.each do |target_name, packet_name, item_name|
-          config << "  RELATED_ITEM #{target_name.to_s.quote_if_necessary} #{packet_name.to_s.quote_if_necessary} #{item_name.to_s.quote_if_necessary}"
+          config << "  RELATED_ITEM #{target_name.to_s.quote_if_necessary} #{packet_name.to_s.quote_if_necessary} #{item_name.to_s.quote_if_necessary}\n"
         end
       end
       if @ignore_overlap
-        config << "  IGNORE_OVERLAP"
+        config << "  IGNORE_OVERLAP\n"
       end
       config
     end
@@ -1140,6 +1147,7 @@ module OpenC3
       config['virtual'] = true if @virtual
       config['accessor'] = @accessor.class.to_s
       config['accessor_args'] = @accessor.args
+      config['validator'] = @validator.class.to_s if @validator
       config['template'] = Base64.encode64(@template) if @template
       config['config_name'] = self.config_name
 
@@ -1205,6 +1213,14 @@ module OpenC3
           Logger.instance.error "#{packet.target_name} #{packet.packet_name} accessor of #{hash['accessor']} could not be found due to #{e}"
         end
       end
+      if hash['validator']
+        begin
+          validator = OpenC3::const_get(hash['validator'])
+          packet.validator = validator.new(packet)
+        rescue => e
+          Logger.instance.error "#{packet.target_name} #{packet.packet_name} validator of #{hash['validator']} could not be found due to #{e}"
+        end
+      end
       packet.template = Base64.decode64(hash['template']) if hash['template']
       packet.meta = hash['meta']
       # Can't convert processors

data/lib/openc3/packets/packet_config.rb

@@ -220,7 +220,7 @@ module OpenC3
               'APPEND_PARAMETER', 'APPEND_ID_ITEM', 'APPEND_ID_PARAMETER', 'APPEND_ARRAY_ITEM',\
               'APPEND_ARRAY_PARAMETER', 'ALLOW_SHORT', 'HAZARDOUS', 'PROCESSOR', 'META',\
               'DISABLE_MESSAGES', 'HIDDEN', 'DISABLED', 'VIRTUAL', 'ACCESSOR', 'TEMPLATE', 'TEMPLATE_FILE',\
-              'RESPONSE', 'ERROR_RESPONSE', 'SCREEN', 'RELATED_ITEM', 'IGNORE_OVERLAP'
+              'RESPONSE', 'ERROR_RESPONSE', 'SCREEN', 'RELATED_ITEM', 'IGNORE_OVERLAP', 'VALIDATOR'
             raise parser.error("No current packet for #{keyword}") unless @current_packet
 
             process_current_packet(parser, keyword, params)
@@ -409,7 +409,7 @@ module OpenC3
           else # DELETE
             @current_packet.delete_item(params[0])
           end
-        rescue # Rescue the default execption to provide a nicer error message
+        rescue # Rescue the default exception to provide a nicer error message
           raise parser.error("#{params[0]} not found in #{@current_cmd_or_tlm.downcase} packet #{@current_packet.target_name} #{@current_packet.packet_name}", usage)
         end
 
@@ -480,22 +480,23 @@ module OpenC3
         @current_packet.disabled = true
         @current_packet.virtual = true
 
-      when 'ACCESSOR'
-        usage = "#{keyword} <Accessor class name>"
+      when 'ACCESSOR', 'VALIDATOR'
+        usage = "#{keyword} <Class name> <Optional parameters> ..."
         parser.verify_num_parameters(1, nil, usage)
         begin
+          keyword_equals = "#{keyword.downcase}=".to_sym
           if @language == 'ruby'
             klass = OpenC3.require_class(params[0])
             if params.length > 1
-              @current_packet.accessor = klass.new(@current_packet, *params[1..-1])
+              @current_packet.public_send(keyword_equals, klass.new(@current_packet, *params[1..-1]))
             else
-              @current_packet.accessor = klass.new(@current_packet)
+              @current_packet.public_send(keyword_equals, klass.new(@current_packet))
             end
           else
             if params.length > 1
-              @current_packet.accessor = PythonProxy.new('Accessor', params[0], @current_packet, *params[1..-1])
+              @current_packet.public_send(keyword_equals, PythonProxy.new(keyword.capitalize, params[0], @current_packet, *params[1..-1]))
             else
-              @current_packet.accessor = PythonProxy.new('Accessor', params[0], @current_packet)
+              @current_packet.public_send(keyword_equals, PythonProxy.new(keyword.capitalize, params[0], @current_packet))
             end
           end
         rescue Exception => e
@@ -675,7 +676,7 @@ module OpenC3
           raise parser.error("#{keyword} only applies to command parameters")
         end
 
-      # Update the mimimum value for the current command parameter
+      # Update the minimum value for the current command parameter
       when 'MINIMUM_VALUE'
         if @current_cmd_or_tlm == TELEMETRY
           raise parser.error("#{keyword} only applies to command parameters")

data/lib/openc3/packets/parsers/packet_parser.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/packets/packet'
@@ -30,7 +30,7 @@ module OpenC3
     #   used instead of this parameter.
     # @param commands [Hash] Hash of the currently defined commands
     # @param warnings [Array<String>] Any warning strings generated while
-    #   parsing this command will be appened to this array
+    #   parsing this command will be appended to this array
     def self.parse_command(parser, target_name, commands, warnings)
       parser = PacketParser.new(parser)
       parser.verify_parameters()
@@ -48,7 +48,7 @@ module OpenC3
     #   used to perform lookups when the packet and item are known but the
     #   packet is not.
     # @param warnings [Array<String>] Any warning strings generated while
-    #   parsing this command will be appened to this array
+    #   parsing this command will be appended to this array
     def self.parse_telemetry(parser, target_name, telemetry, latest_data, warnings)
       parser = PacketParser.new(parser)
       parser.verify_parameters()

data/lib/openc3/packets/structure.rb

@@ -188,21 +188,21 @@ module OpenC3
 
     # Define an item in the structure. This creates a new instance of the
     # item_class as given in the constructor and adds it to the items hash. It
-    # also resizes the buffer to accomodate the new item.
+    # also resizes the buffer to accommodate the new item.
     #
     # @param name [String] Name of the item. Used by the items hash to retrieve
     #   the item.
     # @param bit_offset [Integer] Bit offset of the item in the raw buffer
     # @param bit_size [Integer] Bit size of the item in the raw buffer
     # @param data_type [Symbol] Type of data contained by the item. This is
-    #   dependant on the item_class but by default see StructureItem.
+    #   dependent on the item_class but by default see StructureItem.
     # @param array_size [Integer] Set to a non nil value if the item is to
     #   represented as an array.
     # @param endianness [Symbol] Endianness of this item. By default the
-    #   endianness as set in the constructure is used.
+    #   endianness as set in the constructor is used.
     # @param overflow [Symbol] How to handle value overflows. This is
-    #   dependant on the item_class but by default see StructureItem.
-    # @return [StrutureItem] The struture item defined
+    #   dependent on the item_class but by default see StructureItem.
+    # @return [StrutureItem] The structure item defined
     def define_item(name, bit_offset, bit_size, data_type, array_size = nil, endianness = @default_endianness, overflow = :ERROR)
       # Create the item
       item = @item_class.new(name, bit_offset, bit_size, data_type, endianness, array_size, overflow)
@@ -210,10 +210,10 @@ module OpenC3
     end
 
     # Adds the given item to the items hash. It also resizes the buffer to
-    # accomodate the new item.
+    # accommodate the new item.
     #
     # @param item [StructureItem] The structure item to add
-    # @return [StrutureItem] The struture item defined
+    # @return [StrutureItem] The structure item defined
     def define(item)
       # Handle Overwriting Existing Item
       if @items[item.name]
@@ -289,7 +289,7 @@ module OpenC3
 
     # Define an item at the end of the structure. This creates a new instance of the
     # item_class as given in the constructor and adds it to the items hash. It
-    # also resizes the buffer to accomodate the new item.
+    # also resizes the buffer to accommodate the new item.
     #
     # @param name (see #define_item)
     # @param bit_size (see #define_item)
@@ -307,7 +307,7 @@ module OpenC3
     end
 
     # Adds an item at the end of the structure. It adds the item to the items
-    # hash and resizes the buffer to accomodate the new item.
+    # hash and resizes the buffer to accommodate the new item.
     #
     # @param item (see #define)
     # @return (see #define)
@@ -493,7 +493,7 @@ module OpenC3
     # further modifications to the buffer have no effect on the structure
     # items.
     #
-    # @param buffer [String] Buffer of data to back the stucture items
+    # @param buffer [String] Buffer of data to back the structure items
     def buffer=(buffer)
       synchronize() do
         internal_buffer_equals(buffer)
@@ -507,8 +507,8 @@ module OpenC3
     #   buffer of data
     def clone
       structure = super()
-      # Use instance_variable_set since we have overriden buffer= to do
-      # additional work that isn't neccessary here
+      # Use instance_variable_set since we have overridden buffer= to do
+      # additional work that isn't necessary here
       structure.instance_variable_set("@buffer".freeze, @buffer.clone) if @buffer
       # Need to update reference packet in the Accessor
       structure.accessor.packet = structure
@@ -617,9 +617,17 @@ module OpenC3
         # Anything with a negative bit offset should be left alone
         if item.original_bit_offset >= 0
           item.bit_offset = item.original_bit_offset + adjustment
-          if item.data_type != :DERIVED and (item.variable_bit_size or item.original_bit_size <= 0 or (item.original_array_size and item.original_array_size <= 0))
+
+          # May need to update adjustment with variable length items
+          # Note legacy variable length does not push anything
+          if item.data_type != :DERIVED and item.variable_bit_size # Not DERIVED and New Variable Length
+            # Calculate the actual current size of this variable length item
             new_bit_size = calculate_total_bit_size(item)
+
             if item.original_bit_size != new_bit_size
+              # Bit size has changed from original - so we need to adjust everything after this item
+              # This includes items that may have the same bit_offset as the variable length item because it
+              # started out at zero bit_size
               adjustment += (new_bit_size - item.original_bit_size)
             end
           end

data/lib/openc3/packets/structure_item.rb

@@ -95,6 +95,9 @@ module OpenC3
     # @return [Hash] Variable bit size information
     attr_reader :variable_bit_size
 
+    # @return [Integer] Incrementing value that shows relative order items are created
+    attr_reader :create_index
+
     # Create a StructureItem by setting all the attributes. It
     # calls all the setter routines to do the attribute verification and then
     # verifies the overall integrity.
@@ -238,73 +241,56 @@ module OpenC3
       verify_overall() if @structure_item_constructed
     end
 
-    def create_index
-      @create_index.to_i
-    end
-
     if RUBY_ENGINE != 'ruby' or ENV['OPENC3_NO_EXT']
-      # Comparison Operator based on bit_offset. This means that StructureItems
-      # with different names or bit sizes are equal if they have the same bit
-      # offset.
+      # Comparison Operator primarily based on bit_offset
       def <=>(other)
         return nil unless other.kind_of?(StructureItem)
 
-        other_bit_offset = other.bit_offset
-        other_bit_size = other.bit_size
-
-        # Handle same bit offset case
-        if (@bit_offset == 0) && (other_bit_offset == 0)
-          # Both bit_offsets are 0 so sort by bit_size
-          # This allows derived items with bit_size of 0 to be listed first
-          # Compare based on bit size then create index
-          if @bit_size == other_bit_size
-            if @create_index
-              if @create_index <= other.create_index
-                return -1
-              else
-                return 1
-              end
-            else
-              return 0
-            end
-          elsif @bit_size < other_bit_size
+        other_original_bit_offset = other.original_bit_offset
+
+        # Derived items should be first in the list with multiple derived sorted
+        # by create_index
+        if @data_type == :DERIVED
+          if other.data_type != :DERIVED
             return -1
           else
-            return 1
+            if @create_index <= other.create_index
+              return -1
+            else
+              return 1
+            end
           end
+        elsif other.data_type == :DERIVED
+          return 1
         end
 
-        # Handle different bit offsets
-        if ((@bit_offset >= 0) && (other_bit_offset >= 0)) || ((@bit_offset < 0) && (other_bit_offset < 0))
+        # Handle non-derived items
+        if ((@original_bit_offset >= 0) && (other_original_bit_offset >= 0)) || ((@original_bit_offset < 0) && (other_original_bit_offset < 0))
           # Both Have Same Sign
-          if @bit_offset == other_bit_offset
-            if @create_index
-              if @create_index <= other.create_index
+          if @original_bit_offset == other_original_bit_offset
+            # New Variable Bit Size items are before regular items
+            if @variable_bit_size
+              if not other.variable_bit_size
                 return -1
-              else
-                return 1
               end
+              # If both variable_bit_size use create index
+            elsif other.variable_bit_size
+              return 1
+            end
+
+            if @create_index <= other.create_index
+              return -1
             else
-              return 0
+              return 1
             end
-          elsif @bit_offset <= other_bit_offset
+          elsif @original_bit_offset <= other_original_bit_offset
             return -1
           else
             return 1
           end
         else
           # Different Signs
-          if @bit_offset == other_bit_offset
-            if @create_index
-              if @create_index < other.create_index
-                return -1
-              else
-                return 1
-              end
-            else
-              return 0
-            end
-          elsif @bit_offset < other_bit_offset
+          if @original_bit_offset < other_original_bit_offset
             return 1
           else
             return -1