Sha256: 18fc450a60489e30f4a49a663c7a01dc9d5ecbb6e30b69e2e6c896e6bc01c011

Contents?: true

Size: 1.59 KB

Versions: 4

Compression:

Stored size: 1.59 KB

Contents

# 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

  # Performs a general conversion via the implementation of the call method
  class Conversion

    # @return [Symbol] The converted data type. Must be one of
    #   {Cosmos::StructureItem#data_type}
    attr_reader :converted_type
    # @return [Integer] The size in bits of the converted value
    attr_reader :converted_bit_size

    # Create a new conversion
    def initialize
      @converted_type = nil
      @converted_bit_size = nil
    end

    # Perform the conversion on the value.
    #
    # @param value [Object] The value to convert
    # @param packet [Packet] The packet which contains the value. This can
    #   be useful to reach into the packet and use other values in the
    #   conversion.
    # @param buffer [String] The packet buffer
    # @return The converted value
    def call(value, packet, buffer)
      raise "call method must be defined by subclass"
    end

    # @return [String] The conversion class
    def to_s
      self.class.to_s.split('::')[-1]
    end

    # @param (see Conversion#to_config)
    # @return [String] Config fragment for this conversion
    def to_config(read_or_write)
      "    #{read_or_write}_CONVERSION #{self.class.name.class_name_to_filename}\n"
    end

  end # class Conversion

end # module Cosmos

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
cosmos-3.8.3 lib/cosmos/conversions/conversion.rb
cosmos-3.8.2 lib/cosmos/conversions/conversion.rb
cosmos-3.8.1 lib/cosmos/conversions/conversion.rb
cosmos-3.8.0 lib/cosmos/conversions/conversion.rb