rtp-connect 1.0

data/lib/rtp-connect/prescription.rb

@@ -0,0 +1,218 @@
+module RTP
+
+  # The Prescription site class.
+  #
+  # === Relations
+  #
+  # * Parent: Plan
+  # * Children: SiteSetup, (SimulationField), Field
+  #
+  class Prescription < Record
+
+    # The Record which this instance belongs to.
+    attr_reader :parent
+    # The SiteSetup record (if any) that belongs to this Prescription.
+    attr_reader :site_setup
+    # An array of Field records (if any) that belongs to this Prescription.
+    attr_reader :fields
+    attr_reader :course_id
+    attr_reader :rx_site_name
+    attr_reader :technique
+    attr_reader :modality
+    attr_reader :dose_spec
+    attr_reader :rx_depth
+    attr_reader :dose_ttl
+    attr_reader :dose_tx
+    attr_reader :pattern
+    attr_reader :rx_note
+    attr_reader :number_of_fields
+
+    # Creates a new Prescription site by parsing a RTPConnect string line.
+    #
+    # === Parameters
+    #
+    # * <tt>string</tt> -- A string containing a prescription site record.
+    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    #
+    def self.load(string, parent)
+      raise ArgumentError, "Invalid argument 'string'. Expected String, got #{string.class}." unless string.is_a?(String)
+      raise ArgumentError, "Invalid argument 'parent'. Expected RTP::Record, got #{parent.class}." unless parent.is_a?(RTP::Record)
+      # Get the quote-less values:
+      values = string.values
+      raise ArgumentError, "Invalid argument 'string': Expected exactly 13 elements, got #{values.length}." unless values.length == 13
+      p = self.new(parent)
+      # Assign the values to attributes:
+      p.keyword = values[0]
+      p.course_id = values[1]
+      p.rx_site_name = values[2]
+      p.technique = values[3]
+      p.modality = values[4]
+      p.dose_spec = values[5]
+      p.rx_depth = values[6]
+      p.dose_ttl = values[7]
+      p.dose_tx = values[8]
+      p.pattern = values[9]
+      p.rx_note = values[10]
+      p.number_of_fields = values[11]
+      p.crc = values[12]
+      return p
+    end
+
+    # Creates a new Prescription site.
+    #
+    # === Parameters
+    #
+    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    #
+    def initialize(parent)
+      raise ArgumentError, "Invalid argument 'parent'. Expected RTP::Record, got #{parent.class}." unless parent.is_a?(RTP::Record)
+      # Child objects:
+      @site_setup = nil
+      @fields = Array.new
+      # Parent relation:
+      @parent = get_parent(parent, Plan)
+      @parent.add_prescription(self)
+      @keyword = 'RX_DEF'
+    end
+
+    # Adds a treatment Field record to this instance.
+    #
+    def add_field(child)
+      raise ArgumentError, "Invalid argument 'child'. Expected RTP::Field, got #{child.class}." unless child.is_a?(RTP::Field)
+      @fields << child
+    end
+
+    # Connects a Site setup record to this instance.
+    #
+    def add_site_setup(child)
+      raise ArgumentError, "Invalid argument 'child'. Expected RTP::SiteSetup, got #{child.class}." unless child.is_a?(RTP::SiteSetup)
+      @site_setup = child
+    end
+
+    # Returns the a properly sorted array of the child records of this instance.
+    #
+    def children
+      return [@site_setup, @fields].flatten.compact
+    end
+
+    # Returns the values of this instance in an array.
+    # The values does not include the CRC.
+    #
+    def values
+      return [
+        @keyword,
+        @course_id,
+        @rx_site_name,
+        @technique,
+        @modality,
+        @dose_spec,
+        @rx_depth,
+        @dose_ttl,
+        @dose_tx,
+        @pattern,
+        @rx_note,
+        @number_of_fields
+      ]
+    end
+
+    # Writes the Prescription object + any hiearchy of child objects,
+    # to a properly formatted RTPConnect ascii string.
+    #
+    def to_str
+      str = encode
+      if children
+        children.each do |child|
+          str += child.to_str
+        end
+      end
+      return str
+    end
+
+    # Sets the keyword attribute.
+    #
+    def keyword=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      raise ArgumentError, "Invalid keyword. Expected 'RX_DEF', got #{value}." unless value.upcase == "RX_DEF"
+      @keyword = value
+    end
+
+    # Sets the course_id attribute.
+    #
+    def course_id=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @course_id = value
+    end
+
+    # Sets the rx_site_name attribute.
+    #
+    def rx_site_name=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @rx_site_name = value
+    end
+
+    # Sets the technique attribute.
+    #
+    def technique=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @technique = value
+    end
+
+    # Sets the modality attribute.
+    #
+    def modality=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @modality = value
+    end
+
+    # Sets the dose_spec attribute.
+    #
+    def dose_spec=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @dose_spec = value
+    end
+
+    # Sets the rx_depth attribute.
+    #
+    def rx_depth=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @rx_depth = value
+    end
+
+    # Sets the dose_ttl attribute.
+    #
+    def dose_ttl=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @dose_ttl = value
+    end
+
+    # Sets the dose_tx attribute.
+    #
+    def dose_tx=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @dose_tx = value
+    end
+
+    # Sets the pattern attribute.
+    #
+    def pattern=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @pattern = value
+    end
+
+    # Sets the rx_note attribute.
+    #
+    def rx_note=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @rx_note = value
+    end
+
+    # Sets the number_of_fields attribute.
+    #
+    def number_of_fields=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @number_of_fields = value
+    end
+
+  end
+
+end

data/lib/rtp-connect/record.rb

@@ -0,0 +1,37 @@
+module RTP
+
+  class Record
+
+    attr_reader :keyword
+    attr_reader :crc
+
+    # Encodes a string from the contents of this instance.
+    # This produces the full line, including a computed CRC checksum.
+    #
+    def encode
+      content = values.encode + ","
+      checksum = content.checksum
+      # Complete string is content + checksum (in double quotes) + carriage return + line feed
+      return content + checksum.to_s.wrap + "\r\n"
+    end
+
+    # Follows the tree of parents until the appropriate parent of the requesting record is found.
+    #
+    def get_parent(last_parent, klass)
+      if last_parent.is_a?(klass)
+        return last_parent
+      else
+        return last_parent.get_parent(last_parent.parent, klass)
+      end
+    end
+
+    # Setting the keyword attribute.
+    #
+    def crc=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @crc = value
+    end
+
+  end
+
+end

data/lib/rtp-connect/ruby_extensions.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+# This file contains extensions to the Ruby library which are used by the RTPConnect library.
+
+# Extension to the String class. These extensions are focused on analyzing RTPConnect strings.
+#
+class String
+
+  # Returns the CRC checksum (16 bit unsigned integer) for a given string.
+  #
+  def checksum
+    crc = RTP::CRC_SEED
+    self.each_codepoint do |byte|
+      crc = RTP::CRC_TABLE[(crc ^ byte) & 0xff] ^ (crc >> 8)
+    end
+    return crc
+  end
+
+  # Returns the elements of a line from the RTPConnect ascii string.
+  # The line consists of elements (surrounded by double quotes), separated by comma.
+  # This method performs a split based on comma and returns the element strings in an array.
+  #
+  def elements
+    return self.split(',')
+  end
+
+  # Removes double quotes from a string.
+  # Returns the quote-less string.
+  #
+  def value
+    return self.gsub('"', '')
+  end
+
+  # Returns the element values of a line from the RTPConnect ascii string.
+  # The line consists of values (surrounded by double quotes), separated by comma.
+  # This method performs a split based on comma and removes the quotes from each value,
+  # and the resulting quote-less value strings are returned in an array.
+  #
+  def values
+    original = self.split(',')
+    processed = Array.new
+    original.collect {|element| processed << element.gsub('"', '')}
+    return processed
+  end
+
+  # Wraps double quotes around the string.
+  #
+  def wrap
+    return '"' + self + '"'
+  end
+
+end
+
+
+# Extension to the Array class. These extensions are focused on creating RTPConnect
+# strings from an array of values.
+#
+class Array
+
+  # Encodes an RTPConnect string from an array of values.
+  # Each value in the array is wrapped with double quotes,
+  # before the values are joined with a comma separator.
+  #
+  def encode
+    wrapped = self.collect{|value| value.wrap}
+    return wrapped.join(',')
+  end
+
+end
+
+# An extension to the NilClass, facilitating a transformation from nil to
+# an empty (double quoted) string in the case of undefined attributes.
+#
+class NilClass
+
+  # Returns a double quoted, but otherwise empty string.
+  #
+  def wrap
+    return '""'
+  end
+
+end

data/lib/rtp-connect/site_setup.rb

