rtp-connect 1.1 → 1.2

data/lib/rtp-connect/dose_tracking.rb

@@ -0,0 +1,222 @@
+module RTP
+
+  # The DoseTracking class.
+  #
+  # @note Relations:
+  #   * Parent: Plan
+  #   * Children: none
+  #
+  class DoseTracking < Record
+
+    # The Record which this instance belongs to.
+    attr_reader :parent
+    # The DoseAction records (if any) that belongs to this DoseTracking.
+    attr_reader :dose_actions
+    attr_reader :region_name
+    attr_reader :region_prior_dose
+    # Note: This attribute contains an array of all field_id values (1..10).
+    attr_reader :field_ids
+    # Note: This attribute contains an array of all reg_coeff values (1..10).
+    attr_reader :region_coeffs
+    attr_reader :actual_dose
+    attr_reader :actual_fractions
+
+    # Creates a new DoseTracking by parsing a RTPConnect string line.
+    #
+    # @param [#to_s] string the dose tracking definition record string line
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    # @return [DoseTracking] the created DoseTracking instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
+    #
+    def self.load(string, parent)
+      # Get the quote-less values:
+      values = string.to_s.values
+      raise ArgumentError, "Invalid argument 'string': Expected exactly 26 elements, got #{values.length}." unless values.length == 26
+      d = self.new(parent)
+      # Assign the values to attributes:
+      d.keyword = values[0]
+      d.region_name = values[1]
+      d.region_prior_dose = values[2]
+      d.field_ids = values.values_at(3, 5, 7, 9, 11, 13, 15, 17, 19, 21)
+      d.region_coeffs = values.values_at(4, 6, 8, 10, 12, 14, 16, 18, 20, 22)
+      d.actual_dose = values[23]
+      d.actual_fractions = values[24]
+      d.crc = values[25]
+      return d
+    end
+
+    # Creates a new DoseTracking.
+    #
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    #
+    def initialize(parent)
+      # Child records:
+      @dose_actions = Array.new
+      # Parent relation (may get more than one type of record here):
+      @parent = get_parent(parent.to_record, Plan)
+      @parent.add_dose_tracking(self)
+      @keyword = 'DOSE_DEF'
+      @field_ids = Array.new(10)
+      @region_coeffs = Array.new(10)
+    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_dose_tracking)
+        other.send(:state) == state
+      end
+    end
+
+    alias_method :eql?, :==
+
+    # As of now, gives an empty array. However, by definition, this record may
+    # have dose action (point) records as children, but this is not implemented yet.
+    #
+    # @return [Array] an emtpy array
+    #
+    def children
+      #return @dose_actions
+      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
+
+    # 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
+      return [
+        @keyword,
+        @region_name,
+        @region_prior_dose,
+        # Need to join every other two elements from these two arrays together:
+        *@field_ids.zip(@region_coeffs).flatten,
+        @actual_dose,
+        @actual_fractions
+      ]
+    end
+
+    # Returns self.
+    #
+    # @return [DoseTracking] self
+    #
+    def to_dose_tracking
+      self
+    end
+
+    # Encodes the DoseTracking object + any hiearchy of child objects,
+    # to a properly formatted RTPConnect ascii string.
+    #
+    # @return [String] an RTP string with a single or multiple lines/records
+    #
+    def to_s
+      str = encode
+      if children
+        children.each do |child|
+          str += child.to_s
+        end
+      end
+      return str
+    end
+
+    alias :to_str :to_s
+
+    # Sets the field_ids attribute.
+    #
+    # @note As opposed to the ordinary (string) attributes, this attribute
+    #   contains an array holding all 10 Field ID string values.
+    # @param [Array<nil, #to_s>] array the new attribute values
+    #
+    def field_ids=(array)
+      array = array.to_a
+      raise ArgumentError, "Invalid argument 'array'. Expected length 10, got #{array.length}." unless array.length == 10
+      @field_ids = array.collect! {|e| e && e.to_s}
+    end
+
+    # Sets the region_coeffs attribute.
+    #
+    # @note As opposed to the ordinary (string) attributes, this attribute
+    #   contains an array holding all 10 Region Coeff string values.
+    # @param [Array<nil, #to_s>] array the new attribute values
+    #
+    def region_coeffs=(array)
+      array = array.to_a
+      raise ArgumentError, "Invalid argument 'array'. Expected length 10, got #{array.length}." unless array.length == 10
+      @region_coeffs = array.collect! {|e| e && e.to_s}
+    end
+
+    # Sets the 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 new attribute value
+    # @raise [ArgumentError] if given an unexpected keyword
+    #
+    def keyword=(value)
+      value = value.to_s.upcase
+      raise ArgumentError, "Invalid keyword. Expected 'DOSE_DEF', got #{value}." unless value == "DOSE_DEF"
+      @keyword = value
+    end
+
+    # Sets the region_name attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def region_name=(value)
+      @region_name = value && value.to_s
+    end
+
+    # Sets the region_prior_dose attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def region_prior_dose=(value)
+      @region_prior_dose = value && value.to_s
+    end
+
+    # Sets the actual_dose attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def actual_dose=(value)
+      @actual_dose = value && value.to_s
+    end
+
+    # Sets the actual_fractions attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def actual_fractions=(value)
+      @actual_fractions = 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

