rtp-connect 1.6 → 1.11

data/lib/rtp-connect/site_setup.rb

@@ -9,7 +9,7 @@ module RTP
   class SiteSetup < Record
 
     # The Record which this instance belongs to.
-    attr_reader :parent
+    attr_accessor :parent
     attr_reader :rx_site_name
     attr_reader :patient_orientation
     attr_reader :treatment_machine
@@ -24,6 +24,15 @@ module RTP
     attr_reader :couch_longitudinal
     attr_reader :couch_angle
     attr_reader :couch_pedestal
+    attr_reader :table_top_vert_displacement
+    attr_reader :table_top_long_displacement
+    attr_reader :table_top_lat_displacement
+    attr_reader :mrl_coil_name
+    attr_reader :mrl_coil_index
+    attr_reader :couch_reference
+    attr_reader :couch_reference_index
+    attr_reader :respiratory_motion_compensation_technique
+    attr_reader :respiratory_signal_source
 
     # Creates a new SiteSetup by parsing a RTPConnect string line.
     #
@@ -33,31 +42,8 @@ module RTP
     # @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
-      low_limit = 5
-      high_limit = 16
-      raise ArgumentError, "Invalid argument 'string': Expected at least #{low_limit} elements, got #{values.length}." if values.length < low_limit
-      RTP.logger.warn "The number of elements (#{values.length}) for this SiteSetup record exceeds the known number of data items for this record (#{high_limit}). This may indicate an invalid record or that the RTP format has recently been expanded with new items." if values.length > high_limit
       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[-1]
-      return s
+      s.load(string)
     end
 
     # Creates a new SiteSetup.
@@ -65,10 +51,38 @@ module RTP
     # @param [Record] parent a record which is used to determine the proper parent of this instance
     #
     def initialize(parent)
+      super('SITE_SETUP_DEF', 5, 25)
       # Parent relation (always expecting a Prescription here):
       @parent = get_parent(parent.to_prescription, Prescription)
       @parent.add_site_setup(self)
-      @keyword = 'SITE_SETUP_DEF'
+      @attributes = [
+        # Required:
+        :keyword,
+        :rx_site_name,
+        :patient_orientation,
+        :treatment_machine,
+        # Optional:
+        :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,
+        :table_top_vert_displacement,
+        :table_top_long_displacement,
+        :table_top_lat_displacement,
+        :mrl_coil_name,
+        :mrl_coil_index,
+        :couch_reference,
+        :couch_reference_index,
+        :respiratory_motion_compensation_technique,
+        :respiratory_signal_source
+      ]
     end
 
     # Checks for equality.
@@ -105,48 +119,6 @@ module RTP
       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,
-        @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
-
-    # Encodes the SiteSetup 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
-
     # Returns self.
     #
     # @return [SiteSetup] self
@@ -155,18 +127,6 @@ module RTP
       self
     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 'SITE_SETUP_DEF', got #{value}." unless value == "SITE_SETUP_DEF"
-      @keyword = value
-    end
-
     # Sets the rx_site_name attribute.
     #
     # @param [nil, #to_s] value the new attribute value
@@ -279,6 +239,78 @@ module RTP
       @couch_pedestal = value && value.to_s.strip
     end
 
+    # Sets the table_top_vert_displacement attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def table_top_vert_displacement=(value)
+      @table_top_vert_displacement = value && value.to_s.strip
+    end
+
+    # Sets the table_top_long_displacement attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def table_top_long_displacement=(value)
+      @table_top_long_displacement = value && value.to_s.strip
+    end
+
+    # Sets the table_top_lat_displacement attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def table_top_lat_displacement=(value)
+      @table_top_lat_displacement = value && value.to_s.strip
+    end
+
+    # Sets the mrl_coil_name attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def mrl_coil_name=(value)
+      @mrl_coil_name = value && value.to_s.strip
+    end
+
+    # Sets the mrl_coil_index attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def mrl_coil_index=(value)
+      @mrl_coil_index = value && value.to_s.strip
+    end
+
+    # Sets the couch_reference attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_reference=(value)
+      @couch_reference = value && value.to_s.strip
+    end
+
+    # Sets the couch_reference_index attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def couch_reference_index=(value)
+      @couch_reference_index = value && value.to_s.strip
+    end
+
+    # Sets the respiratory_motion_compensation_technique attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def respiratory_motion_compensation_technique=(value)
+      @respiratory_motion_compensation_technique = value && value.to_s.strip
+    end
+
+    # Sets the respiratory_signal_source attribute.
+    #
+    # @param [nil, #to_s] value the new attribute value
+    #
+    def respiratory_signal_source=(value)
+      @respiratory_signal_source = value && value.to_s.strip
+    end
+
 
     private
 

