rtp-connect 1.8 → 1.9

data/lib/rtp-connect/prescription.rb

@@ -9,7 +9,7 @@ module RTP
   class Prescription < Record
 
     # The Record which this instance belongs to.
-    attr_reader :parent
+    attr_accessor :parent
     # The SiteSetup record (if any) that belongs to this Prescription.
     attr_reader :site_setup
     # An array of SimulationField records (if any) that belongs to this Prescription.
@@ -93,6 +93,7 @@ module RTP
     #
     def add_field(child)
       @fields << child.to_field
+      child.parent = self
     end
 
     # Adds a simulation field record to this instance.
@@ -101,6 +102,7 @@ module RTP
     #
     def add_simulation_field(child)
       @simulation_fields << child.to_simulation_field
+      child.parent = self
     end
 
     # Adds a site setup record to this instance.
@@ -109,6 +111,7 @@ module RTP
     #
     def add_site_setup(child)
       @site_setup = child.to_site_setup
+      child.parent = self
     end
 
     # Collects the child records of this instance in a properly sorted array.
@@ -119,6 +122,41 @@ module RTP
       return [@site_setup, @simulation_fields, @fields].flatten.compact
     end
 
+    # Removes the reference of the given instance from this instance.
+    #
+    # @param [Field, SimulationField, SiteSetup] record a child record to be removed from this instance
+    #
+    def delete(record)
+      case record
+      when Field
+        delete_child(:fields, record)
+      when SimulationField
+        delete_child(:simulation_fields, record)
+      when SiteSetup
+        delete_site_setup
+      else
+        logger.warn("Unknown class (record) given to Prescription#delete: #{record.class}")
+      end
+    end
+
+    # Removes all field references from this instance.
+    #
+    def delete_fields
+      delete_children(:fields)
+    end
+
+    # Removes all simulation_field references from this instance.
+    #
+    def delete_simulation_fields
+      delete_children(:simulation_fields)
+    end
+
+    # Removes the site setup reference from this instance.
+    #
+    def delete_site_setup
+      delete_child(:site_setup)
+    end
+
     # Computes a hash code for this object.
     #
     # @note Two objects with the same attributes will have the same hash code.
@@ -137,25 +175,6 @@ module RTP
       self
     end
 
-    # Encodes the Prescription object + any hiearchy of child objects,
-    # to a properly formatted RTPConnect ascii string.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] an RTP string with a single or multiple lines/records
-    #
-    def to_s(options={})
-      str = encode(options)
-      if children
-        children.each do |child|
-          str += child.to_s(options)
-        end
-      end
-      return str
-    end
-
-    alias :to_str :to_s
-
     # Sets the course_id attribute.
     #
     # @param [nil, #to_s] value the new attribute value

data/lib/rtp-connect/record.rb

@@ -1,144 +1,202 @@
-module RTP
-
-  # The Record class contains attributes and methods that are common
-  # for the various record types defined in the RTPConnect standard.
-  #
-  class Record
-
-    # The keyword defines the record type of a particular RTP string line.
-    attr_reader :keyword
-    # The CRC is used to validate the integrity of the content of the RTP string line.
-    attr_reader :crc
-
-    # Creates a new Record.
-    #
-    # @param [String] keyword the keyword which identifies this record
-    # @param [Integer] min_elements the minimum number of data elements required for this record
-    # @param [Integer] max_elements the maximum supported number of data elements for this record
-    #
-    def initialize(keyword, min_elements, max_elements)
-      @keyword = keyword
-      @min_elements = min_elements
-      @max_elements = max_elements
-    end
-
-    # Sets the crc (checksum) attribute.
-    #
-    # @note This value is not used when creating an RTP string from a record (a new crc is calculated)
-    # @param [#to_s] value the new attribute value
-    #
-    def crc=(value)
-      @crc = value.to_s
-    end
-
-    # Encodes a string from the contents of this instance.
-    #
-    # This produces the full record string line, including a computed CRC checksum.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] a proper RTPConnect type CSV string
-    #
-    def encode(options={})
-      encoded_values = values.collect {|v| v && v.encode('ISO8859-1')}
-      encoded_values = discard_unsupported_attributes(encoded_values, options) if options[:version]
-      content = CSV.generate_line(encoded_values, force_quotes: true, row_sep: '') + ","
-      checksum = content.checksum
-      # Complete string is content + checksum (in double quotes) + carriage return + line feed
-      return (content + checksum.to_s.wrap + "\r\n").encode('ISO8859-1')
-    end
-
-    # Follows the tree of parents until the appropriate parent of the requesting record is found.
-    #
-    # @param [Record] last_parent the previous parent (the record from the previous line in the RTP file)
-    # @param [Record] klass the expected parent record class of this record (e.g. Plan, Field)
-    #
-    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
-
-    # Verifies a proposed keyword attribute.
-    #
-    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method.
-    # @param [#to_s] value the proposed keyword attribute
-    # @raise [ArgumentError] if given an unexpected keyword
-    #
-    def keyword=(value)
-      value = value.to_s.upcase
-      raise ArgumentError, "Invalid keyword. Expected '#{@keyword}', got #{value}." unless value == @keyword
-    end
-
-    # Sets up a record by parsing a RTPConnect string line.
-    #
-    # @param [#to_s] string the extended treatment field definition record string line
-    # @return [Record] the updated Record instance
-    # @raise [ArgumentError] if given a string containing an invalid number of elements
-    #
-    def load(string, options={})
-      # Extract processed values:
-      values = string.to_s.values(options[:repair])
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{@min_elements} elements for #{@keyword}, got #{values.length}." if values.length < @min_elements
-      RTP.logger.warn "The number of given elements (#{values.length}) exceeds the known number of data elements for this record (#{@max_elements}). This may indicate an invalid string record or that the RTP format has recently been expanded with new elements." if values.length > @max_elements
-      self.send(:set_attributes, values)
-      self
-    end
-
-    # Returns self.
-    #
-    # @return [Record] self
-    #
-    def to_record
-      self
-    end
-
-    # Collects the values (attributes) of this instance.
-    #
-    # @note The CRC is not considered part of the actual values and is excluded.
-    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
-    #
-    def values
-      @attributes.collect {|attribute| self.send(attribute)}
-    end
-
-
-    private
-
-
-    # Sets the attributes of the record instance.
-    #
-    # @param [Array<String>] values the record attributes (as parsed from a record string)
-    #
-    def set_attributes(values)
-      ([values.length - 1, @max_elements - 1].min).times do |i|
-        self.send("#{@attributes[i]}=", values[i])
-      end
-      @crc = values[-1]
-    end
-
-    # Removes any attributes that are newer than the given compatibility target version.
-    # E.g. if a compatibility version of Mosaiq 2.4 is specified, attributes that were
-    # introduced in Mosaiq 2.5 or later is removed before the RTP string is created.
-    #
-    # @param [Array<String>] values the complete set of values of this record
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [Array<String>] an array of attributes where some of the recent attributes may have been removed
-    #
-    def discard_unsupported_attributes(values, options={})
-      case self
-      when SiteSetup
-        options[:version].to_f >= 2.6 ? values : values[0..-4]
-      when ExtendedField
-        options[:version].to_f >= 2.4 ? values : values[0..-5]
-      else
-        values
-      end
-    end
-
-  end
-
+module RTP
+
+  # The Record class contains attributes and methods that are common
+  # for the various record types defined in the RTPConnect standard.
+  #
+  class Record
+
+    # For most record types, there are no surplus (grouped) attributes.
+    NR_SURPLUS_ATTRIBUTES = 0
+
+    # An array of the record's attributes.
+    attr_reader :attributes
+    # The keyword defines the record type of a particular RTP string line.
+    attr_reader :keyword
+    # The CRC is used to validate the integrity of the content of the RTP string line.
+    attr_reader :crc
+
+    # Creates a new Record.
+    #
+    # @param [String] keyword the keyword which identifies this record
+    # @param [Integer] min_elements the minimum number of data elements required for this record
+    # @param [Integer] max_elements the maximum supported number of data elements for this record
+    #
+    def initialize(keyword, min_elements, max_elements)
+      @keyword = keyword
+      @min_elements = min_elements
+      @max_elements = max_elements
+    end
+
+    # Sets the crc (checksum) attribute.
+    #
+    # @note This value is not used when creating an RTP string from a record (a new crc is calculated)
+    # @param [#to_s] value the new attribute value
+    #
+    def crc=(value)
+      @crc = value.to_s
+    end
+
+    # Encodes a string from the contents of this instance.
+    #
+    # This produces the full record string line, including a computed CRC checksum.
+    #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
+    # @return [String] a proper RTPConnect type CSV string
+    #
+    def encode(options={})
+      encoded_values = values.collect {|v| v && v.encode('ISO8859-1')}
+      encoded_values = discard_unsupported_attributes(encoded_values, options) if options[:version]
+      content = CSV.generate_line(encoded_values, force_quotes: true, row_sep: '') + ","
+      checksum = content.checksum
+      # Complete string is content + checksum (in double quotes) + carriage return + line feed
+      return (content + checksum.to_s.wrap + "\r\n").encode('ISO8859-1')
+    end
+
+    # Follows the tree of parents until the appropriate parent of the requesting record is found.
+    #
+    # @param [Record] last_parent the previous parent (the record from the previous line in the RTP file)
+    # @param [Record] klass the expected parent record class of this record (e.g. Plan, Field)
+    #
+    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
+
+    # Verifies a proposed keyword attribute.
+    #
+    # @note Since only a specific string is accepted, this is more of an argument check than a traditional setter method.
+    # @param [#to_s] value the proposed keyword attribute
+    # @raise [ArgumentError] if given an unexpected keyword
+    #
+    def keyword=(value)
+      value = value.to_s.upcase
+      raise ArgumentError, "Invalid keyword. Expected '#{@keyword}', got #{value}." unless value == @keyword
+    end
+
+    # Sets up a record by parsing a RTPConnect string line.
+    #
+    # @param [#to_s] string the extended treatment field definition record string line
+    # @return [Record] the updated Record instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
+    #
+    def load(string, options={})
+      # Extract processed values:
+      values = string.to_s.values(options[:repair])
+      raise ArgumentError, "Invalid argument 'string': Expected at least #{@min_elements} elements for #{@keyword}, got #{values.length}." if values.length < @min_elements
+      RTP.logger.warn "The number of given elements (#{values.length}) exceeds the known number of data elements for this record (#{@max_elements}). This may indicate an invalid string record or that the RTP format has recently been expanded with new elements." if values.length > @max_elements
+      self.send(:set_attributes, values)
+      self
+    end
+
+    # Returns self.
+    #
+    # @return [Record] self
+    #
+    def to_record
+      self
+    end
+
+    # Encodes the record + any hiearchy of child objects,
+    # to a properly formatted RTPConnect ascii string.
+    #
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
+    # @return [String] an RTP string with a single or multiple lines/records
+    #
+    def to_s(options={})
+      str = encode(options)
+      children.each do |child|
+        # Note that the extended plan record was introduced in Mosaiq 2.5.
+        str += child.to_s(options) unless child.class == ExtendedPlan && options[:version].to_f < 2.5
+      end
+      str
+    end
+
+    alias :to_str :to_s
+
+    # Collects the values (attributes) of this instance.
+    #
+    # @note The CRC is not considered part of the actual values and is excluded.
+    # @return [Array<String>] an array of attributes (in the same order as they appear in the RTP string)
+    #
+    def values
+      @attributes.collect {|attribute| self.send(attribute)}
+    end
+
+
+    private
+
+
+    # Removes the reference of the given instance from the attribute of this record.
+    #
+    # @param [Symbol] attribute the name of the child attribute from which to remove a child
+    # @param [Record] instance a child record to be removed from this instance
+    #
+    def delete_child(attribute, instance=nil)
+      if self.send(attribute).is_a?(Array)
+        deleted = self.send(attribute).delete(instance)
+        deleted.parent = nil if deleted
+      else
+        self.send(attribute).parent = nil if self.send(attribute)
+        self.instance_variable_set("@#{attribute}", nil)
+      end
+    end
+
+    # Removes all child references of the given type from this instance.
+    #
+    # @param [Symbol] attribute the name of the child attribute to be cleared
+    #
+    def delete_children(attribute)
+      self.send(attribute).each { |c| c.parent = nil }
+      self.send(attribute).clear
+    end
+
+    # Sets the attributes of the record instance.
+    #
+    # @param [Array<String>] values the record attributes (as parsed from a record string)
+    #
+    def set_attributes(values)
+      import_indices([values.length - 1, @max_elements - 1].min).each_with_index do |indices, i|
+        param = values.values_at(*indices)
+        param = param[0] if param.length == 1
+        self.send("#{@attributes[i]}=", param)
+      end
+      @crc = values[-1]
+    end
+
+    # Gives an array of indices indicating where the attributes of this record gets its
+    # values from in the comma separated string which the instance is created from.
+    #
+    # @param [Integer] length the number of elements to create in the indices array
+    #
+    def import_indices(length)
+      Array.new(length - NR_SURPLUS_ATTRIBUTES) { |i| [i] }
+    end
+
+    # Removes any attributes that are newer than the given compatibility target version.
+    # E.g. if a compatibility version of Mosaiq 2.4 is specified, attributes that were
+    # introduced in Mosaiq 2.5 or later is removed before the RTP string is created.
+    #
+    # @param [Array<String>] values the complete set of values of this record
+    # @param [Hash] options an optional hash parameter
+    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
+    # @return [Array<String>] an array of attributes where some of the recent attributes may have been removed
+    #
+    def discard_unsupported_attributes(values, options={})
+      case self
+      when SiteSetup
+        options[:version].to_f >= 2.6 ? values : values[0..-4]
+      when ExtendedField
+        options[:version].to_f >= 2.4 ? values : values[0..-5]
+      else
+        values
+      end
+    end
+
+  end
+
 end

