Contents

require 'ms/cv/paramable'
require 'ms/mzml/data_array'

module MS
  class Mzml
    module DataArrayContainerLike
      include MS::CV::Paramable

      ###########################################
      # ATTRIBUTES
      ###########################################

      # (required) the spectrum id matching this general pattern: \S+=\S+( \S+=\S+)*)
      attr_accessor :id

      # (required [at xml write time]) the index in the spectrum list
      attr_accessor :index

      # (optional) an MS::Mzml::DataProcessing object
      attr_accessor :data_processing

      ###########################################
      # SUBELEMENTS
      ###########################################

      # (optional) an array of MS::Mzml::DataArray
      attr_accessor :data_arrays

      def initialize(id, opts={params: []})
        @id = id
        describe!(*opts[:params])
      end

      def default_array_length
        @data_arrays ? @data_arrays.first.size : 0
      end

      # see SpectrumList for generating the entire list
      # the opt key :sub_elements can be used to pass in subelements whose
      # to_xml methods will be called.
      def to_xml(builder, opts={}, &block)
        atts = {id: @id, index: @index, defaultArrayLength: default_array_length}
        atts[:dataProcessingRef] = @data_processing.id if @data_processing
        atts.merge!(opts)
        raise "#{self.class} object must have index at xml writing time!" unless atts[:index] 

        builder.spectrum(atts) do |sp_n|
          super(sp_n) # params
          block.call(sp_n) if block
          MS::Mzml::DataArray.list_xml(@data_arrays, sp_n) if @data_arrays
        end
        builder
      end

    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
mspire-0.6.12	lib/ms/mzml/data_array_container_like.rb
mspire-0.6.11	lib/ms/mzml/data_array_container_like.rb
mspire-0.6.9	lib/ms/mzml/data_array_container_like.rb