ruby_tdms 2.0.0

data/lib/ruby_tdms/channel_enumerator.rb

@@ -0,0 +1,33 @@
+module RubyTDMS
+	class ChannelEnumerator
+		include Enumerable
+
+
+		def initialize(channel)
+			@channel = channel
+		end
+
+
+		def size
+			@size ||= @channel.value_count
+		end
+
+
+		def each
+			0.upto(size - 1) { |i| yield self[i] }
+		end
+
+
+		def [](i)
+			if (i < 0) || (i >= size)
+				raise RangeError, 'Channel %s has a range of 0 to %d, got invalid index: %d' % [@channel.path, size - 1, i]
+			end
+
+			chunk_index = i / @channel.chunk_value_count
+
+			offset = (@channel.raw_data_offset + (@channel.chunk_length * chunk_index)) + (i * @channel.value_offset)
+			@channel.stream.seek offset
+			@channel.data_type.read_from_stream(@channel.stream, @channel.segment.big_endian?).value
+		end
+	end
+end

data/lib/ruby_tdms/data_types.rb

@@ -0,0 +1,22 @@
+require 'require_all'
+require_rel 'data_types'
+
+module RubyTDMS
+	module DataTypes
+		class << self
+			def find_by_id(id)
+				TYPES_BY_ID[id] || raise(ArgumentError, "No matching type for ID #{id.inspect}")
+			end
+
+
+			def to_hash
+				Base.subclasses.reduce({}) do |result, klass|
+					result[klass::ID] = klass
+					result
+				end
+			end
+		end
+
+		TYPES_BY_ID = to_hash.freeze
+	end
+end

data/lib/ruby_tdms/data_types/base.rb

@@ -0,0 +1,19 @@
+module RubyTDMS
+	module DataTypes
+		class Base
+			attr_accessor :value
+
+
+			def initialize(value = nil)
+				@value = value
+			end
+
+
+			class << self
+				def subclasses
+					ObjectSpace.each_object(singleton_class).select { |klass| klass < self }
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/boolean.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Boolean < Base
+			ID = 0x21
+			LENGTH_IN_BYTES = 1
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				new tdms_file.read_bool
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/double.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Double < Base
+			ID = 0x0A
+			LENGTH_IN_BYTES = 8
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_double_be
+				else
+					new tdms_file.read_double
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/double_with_unit.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class DoubleWithUnit < Base
+			ID = 0x1A
+			LENGTH_IN_BYTES = 8
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_double_be
+				else
+					new tdms_file.read_double
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/int16.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Int16 < Base
+			ID = 0x02
+			LENGTH_IN_BYTES = 2
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_i16_be
+				else
+					new tdms_file.read_i16
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/int32.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Int32 < Base
+			ID = 0x03
+			LENGTH_IN_BYTES = 4
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_i32_be
+				else
+					new tdms_file.read_i32
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/int64.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Int64 < Base
+			ID = 0x04
+			LENGTH_IN_BYTES = 8
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_i64_be
+				else
+					new tdms_file.read_i64
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/int8.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Int8 < Base
+			ID = 0x01
+			LENGTH_IN_BYTES = 1
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				new tdms_file.read_i8
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/single.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Single < Base
+			ID = 0x09
+			LENGTH_IN_BYTES = 4
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_single_be
+				else
+					new tdms_file.read_single
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/single_with_unit.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class SingleWithUnit < Base
+			ID = 0x19
+			LENGTH_IN_BYTES = 4
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_single_be
+				else
+					new tdms_file.read_single
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/string.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class String < Base
+			ID = 0x20
+			LENGTH_IN_BYTES = nil
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				new tdms_file.read_utf8_string
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/timestamp.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class Timestamp < Base
+			ID = 0x44
+			LENGTH_IN_BYTES = 16
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				new tdms_file.read_timestamp
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/u_int16.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class UInt16 < Base
+			ID = 0x06
+			LENGTH_IN_BYTES = 2
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_u16_be
+				else
+					new tdms_file.read_u16
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/u_int32.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class UInt32 < Base
+			ID = 0x07
+			LENGTH_IN_BYTES = 4
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_u32_be
+				else
+					new tdms_file.read_u32
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/u_int64.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class UInt64 < Base
+			ID = 0x08
+			LENGTH_IN_BYTES = 8
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				if big_endian
+					new tdms_file.read_u64_be
+				else
+					new tdms_file.read_u64
+				end
+			end
+		end
+	end
+end

data/lib/ruby_tdms/data_types/u_int8.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module RubyTDMS
+	module DataTypes
+		class UInt8 < Base
+			ID = 0x05
+			LENGTH_IN_BYTES = 1
+
+
+			def self.read_from_stream(tdms_file, big_endian)
+				new tdms_file.read_u8
+			end
+		end
+	end
+end

data/lib/ruby_tdms/document.rb

@@ -0,0 +1,105 @@
+require 'coalesce'
+require_relative 'objects/channel'
+require_relative 'segment'
+
+module RubyTDMS
+	class Document
+		#attr_reader :segments, :channels, :file
+		attr_reader :segments, :stream
+
+
+		def initialize(stream)
+			@channel_aggregates = []
+			@segments = []
+			@stream = stream
+
+			parse_segments
+			build_aggregates
+		end
+
+
+		def channels
+			@channel_aggregates
+		end
+
+
+		def groups
+			objects.select { |object| object.is_a? Objects::Group }
+		end
+
+
+		def objects
+			segments.flat_map { |segment| segment.objects }
+		end
+
+
+		# @return [Array<TDMS::Objects::Channel>] The un-aggregated channel objects in the current document.
+		def raw_channels
+			objects.select { |object| object.is_a? Objects::Channel }
+		end
+
+
+		# Returns a hash representation of the entire TDMS document, looking vaguely like:
+		# {
+		# file : [
+		# 	properties: {}
+		# ],
+		# 	groups : [
+		# 	{
+		# 		path: '/Time Domain',
+		# 		properties: {}
+		#
+		# 	}
+		# ],
+		# 	channels : [
+		# 	{
+		# 		path: '/Time Domain/Current Phase A',
+		# 		name: 'Current Phase A',
+		# 		properties: { 'wf_start': 2015-05-23 05:22:22 },
+		# 		values: [
+		# 			1,
+		# 			2,
+		# 			3,
+		# 			4,
+		# 			5
+		# 		]
+		# 	}
+		# ]
+		# }
+		def as_json
+			{
+				file: objects.find { |object| object.is_a? Objects::File }.as_json,
+				groups: objects.select { |object| object.is_a? Objects::Group }.map(&:as_json),
+				channels: channels.map(&:as_json)
+			}
+		end
+
+
+		protected
+
+		def parse_segments
+			until stream.eof?
+				segment = Segment.parse_stream(stream, self)
+				break if segment.nil?
+				#@segments << segment
+				next_segment_offset = segment.meta_data_offset._?(segment.raw_data_offset) + segment.length
+				stream.seek next_segment_offset
+			end
+		end
+
+
+		def build_aggregates
+			channels_by_path =
+				raw_channels.reduce({}) do |hash, channel|
+					hash[channel.path] ||= []
+					hash[channel.path] << channel
+					hash
+				end
+
+			channels_by_path.each_pair do |path, channels|
+				@channel_aggregates << AggregateChannel.new(channels)
+			end
+		end
+	end
+
+end