data/lib/rtp-connect/extended_field.rb

@@ -2,10 +2,9 @@ module RTP
 
   # The ExtendedField class.
   #
-  # === Relations
-  #
-  # * Parent: Field
-  # * Children: none
+  # @note Relations:
+  #   * Parent: Field
+  #   * Children: none
   #
   class ExtendedField < Record
 
@@ -18,31 +17,29 @@ module RTP
 
     # Creates a new (treatment) ExtendedField by parsing a RTPConnect string line.
     #
-    # === Parameters
-    #
-    # * <tt>string</tt> -- A string containing an extended treatment field record.
-    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    # @param [#to_s] string the extended treatment field definition record string line
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
+    # @return [ExtendedField] the created ExtendedField instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
       # Get the quote-less values:
       values = string.to_s.values
       raise ArgumentError, "Invalid argument 'string': Expected exactly 6 elements, got #{values.length}." unless values.length == 6
-      f = self.new(parent)
+      ef = self.new(parent)
       # Assign the values to attributes:
-      f.keyword = values[0]
-      f.field_id = values[1]
-      f.original_plan_uid = values[2]
-      f.original_beam_number = values[3]
-      f.original_beam_name = values[4]
-      f.crc = values[5]
-      return f
+      ef.keyword = values[0]
+      ef.field_id = values[1]
+      ef.original_plan_uid = values[2]
+      ef.original_beam_number = values[3]
+      ef.original_beam_name = values[4]
+      ef.crc = values[5]
+      return ef
     end
 
     # Creates a new (treatment) ExtendedField.
     #
-    # === Parameters
-    #
-    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
       # Parent relation (may get more than one type of record here):
@@ -51,7 +48,13 @@ module RTP
       @keyword = 'EXTENDED_FIELD_DEF'
     end
 
-    # Returns true if the argument is an instance with attributes equal to self.
+    # 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_extended_field)
@@ -61,20 +64,28 @@ module RTP
 
     alias_method :eql?, :==
 
-    # Returns an empty array, as these instances are child-less by definition.
+    # Gives an empty array, as these instances are child-less by definition.
+    #
+    # @return [Array] an emtpy array
     #
     def children
       return Array.new
     end
 