data/lib/rtp-connect/simulation_field.rb

@@ -1,626 +1,607 @@
-module RTP
-
-  # The simulation field class.
-  #
-  # @note Relations:
-  #   * Parent: Prescription
-  #   * Children: none
-  #
-  class SimulationField < Record
-
-    # The Record which this instance belongs to.
-    attr_reader :parent
-    attr_reader :rx_site_name
-    attr_reader :field_name
-    attr_reader :field_id
-    attr_reader :field_note
-    attr_reader :treatment_machine
-    attr_reader :gantry_angle
-    attr_reader :collimator_angle
-    attr_reader :field_x_mode
-    attr_reader :field_x
-    attr_reader :collimator_x1
-    attr_reader :collimator_x2
-    attr_reader :field_y_mode
-    attr_reader :field_y
-    attr_reader :collimator_y1
-    attr_reader :collimator_y2
-    attr_reader :couch_vertical
-    attr_reader :couch_lateral
-    attr_reader :couch_longitudinal
-    attr_reader :couch_angle
-    attr_reader :couch_pedestal
-    attr_reader :sad
-    attr_reader :ap_separation
-    attr_reader :pa_separation
-    attr_reader :lateral_separation
-    attr_reader :tangential_separation
-    attr_reader :other_label_1
-    attr_reader :ssd_1
-    attr_reader :sfd_1
-    attr_reader :other_label_2
-    attr_reader :other_measurement_1
-    attr_reader :other_measurement_2
-    attr_reader :other_label_3
-    attr_reader :other_measurement_3
-    attr_reader :other_measurement_4
-    attr_reader :other_label_4
-    attr_reader :other_measurement_5
-    attr_reader :other_measurement_6
-    attr_reader :blade_x_mode
-    attr_reader :blade_x
-    attr_reader :blade_x1
-    attr_reader :blade_x2
-    attr_reader :blade_y_mode
-    attr_reader :blade_y
-    attr_reader :blade_y1
-    attr_reader :blade_y2
-    attr_reader :ii_lateral
-    attr_reader :ii_longitudinal
-    attr_reader :ii_vertical
-    attr_reader :kvp
-    attr_reader :ma
-    attr_reader :seconds
-
-    # Creates a new SimulationField by parsing a RTPConnect string line.
-    #
-    # @param [#to_s] string the simulation field definition record string line
-    # @param [Record] parent a record which is used to determine the proper parent of this instance
-    # @return [Field] the created SimulationField instance
-    # @raise [ArgumentError] if given a string containing an invalid number of elements
-    #
-    def self.load(string, parent)
-      sf = self.new(parent)
-      sf.load(string)
-    end
-
-    # Creates a new SimulationField.
-    #
-    # @param [Record] parent a record which is used to determine the proper parent of this instance
-    #
-    def initialize(parent)
-      super('SIM_DEF', 17, 53)
-      # Parent relation (may get more than one type of record here):
-      @parent = get_parent(parent.to_record, Prescription)
-      @parent.add_simulation_field(self)
-      @attributes = [
-        # Required:
-        :keyword,
-        :rx_site_name,
-        :field_name,
-        :field_id,
-        :field_note,
-        :treatment_machine,
-        :gantry_angle,
-        :collimator_angle,
-        :field_x_mode,
-        :field_x,
-        :collimator_x1,
-        :collimator_x2,
-        :field_y_mode,
-        :field_y,
-        :collimator_y1,
-        :collimator_y2,
-        # Optional:
-        :couch_vertical,
-        :couch_lateral,
-        :couch_longitudinal,
-        :couch_angle,
-        :couch_pedestal,
-        :sad,
-        :ap_separation,
-        :pa_separation,
-        :lateral_separation,
-        :tangential_separation,
-        :other_label_1,
-        :ssd_1,
-        :sfd_1,
-        :other_label_2,
-        :other_measurement_1,
-        :other_measurement_2,
-        :other_label_3,
-        :other_measurement_3,
-        :other_measurement_4,
-        :other_label_4,
-        :other_measurement_5,
-        :other_measurement_6,
-        :blade_x_mode,
-        :blade_x,
-        :blade_x1,
-        :blade_x2,
-        :blade_y_mode,
-        :blade_y,
-        :blade_y1,
-        :blade_y2,
-        :ii_lateral,
-        :ii_longitudinal,
-        :ii_vertical,
-        :kvp,
-        :ma,
-        :seconds
-      ]
-    end
-
-    # Checks for equality.
-    #
-    # Other and self are considered equivalent if they are
-    # of compatible types and their attributes are equivalent.
-    #
-    # @param other an object to be compared with self.
-    # @return [Boolean] true if self and other are considered equivalent
-    #
-    def ==(other)
-      if other.respond_to?(:to_simulation_field)
-        other.send(:state) == state
-      end
-    end
-
-    alias_method :eql?, :==
-
-    # Collects the child records of this instance in a properly sorted array.
-    #
-    # @return [Array] an emtpy array
-    #
-    def children
-      return Array.new
-    end
-
-    # Computes a hash code for this object.
-    #
-    # @note Two objects with the same attributes will have the same hash code.
-    #
-    # @return [Fixnum] the object's hash code
-    #
-    def hash
-      state.hash
-    end
-
-    # Returns self.
-    #
-    # @return [SimulationField] self
-    #
-    def to_simulation_field
-      self
-    end
-
-    # Encodes the SimulationField object + any hiearchy of child objects,
-    # to a properly formatted RTPConnect ascii string.
-    #
-    # @param [Hash] options an optional hash parameter
-    # @option options [Float] :version the Mosaiq compatibility version number (e.g. 2.4) used for the output
-    # @return [String] an RTP string with a single or multiple lines/records
-    #
-    def to_s(options={})
-      str = encode(options)
-      if children
-        children.each do |child|
-          str += child.to_s(options)
-        end
-      end
-      return str
-    end
-
-    alias :to_str :to_s
-
-    # Sets the rx_site_name attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def rx_site_name=(value)
-      @rx_site_name = value && value.to_s
-    end
-
-    # Sets the field_name attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_name=(value)
-      @field_name = value && value.to_s
-    end
-
-    # Sets the field_id attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_id=(value)
-      @field_id = value && value.to_s
-    end
-
-    # Sets the field_note attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_note=(value)
-      @field_note = value && value.to_s
-    end
-
-    # Sets the treatment_machine attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def treatment_machine=(value)
-      @treatment_machine = value && value.to_s
-    end
-
-    # Sets the gantry_angle attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def gantry_angle=(value)
-      @gantry_angle = value && value.to_s.strip
-    end
-
-    # Sets the collimator_angle attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def collimator_angle=(value)
-      @collimator_angle = value && value.to_s.strip
-    end
-
-    # Sets the field_x_mode attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_x_mode=(value)
-      @field_x_mode = value && value.to_s
-    end
-
-    # Sets the field_x attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_x=(value)
-      @field_x = value && value.to_s.strip
-    end
-
-    # Sets the collimator_x1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def collimator_x1=(value)
-      @collimator_x1 = value && value.to_s.strip
-    end
-
-    # Sets the collimator_x2 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def collimator_x2=(value)
-      @collimator_x2 = value && value.to_s.strip
-    end
-
-    # Sets the field_y_mode attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_y_mode=(value)
-      @field_y_mode = value && value.to_s
-    end
-
-    # Sets the field_y attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def field_y=(value)
-      @field_y = value && value.to_s.strip
-    end
-
-    # Sets the collimator_y1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def collimator_y1=(value)
-      @collimator_y1 = value && value.to_s.strip
-    end
-
-    # Sets the collimator_y2 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def collimator_y2=(value)
-      @collimator_y2 = value && value.to_s.strip
-    end
-
-    # Sets the couch_vertical attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def couch_vertical=(value)
-      @couch_vertical = value && value.to_s.strip
-    end
-
-    # Sets the couch_lateral attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def couch_lateral=(value)
-      @couch_lateral = value && value.to_s.strip
-    end
-
-    # Sets the couch_longitudinal attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def couch_longitudinal=(value)
-      @couch_longitudinal = value && value.to_s.strip
-    end
-
-    # Sets the couch_angle attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def couch_angle=(value)
-      @couch_angle = value && value.to_s.strip.strip
-    end
-
-    # Sets the couch_pedestal attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def couch_pedestal=(value)
-      @couch_pedestal = value && value.to_s.strip
-    end
-
-    # Sets the sad attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def sad=(value)
-      @sad = value && value.to_s.strip
-    end
-
-    # Sets the ap_separation attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def ap_separation=(value)
-      @ap_separation = value && value.to_s
-    end
-
-    # Sets the pa_separation attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def pa_separation=(value)
-      @pa_separation = value && value.to_s.strip
-    end
-
-    # Sets the lateral_separation attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def lateral_separation=(value)
-      @lateral_separation = value && value.to_s.strip
-    end
-
-    # Sets the tangential_separation attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def tangential_separation=(value)
-      @tangential_separation = value && value.to_s.strip
-    end
-
-    # Sets the other_label_1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_label_1=(value)
-      @other_label_1 = value && value.to_s
-    end
-
-    # Sets the ssd_1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def ssd_1=(value)
-      @ssd_1 = value && value.to_s
-    end
-
-    # Sets the sfd_1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def sfd_1=(value)
-      @sfd_1 = value && value.to_s
-    end
-
-    # Sets the other_label_2 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_label_2=(value)
-      @other_label_2 = value && value.to_s
-    end
-
-    # Sets the other_measurement_1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_measurement_1=(value)
-      @other_measurement_1 = value && value.to_s
-    end
-
-    # Sets the other_measurement_2 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_measurement_2=(value)
-      @other_measurement_2 = value && value.to_s
-    end
-
-    # Sets the other_label_3 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_label_3=(value)
-      @other_label_3 = value && value.to_s
-    end
-
-    # Sets the other_measurement_3 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_measurement_3=(value)
-      @other_measurement_3 = value && value.to_s
-    end
-
-    # Sets the other_measurement_4 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_measurement_4=(value)
-      @other_measurement_4 = value && value.to_s
-    end
-
-    # Sets the other_label_4 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_label_4=(value)
-      @other_label_4 = value && value.to_s
-    end
-
-    # Sets the other_measurement_5 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_measurement_5=(value)
-      @other_measurement_5 = value && value.to_s
-    end
-
-    # Sets the other_measurement_6 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def other_measurement_6=(value)
-      @other_measurement_6 = value && value.to_s
-    end
-
-    # Sets the blade_x_mode attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_x_mode=(value)
-      @blade_x_mode = value && value.to_s
-    end
-
-    # Sets the blade_x attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_x=(value)
-      @blade_x = value && value.to_s
-    end
-
-    # Sets the blade_x1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_x1=(value)
-      @blade_x1 = value && value.to_s
-    end
-
-    # Sets the blade_x2 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_x2=(value)
-      @blade_x2 = value && value.to_s
-    end
-
-    # Sets the blade_y_mode attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_y_mode=(value)
-      @blade_y_mode = value && value.to_s
-    end
-
-    # Sets the blade_y attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_y=(value)
-      @blade_y = value && value.to_s
-    end
-
-    # Sets the blade_y1 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_y1=(value)
-      @blade_y1 = value && value.to_s
-    end
-
-    # Sets the blade_y2 attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def blade_y2=(value)
-      @blade_y2 = value && value.to_s
-    end
-
-    # Sets the ii_lateral attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def ii_lateral=(value)
-      @ii_lateral = value && value.to_s
-    end
-
-    # Sets the ii_longitudinal attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def ii_longitudinal=(value)
-      @ii_longitudinal = value && value.to_s
-    end
-
-    # Sets the ii_vertical attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def ii_vertical=(value)
-      @ii_vertical = value && value.to_s
-    end
-
-    # Sets the kvp attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def kvp=(value)
-      @kvp = value && value.to_s
-    end
-
-    # Sets the ma attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def ma=(value)
-      @ma = value && value.to_s
-    end
-
-    # Sets the seconds attribute.
-    #
-    # @param [nil, #to_s] value the new attribute value
-    #
-    def seconds=(value)
-      @seconds = value && value.to_s
-    end
-
-
-    private
-
-
-    # Collects the attributes of this instance.
-    #
-    # @note The CRC is not considered part of the attributes of interest and is excluded
-    # @return [Array<String>] an array of attributes
-    #
-    alias_method :state, :values
-
-  end
-
+module RTP
+
+  # The simulation field class.
+  #
+  # @note Relations:
+  #   * Parent: Prescription
+  #   * Children: none
+  #
+  class SimulationField < Record
+
+    # The Record which this instance belongs to.
+    attr_accessor :parent
+    attr_reader :rx_site_name
+    attr_reader :field_name
+    attr_reader :field_id
+    attr_reader :field_note
+    attr_reader :treatment_machine
+    attr_reader :gantry_angle
+    attr_reader :collimator_angle
+    attr_reader :field_x_mode
+    attr_reader :field_x
+    attr_reader :collimator_x1
+    attr_reader :collimator_x2
+    attr_reader :field_y_mode
+    attr_reader :field_y
+    attr_reader :collimator_y1
+    attr_reader :collimator_y2
+    attr_reader :couch_vertical
+    attr_reader :couch_lateral
+    attr_reader :couch_longitudinal
+    attr_reader :couch_angle
+    attr_reader :couch_pedestal
+    attr_reader :sad
+    attr_reader :ap_separation
+    attr_reader :pa_separation
+    attr_reader :lateral_separation
+    attr_reader :tangential_separation
+    attr_reader :other_label_1
+    attr_reader :ssd_1
+    attr_reader :sfd_1
+    attr_reader :other_label_2
+    attr_reader :other_measurement_1
+    attr_reader :other_measurement_2
+    attr_reader :other_label_3
+    attr_reader :other_measurement_3
+    attr_reader :other_measurement_4
+    attr_reader :other_label_4
+    attr_reader :other_measurement_5
+    attr_reader :other_measurement_6
+    attr_reader :blade_x_mode
+    attr_reader :blade_x
+    attr_reader :blade_x1
+    attr_reader :blade_x2
+    attr_reader :blade_y_mode
+    attr_reader :blade_y
+    attr_reader :blade_y1
+    attr_reader :blade_y2
+    attr_reader :ii_lateral
+    attr_reader :ii_longitudinal
+    attr_reader :ii_vertical
+    attr_reader :kvp
+    attr_reader :ma
+    attr_reader :seconds
+
+    # Creates a new SimulationField by parsing a RTPConnect string line.
+    #
+    # @param [#to_s] string the simulation field definition record string line
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    # @return [Field] the created SimulationField instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
+    #
+    def self.load(string, parent)
+      sf = self.new(parent)
+      sf.load(string)
+    end
+
+    # Creates a new SimulationField.
+    #
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    #
+    def initialize(parent)
+      super('SIM_DEF', 17, 53)
+      # Parent relation (may get more than one type of record here):
+      @parent = get_parent(parent.to_record, Prescription)
+      @parent.add_simulation_field(self)
+      @attributes = [
+        # Required:
+        :keyword,
+        :rx_site_name,
+        :field_name,
+        :field_id,
+        :field_note,
+        :treatment_machine,
+        :gantry_angle,
+        :collimator_angle,
+        :field_x_mode,
+        :field_x,
+        :collimator_x1,
+        :collimator_x2,
+        :field_y_mode,
+        :field_y,
+        :collimator_y1,
+        :collimator_y2,
+        # Optional:
+        :couch_vertical,
+        :couch_lateral,
+        :couch_longitudinal,
+        :couch_angle,
+        :couch_pedestal,
+        :sad,
+        :ap_separation,
+        :pa_separation,
+        :lateral_separation,
+        :tangential_separation,
+        :other_label_1,
+        :ssd_1,
+        :sfd_1,
+        :other_label_2,
+        :other_measurement_1,
+        :other_measurement_2,
+        :other_label_3,
+        :other_measurement_3,
+        :other_measurement_4,
+        :other_label_4,
+        :other_measurement_5,
+        :other_measurement_6,
+        :blade_x_mode,
+        :blade_x,
+        :blade_x1,
+        :blade_x2,
+        :blade_y_mode,
+        :blade_y,
+        :blade_y1,
+        :blade_y2,
+        :ii_lateral,
+        :ii_longitudinal,
+        :ii_vertical,
+        :kvp,
+        :ma,
+        :seconds
+      ]
+    end
+
+    # Checks for equality.
+    #
+    # Other and self are considered equivalent if they are
+    # of compatible types and their attributes are equivalent.
+    #
+    # @param other an object to be compared with self.
+    # @return [Boolean] true if self and other are considered equivalent
+    #
+    def ==(other)
+      if other.respond_to?(:to_simulation_field)
+        other.send(:state) == state
+      end
+    end
+
+    alias_method :eql?, :==
+
+    # Collects the child records of this instance in a properly sorted array.
+    #
+    # @return [Array] an emtpy array
+    #
+    def children
+      return Array.new
+    end
+
+    # Computes a hash code for this object.
+    #
+    # @note Two objects with the same attributes will have the same hash code.
+    #
+    # @return [Fixnum] the object's hash code
+    #
+    def hash
+      state.hash
+    end
+
+    # Returns self.
+    #
+    # @return [SimulationField] self
+    #
+    def to_simulation_field
+      self
+    end
+
+    # Sets the rx_site_name attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def rx_site_name=(value)
+      @rx_site_name = value && value.to_s
+    end
+
+    # Sets the field_name attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_name=(value)
+      @field_name = value && value.to_s
+    end
+
+    # Sets the field_id attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_id=(value)
+      @field_id = value && value.to_s
+    end
+
+    # Sets the field_note attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_note=(value)
+      @field_note = value && value.to_s
+    end
+
+    # Sets the treatment_machine attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def treatment_machine=(value)
+      @treatment_machine = value && value.to_s
+    end
+
+    # Sets the gantry_angle attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def gantry_angle=(value)
+      @gantry_angle = value && value.to_s.strip
+    end
+
+    # Sets the collimator_angle attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def collimator_angle=(value)
+      @collimator_angle = value && value.to_s.strip
+    end
+
+    # Sets the field_x_mode attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_x_mode=(value)
+      @field_x_mode = value && value.to_s
+    end
+
+    # Sets the field_x attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_x=(value)
+      @field_x = value && value.to_s.strip
+    end
+
+    # Sets the collimator_x1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def collimator_x1=(value)
+      @collimator_x1 = value && value.to_s.strip
+    end
+
+    # Sets the collimator_x2 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def collimator_x2=(value)
+      @collimator_x2 = value && value.to_s.strip
+    end
+
+    # Sets the field_y_mode attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_y_mode=(value)
+      @field_y_mode = value && value.to_s
+    end
+
+    # Sets the field_y attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def field_y=(value)
+      @field_y = value && value.to_s.strip
+    end
+
+    # Sets the collimator_y1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def collimator_y1=(value)
+      @collimator_y1 = value && value.to_s.strip
+    end
+
+    # Sets the collimator_y2 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def collimator_y2=(value)
+      @collimator_y2 = value && value.to_s.strip
+    end
+
+    # Sets the couch_vertical attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_vertical=(value)
+      @couch_vertical = value && value.to_s.strip
+    end
+
+    # Sets the couch_lateral attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_lateral=(value)
+      @couch_lateral = value && value.to_s.strip
+    end
+
+    # Sets the couch_longitudinal attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_longitudinal=(value)
+      @couch_longitudinal = value && value.to_s.strip
+    end
+
+    # Sets the couch_angle attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_angle=(value)
+      @couch_angle = value && value.to_s.strip.strip
+    end
+
+    # Sets the couch_pedestal attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_pedestal=(value)
+      @couch_pedestal = value && value.to_s.strip
+    end
+
+    # Sets the sad attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def sad=(value)
+      @sad = value && value.to_s.strip
+    end
+
+    # Sets the ap_separation attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def ap_separation=(value)
+      @ap_separation = value && value.to_s
+    end
+
+    # Sets the pa_separation attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def pa_separation=(value)
+      @pa_separation = value && value.to_s.strip
+    end
+
+    # Sets the lateral_separation attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def lateral_separation=(value)
+      @lateral_separation = value && value.to_s.strip
+    end
+
+    # Sets the tangential_separation attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def tangential_separation=(value)
+      @tangential_separation = value && value.to_s.strip
+    end
+
+    # Sets the other_label_1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_label_1=(value)
+      @other_label_1 = value && value.to_s
+    end
+
+    # Sets the ssd_1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def ssd_1=(value)
+      @ssd_1 = value && value.to_s
+    end
+
+    # Sets the sfd_1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def sfd_1=(value)
+      @sfd_1 = value && value.to_s
+    end
+
+    # Sets the other_label_2 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_label_2=(value)
+      @other_label_2 = value && value.to_s
+    end
+
+    # Sets the other_measurement_1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_measurement_1=(value)
+      @other_measurement_1 = value && value.to_s
+    end
+
+    # Sets the other_measurement_2 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_measurement_2=(value)
+      @other_measurement_2 = value && value.to_s
+    end
+
+    # Sets the other_label_3 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_label_3=(value)
+      @other_label_3 = value && value.to_s
+    end
+
+    # Sets the other_measurement_3 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_measurement_3=(value)
+      @other_measurement_3 = value && value.to_s
+    end
+
+    # Sets the other_measurement_4 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_measurement_4=(value)
+      @other_measurement_4 = value && value.to_s
+    end
+
+    # Sets the other_label_4 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_label_4=(value)
+      @other_label_4 = value && value.to_s
+    end
+
+    # Sets the other_measurement_5 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_measurement_5=(value)
+      @other_measurement_5 = value && value.to_s
+    end
+
+    # Sets the other_measurement_6 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def other_measurement_6=(value)
+      @other_measurement_6 = value && value.to_s
+    end
+
+    # Sets the blade_x_mode attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_x_mode=(value)
+      @blade_x_mode = value && value.to_s
+    end
+
+    # Sets the blade_x attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_x=(value)
+      @blade_x = value && value.to_s
+    end
+
+    # Sets the blade_x1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_x1=(value)
+      @blade_x1 = value && value.to_s
+    end
+
+    # Sets the blade_x2 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_x2=(value)
+      @blade_x2 = value && value.to_s
+    end
+
+    # Sets the blade_y_mode attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_y_mode=(value)
+      @blade_y_mode = value && value.to_s
+    end
+
+    # Sets the blade_y attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_y=(value)
+      @blade_y = value && value.to_s
+    end
+
+    # Sets the blade_y1 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_y1=(value)
+      @blade_y1 = value && value.to_s
+    end
+
+    # Sets the blade_y2 attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def blade_y2=(value)
+      @blade_y2 = value && value.to_s
+    end
+
+    # Sets the ii_lateral attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def ii_lateral=(value)
+      @ii_lateral = value && value.to_s
+    end
+
+    # Sets the ii_longitudinal attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def ii_longitudinal=(value)
+      @ii_longitudinal = value && value.to_s
+    end
+
+    # Sets the ii_vertical attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def ii_vertical=(value)
+      @ii_vertical = value && value.to_s
+    end
+
+    # Sets the kvp attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def kvp=(value)
+      @kvp = value && value.to_s
+    end
+
+    # Sets the ma attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def ma=(value)
+      @ma = value && value.to_s
+    end
+
+    # Sets the seconds attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def seconds=(value)
+      @seconds = value && value.to_s
+    end
+
+
+    private
+
+
+    # Collects the attributes of this instance.
+    #
+    # @note The CRC is not considered part of the attributes of interest and is excluded
+    # @return [Array<String>] an array of attributes
+    #
+    alias_method :state, :values
+
+  end
+
 end