SettRaziel/ruby_visualization

module TerminalVis

  # {MetaData::MetaData} stores meta information about the data series. The
  # meta information can be used for two or three dimensional data series. Each
  # {MetaData::DataDomain} stores the information for one dimension
  #   two dimensional data set
  #   <data_name>,
  #   <axis_description_x>,<lower_boundary_x>,<upper_boundary_x>,
  #   <axis_description_y>,<lower_boundary_y>,<upper_boundary_y>
  #
  #   three dimensional data series
  #   <data_name>,
  #   <axis_description_x>,<lower_boundary_x>,<upper_boundary_x>,
  #   <axis_description_y>,<lower_boundary_y>,<upper_boundary_y>,
  #   <axis_description_z>,<lower_boundary_z>,<upper_boundary_z>
  module MetaData

    # {MetaData::DataDomain} represents the meta data for one dimension
    # @raise [ArgumentError] if parsing of attribute values fails
    class DataDomain
      # @return [String] name of the data
      attr_reader :name
      # @return [Float] lower boundary of the dimension
      attr_reader :lower
      # @return [Float] upper boundary of the dimension
      attr_reader :upper
      # @return [Float] step range between two values
      attr_reader :step

      # initialization
      # @param [String] name the name of the data
      # @param [String] lower the lower boundary of the dimension
      # @param [String] upper the upper boundary of the dimension
      # @param [String] step the step range between two values
      # @raise [ArgumentError] when one of the parameters is not a number
      def initialize(name, lower, upper, step)
        @name = name
        begin
          @lower = Float(lower)
          @upper = Float(upper)
          @step = Float(step)
        rescue ArgumentError
          raise ArgumentError,
                " Error in data domain: received non number argument for boundaries.".red
        end
      end

      # method to get the number of data values specified by the values of the
      # domain object
      # @return [Integer] the number of data values
      def number_of_values
        Integer((@upper - @lower) / @step) + 1
      end

      # method to get the coordinate to a given index
      # @param [Integer] index the given index
      # @return [Float] the coordinate
      # @raise [RangeError] if the index creates a coordinate that lies out of
      #  the domain range
      def get_coordinate_to_index(index)
        coordinate = lower + index * step
        if (coordinate < lower || coordinate > upper)
          raise RangeError,
          " Error: #{index} creates coordinate #{coordinate} that lies out of range".red
        end
        return coordinate
      end

    end

  end

end