-    # Generates a Fixnum hash value for this instance.
+    # 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 the values of this instance in an array.
-    # The values does not include the CRC.
+    # 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
       return [
@@ -88,13 +99,17 @@ module RTP
 
     # Returns self.
     #
+    # @return [ExtendedField] self
+    #
     def to_extended_field
       self
     end
 
-    # Writes the ExtendedField object + any hiearchy of child objects,
+    # Encodes the ExtendedField object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @return [String] an RTP string with a single or multiple lines/records
+    #
     def to_s
       str = encode
       if children
@@ -109,6 +124,10 @@ module RTP
 
     # Sets the 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 new attribute value
+    # @raise [ArgumentError] if given an unexpected keyword
+    #
     def keyword=(value)
       value = value.to_s.upcase
       raise ArgumentError, "Invalid keyword. Expected 'EXTENDED_FIELD_DEF', got #{value}." unless value == "EXTENDED_FIELD_DEF"
@@ -117,24 +136,32 @@ module RTP
 
     # 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 original_plan_uid attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def original_plan_uid=(value)
       @original_plan_uid = value && value.to_s
     end
 
     # Sets the original_beam_number attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def original_beam_number=(value)
       @original_beam_number = value && value.to_s
     end
 
     # Sets the original_beam_name attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def original_beam_name=(value)
       @original_beam_name = value && value.to_s
     end
@@ -143,7 +170,10 @@ module RTP
     private
 
 
-    # Returns the attributes of this instance in an array (for comparison purposes).
+    # 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
 

data/lib/rtp-connect/field.rb

@@ -2,10 +2,9 @@ module RTP
 
   # The treatment Field class.
   #
-  # === Relations
-  #
-  # * Parent: Prescription
-  # * Children: ExtendedField, ControlPoint
+  # @note Relations:
+  #   * Parent: Prescription
+  #   * Children: ExtendedField, ControlPoint
   #
   class Field < Record
 
@@ -65,10 +64,10 @@ module RTP
 
     # Creates a new (treatment) Field by parsing a RTPConnect string line.
     #
-    # === Parameters
-    #
-    # * <tt>string</tt> -- A string containing a treatment field record.
-    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    # @param [#to_s] string the treatment 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 Field instance
+    # @raise [ArgumentError] if given a string containing an invalid number of elements
     #
     def self.load(string, parent)
       # Get the quote-less values:
@@ -130,9 +129,7 @@ module RTP
 
     # Creates a new (treatment) Field.
     #
-    # === Parameters
-    #
-    # * <tt>parent</tt> -- A Record which is used to determine the proper parent of this instance.
+    # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
       # Child records:
@@ -144,7 +141,13 @@ module RTP
       @keyword = 'FIELD_DEF'
     end
 
-    # Returns true if the argument is an instance with attributes equal to self.
+    # 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_field)
@@ -156,30 +159,42 @@ module RTP
 
     # Adds a control point record to this instance.
     #
+    # @param [ControlPoint] child a ControlPoint instance which is to be associated with self
+    #
     def add_control_point(child)
       @control_points << child.to_control_point
     end
 
-    # Connects an extended treatment field record to this instance.
+    # Adds an extended treatment field record to this instance.
+    #
+    # @param [ExtendedField] child an ExtendedField instance which is to be associated with self
     #
     def add_extended_field(child)
       @extended_field = child.to_extended_field
     end
 
-    # Returns nil, as these instances are child-less by definition.
+    # Collects the child records of this instance in a properly sorted array.
+    #
+    # @return [Array<ExtendedField, ControlPoint>] a sorted array of self's child records
     #
     def children
       return [@extended_field, @control_points].flatten.compact
     end
 
-    # Generates a Fixnum hash value for this instance.
+    # 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 the values of this instance in an array.
-    # The values does not include the CRC.
+    # 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
       return [
@@ -236,13 +251,17 @@ module RTP
 
     # Returns self.
     #
+    # @return [Field] self
+    #
     def to_field
       self
     end
 
-    # Writes the Field object + any hiearchy of child objects,
+    # Encodes the Field object + any hiearchy of child objects,
     # to a properly formatted RTPConnect ascii string.
     #
+    # @return [String] an RTP string with a single or multiple lines/records
+    #
     def to_s
       str = encode
       if children
@@ -257,6 +276,10 @@ module RTP
 
     # Sets the 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 new attribute value
+    # @raise [ArgumentError] if given an unexpected keyword
+    #
     def keyword=(value)
       value = value.to_s.upcase
       raise ArgumentError, "Invalid keyword. Expected 'FIELD_DEF', got #{value}." unless value == "FIELD_DEF"
@@ -265,282 +288,376 @@ module RTP
 
     # 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 field_dose attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def field_dose=(value)
-      @field_dose = value && value.to_s
+      @field_dose = value && value.to_s.strip
     end
 
     # Sets the field_monitor_units attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def field_monitor_units=(value)
-      @field_monitor_units = value && value.to_s
+      @field_monitor_units = value && value.to_s.strip
     end
 
     # Sets the wedge_monitor_units attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def wedge_monitor_units=(value)
-      @wedge_monitor_units = value && value.to_s
+      @wedge_monitor_units = value && value.to_s.strip
     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 treatment_type attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def treatment_type=(value)
       @treatment_type = value && value.to_s
     end
 
     # Sets the modality attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def modality=(value)
       @modality = value && value.to_s
     end
 
     # Sets the energy attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def energy=(value)
       @energy = value && value.to_s
     end
 
     # Sets the time attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def time=(value)
-      @time = value && value.to_s
+      @time = value && value.to_s.strip
     end
 
     # Sets the doserate attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def doserate=(value)
-      @doserate = value && value.to_s
+      @doserate = 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
+      @sad = value && value.to_s.strip
     end
 
     # Sets the ssd attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def ssd=(value)
-      @ssd = value && value.to_s
+      @ssd = value && value.to_s.strip
     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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @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
+      @couch_pedestal = value && value.to_s.strip
     end
 
     # Sets the tolerance_table attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def tolerance_table=(value)
-      @tolerance_table = value && value.to_s
+      @tolerance_table = value && value.to_s.strip
     end
 
     # Sets the arc_direction attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def arc_direction=(value)
       @arc_direction = value && value.to_s
     end
 
     # Sets the arc_start_angle attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def arc_start_angle=(value)
-      @arc_start_angle = value && value.to_s
+      @arc_start_angle = value && value.to_s.strip
     end
 
     # Sets the arc_stop_angle attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def arc_stop_angle=(value)
-      @arc_stop_angle = value && value.to_s
+      @arc_stop_angle = value && value.to_s.strip
     end
 
     # Sets the arc_mu_degree attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def arc_mu_degree=(value)
-      @arc_mu_degree = value && value.to_s
+      @arc_mu_degree = value && value.to_s.strip
     end
 
     # Sets the wedge attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def wedge=(value)
       @wedge = value && value.to_s
     end
 
     # Sets the dynamic_wedge attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def dynamic_wedge=(value)
       @dynamic_wedge = value && value.to_s
     end
 
     # Sets the block attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def block=(value)
       @block = value && value.to_s
     end
 
     # Sets the compensator attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def compensator=(value)
       @compensator = value && value.to_s
     end
 
     # Sets the e_applicator attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def e_applicator=(value)
       @e_applicator = value && value.to_s
     end
 
     # Sets the e_field_def_aperture attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def e_field_def_aperture=(value)
       @e_field_def_aperture = value && value.to_s
     end
 
     # Sets the bolus attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def bolus=(value)
       @bolus = value && value.to_s
     end
 
     # Sets the portfilm_mu_open attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def portfilm_mu_open=(value)
       @portfilm_mu_open = value && value.to_s
     end
 
     # Sets the portfilm_coeff_open attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def portfilm_coeff_open=(value)
       @portfilm_coeff_open = value && value.to_s
     end
 
     # Sets the portfilm_delta_open attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def portfilm_delta_open=(value)
       @portfilm_delta_open = value && value.to_s
     end
 
     # Sets the portfilm_mu_treat attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def portfilm_mu_treat=(value)
       @portfilm_mu_treat = value && value.to_s
     end
 
     # Sets the portfilm_coeff_treat attribute.
     #
+    # @param [nil, #to_s] value the new attribute value
+    #
     def portfilm_coeff_treat=(value)
       @portfilm_coeff_treat = value && value.to_s
     end
@@ -549,7 +666,10 @@ module RTP
     private
 
 
-    # Returns the attributes of this instance in an array (for comparison purposes).
+    # 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