@@ -0,0 +1,227 @@
+module RTP
+
+  # The SiteSetup class.
+  #
+  # === Relations
+  #
+  # * Parent: Prescription
+  # * Children: none
+  #
+  class SiteSetup < Record
+
+    # The Record which this instance belongs to.
+    attr_reader :parent
+    attr_reader :rx_site_name
+    attr_reader :patient_orientation
+    attr_reader :treatment_machine
+    attr_reader :tolerance_table
+    attr_reader :iso_pos_x
+    attr_reader :iso_pos_y
+    attr_reader :iso_pos_z
+    attr_reader :structure_set_uid
+    attr_reader :frame_of_ref_uid
+    attr_reader :couch_vertical
+    attr_reader :couch_lateral
+    attr_reader :couch_longitudinal
+    attr_reader :couch_angle
+    attr_reader :couch_pedestal
+
+    # Creates a new SiteSetup setup by parsing a RTPConnect string line.
+    #
+    # === Parameters
+    #
+    # * <tt>string</tt> -- A string containing a site setup record.
+    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    #
+    def self.load(string, parent)
+      raise ArgumentError, "Invalid argument 'string'. Expected String, got #{string.class}." unless string.is_a?(String)
+      raise ArgumentError, "Invalid argument 'parent'. Expected RTP::Prescription, got #{parent.class}." unless parent.is_a?(RTP::Prescription)
+      # Get the quote-less values:
+      values = string.values
+      raise ArgumentError, "Invalid argument 'string': Expected exactly 16 elements, got #{values.length}." unless values.length == 16
+      s = self.new(parent)
+      # Assign the values to attributes:
+      s.keyword = values[0]
+      s.rx_site_name = values[1]
+      s.patient_orientation = values[2]
+      s.treatment_machine = values[3]
+      s.tolerance_table = values[4]
+      s.iso_pos_x = values[5]
+      s.iso_pos_y = values[6]
+      s.iso_pos_z = values[7]
+      s.structure_set_uid = values[8]
+      s.frame_of_ref_uid = values[9]
+      s.couch_vertical = values[10]
+      s.couch_lateral = values[11]
+      s.couch_longitudinal = values[12]
+      s.couch_angle = values[13]
+      s.couch_pedestal = values[14]
+      s.crc = values[15]
+      return s
+    end
+
+    # Creates a new SiteSetup.
+    #
+    # === Parameters
+    #
+    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    #
+    def initialize(parent)
+      raise ArgumentError, "Invalid argument 'parent'. Expected RTP::Prescription, got #{parent.class}." unless parent.is_a?(RTP::Prescription)
+      # Parent relation:
+      @parent = get_parent(parent, Prescription)
+      @parent.add_site_setup(self)
+      @keyword = 'SITE_SETUP_DEF'
+    end
+
+    # Returns an empty array, as these instances are child-less by definition.
+    #
+    def children
+      return Array.new
+    end
+
+    # Returns the values of this instance in an array.
+    # The values does not include the CRC.
+    #
+    def values
+      return [
+        @keyword,
+        @rx_site_name,
+        @patient_orientation,
+        @treatment_machine,
+        @tolerance_table,
+        @iso_pos_x,
+        @iso_pos_y,
+        @iso_pos_z,
+        @structure_set_uid,
+        @frame_of_ref_uid,
+        @couch_vertical,
+        @couch_lateral,
+        @couch_longitudinal,
+        @couch_angle,
+        @couch_pedestal
+      ]
+    end
+
+    # Writes the SiteSetup object + any hiearchy of child objects,
+    # to a properly formatted RTPConnect ascii string.
+    #
+    def to_str
+      str = encode
+      if children
+        children.each do |child|
+          str += child.to_str
+        end
+      end
+      return str
+    end
+
+    # Sets the keyword attribute.
+    #
+    def keyword=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      raise ArgumentError, "Invalid keyword. Expected 'SITE_SETUP_DEF', got #{value}." unless value.upcase == "SITE_SETUP_DEF"
+      @keyword = value
+    end
+
+    # Sets the rx_site_name attribute.
+    #
+    def rx_site_name=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @rx_site_name = value
+    end
+
+    # Sets the patient_orientation attribute.
+    #
+    def patient_orientation=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @patient_orientation = value
+    end
+
+    # Sets the treatment_machine attribute.
+    #
+    def treatment_machine=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @treatment_machine = value
+    end
+
+    # Sets the tolerance_table attribute.
+    #
+    def tolerance_table=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @tolerance_table = value
+    end
+
+    # Sets the iso_pos_x attribute.
+    #
+    def iso_pos_x=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @iso_pos_x = value
+    end
+
+    # Sets the iso_pos_y attribute.
+    #
+    def iso_pos_y=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @iso_pos_y = value
+    end
+
+    # Sets the iso_pos_z attribute.
+    #
+    def iso_pos_z=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @iso_pos_z = value
+    end
+
+    # Sets the structure_set_uid attribute.
+    #
+    def structure_set_uid=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @structure_set_uid = value
+    end
+
+    # Sets the frame_of_ref_uid attribute.
+    #
+    def frame_of_ref_uid=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @frame_of_ref_uid = value
+    end
+
+    # Sets the couch_vertical attribute.
+    #
+    def couch_vertical=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @couch_vertical = value
+    end
+
+    # Sets the couch_lateral attribute.
+    #
+    def couch_lateral=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @couch_lateral = value
+    end
+
+    # Sets the couch_longitudinal attribute.
+    #
+    def couch_longitudinal=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @couch_longitudinal = value
+    end
+
+    # Sets the couch_angle attribute.
+    #
+    def couch_angle=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @couch_angle = value
+    end
+
+    # Sets the couch_pedestal attribute.
+    #
+    def couch_pedestal=(value)
+      raise ArgumentError, "Invalid argument 'value'. Expected String, got #{value.class}." unless value.is_a?(String)
+      @couch_pedestal = value
+    end
+
+  end
+
+end