data/lib/rtp-connect/version.rb

@@ -1,6 +1,6 @@
-module RTP
-
-  # The RTPConnect library version string.
-  VERSION = '1.6'
-
+module RTP
+
+  # The RTPConnect library version string.
+  VERSION = '1.11'
+
 end

data/rakefile.rb

@@ -16,7 +16,6 @@ require 'yard'
 gem_spec = eval(File.read('rtp-connect.gemspec'))
 Gem::PackageTask.new(gem_spec) do |pkg|
   pkg.gem_spec = gem_spec
-  #pkg.need_tar = true
 end
 
 # RSpec 2:

data/rtp-connect.gemspec

@@ -1,28 +1,28 @@
-# encoding: UTF-8
-
-require File.expand_path('../lib/rtp-connect/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = 'rtp-connect'
-  s.version = RTP::VERSION
-  s.date = Time.now
-  s.summary = 'Library for handling RTPConnect files.'
-  s.require_paths = ['lib']
-  s.author = 'Christoffer Lervag'
-  s.email = 'chris.lervag@gmail.com'
-  s.homepage = 'https://github.com/dicom/rtp-connect'
-  s.license = 'GPLv3'
-  s.description = 'RTPConnect is a file format used in radiotherapy for export & import of treatment planning data.'
-  s.files = Dir["{lib}/**/*", "[A-Z]*"]
-  s.rubyforge_project = 'rtp-connect'
-
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.add_development_dependency('bundler', '~> 1.3')
-  s.add_development_dependency('dicom', '~> 0.9.5')
-  s.add_development_dependency('mocha', '~> 0.13')
-  s.add_development_dependency('rake', '~> 0.9.6')
-  s.add_development_dependency('rspec', '~> 2.13')
-  s.add_development_dependency('yard', '~> 0.8.5')
+# encoding: UTF-8
+
+require File.expand_path('../lib/rtp-connect/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = 'rtp-connect'
+  s.version = RTP::VERSION
+  s.date = Time.now
+  s.summary = 'Library for handling RTPConnect files.'
+  s.require_paths = ['lib']
+  s.author = 'Christoffer Lervag'
+  s.email = 'chris.lervag@gmail.com'
+  s.homepage = 'https://github.com/dicom/rtp-connect'
+  s.license = 'GPL-3.0'
+  s.description = 'RTPConnect is a file format used in radiotherapy for export & import of treatment planning data.'
+  s.files = Dir["{lib}/**/*", "[A-Z]*"]
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_development_dependency('bundler', '~> 1.11')
+  s.add_development_dependency('dicom', '~> 0.9', '>= 0.9.8')
+  s.add_development_dependency('mocha', '~> 1.1')
+  s.add_development_dependency('rake', '~> 12.3')
+  s.add_development_dependency('redcarpet', '~> 3.4')
+  s.add_development_dependency('rspec', '~> 3.7')
+  s.add_development_dependency('yard', '~> 0.9', '>= 0.9.12')
 end

metadata

@@ -1,112 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: rtp-connect
 version: !ruby/object:Gem::Version
-  version: '1.6'
-  prerelease: 
+  version: '1.11'
 platform: ruby
 authors:
 - Christoffer Lervag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: dicom
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.8
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: 0.9.12
 description: RTPConnect is a file format used in radiotherapy for export & import
   of treatment planning data.
 email: chris.lervag@gmail.com
@@ -114,10 +127,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- COPYING
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/rtp-connect.rb
 - lib/rtp-connect/constants.rb
 - lib/rtp-connect/control_point.rb
 - lib/rtp-connect/dose_tracking.rb
 - lib/rtp-connect/extended_field.rb
+- lib/rtp-connect/extended_plan.rb
 - lib/rtp-connect/field.rb
 - lib/rtp-connect/logging.rb
 - lib/rtp-connect/methods.rb
@@ -130,41 +150,30 @@ files:
 - lib/rtp-connect/site_setup.rb
 - lib/rtp-connect/variables.rb
 - lib/rtp-connect/version.rb
-- lib/rtp-connect.rb
-- CHANGELOG.rdoc
-- COPYING
-- Gemfile
-- Gemfile.lock
 - rakefile.rb
-- README.rdoc
 - rtp-connect.gemspec
 homepage: https://github.com/dicom/rtp-connect
 licenses:
-- GPLv3
+- GPL-3.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -111446803
 requirements: []
-rubyforge_project: rtp-connect
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.6.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Library for handling RTPConnect files.
 test_files: []
-has_rdoc: