svoop/aixm

using AIXM::Refinements

module AIXM
  class Feature

    # Groups of obstacles which consist of either linked (e.g. power line
    # towers) or unlinked (e.g. wind turbines) members.
    #
    # ===Cheat Sheet in Pseudo Code:
    #   obstacle_group = AIXM.obstacle_group(
    #     source: String or nil        # see remarks below
    #     region: String or nil
    #     name: String or nil
    #   )
    #   obstacle_group.xy_accuracy = AIXM.d or nil
    #   obstacle_group.z_accuracy = AIXM.d or nil
    #   obstacle_group.remarks = String or nil
    #   obstacle_group.comment = Object or nil
    #   obstacle_group.add_obstacle(   # add an obstacle to the group
    #     AIXM.obstacle
    #   )
    #   obstacle_group.add_obstacle(   # add an obstacle to the group and link
    #     AIXM.obstacle,               # it to the obstacle last added to the group
    #     linked_to: :previous,
    #     link_type: LINK_TYPES
    #   )
    #   obstacle_group.add_obstacle(   # add an obstacle to the group and link
    #     AIXM.obstacle,               # it to any obstacle already in the group
    #     linked_to: AIXM.obstacle,
    #     link_type: LINK_TYPES
    #   )
    #
    # Please note: As soon as an obstacle is added to an obstacle group, the
    # +xy_accuracy+ and +z_accuracy+ of the obstacle group overwrite whatever
    # is set on the individual obstacles. On the other hand, if the obstacle
    # group has no +source+ set, it will inherit this value from the first
    # obstacle in the group.
    #
    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Obstacle
    class ObstacleGroup < Feature
      include AIXM::Concerns::Association
      include AIXM::Concerns::Remarks

      public_class_method :new

      # @!method obstacles
      #   @return [Array<AIXM::Feature::Obstacle>] obstacles in this obstacle group
      #
      # @!method add_obstacle(obstacle, linked_to: nil, link_type: nil)
      #   @param obstacle [AIXM::Feature::Obstacle] obstacle instance
      #   @param linked_to [Symbol, AIXM::Feature::Obstacle, nil] Either:
      #     * :previous - link to the obstacle last added to the obstacle group
      #     * AIXM::Feature::Obstacle - link to this specific obstacle
      #   @param link_type [Symbol, nil] type of link (see
      #     {AIXM::Feature::Obstacle::LINK_TYPES})
      #   @return [self]
      has_many :obstacles do |obstacle, linked_to: nil, link_type: nil|
        if linked_to
          obstacle.send(:linked_to=, linked_to == :previous ? @obstacles.last : linked_to)
          obstacle.send(:link_type=, (link_type || :other))
        end
      end

      # @!method source
      #   @return [String] reference to source of the feature data
      #
      # @!method name
      #   @return [String] obstacle group name
      #
      # @!method xy_accuracy
      #   @return [AIXM::D, nil] margin of error for circular base center point
      #
      # @!method z_accuracy
      #   @return [AIXM::D, nil] margin of error for top point
      %i(source name xy_accuracy z_accuracy).each do |method|
        define_method method do
          instance_variable_get(:"@#{method}") || obstacles.first&.send(method)
        end
      end

      # See the {cheat sheet}[AIXM::Feature::ObstacleGroup] for examples on how
      # to create instances of this class.
      def initialize(source: nil, region: nil, name: nil)
        super(source: source, region: region)
        self.name = name
      end

      # @return [String]
      def inspect
        %Q(#<#{self.class} #{obstacles.count} obstacle(s)>)
      end

      def name=(value)
        fail(ArgumentError, "invalid name") unless value.nil? || value.is_a?(String)
        @name = value&.uptrans
      end

      def xy_accuracy=(value)
        fail(ArgumentError, "invalid xy accuracy") unless value.nil? || value.is_a?(AIXM::D)
        @xy_accuracy = value
      end

      def z_accuracy=(value)
        fail(ArgumentError, "invalid z accuracy") unless value.nil? || value.is_a?(AIXM::D)
        @z_accuracy = value
      end

      # @!visibility private
      def add_uid_to(builder)
        builder.OgrUid({ region: (region if AIXM.ofmx?) }.compact) do |ogr_uid|
          ogr_uid.txtName(name)
          ogr_uid.geoLat(obstacles.first.xy.lat(AIXM.schema))
          ogr_uid.geoLong(obstacles.first.xy.long(AIXM.schema))
        end
      end

      # @!visibility private
      def add_to(builder)
        if AIXM.ofmx?
          builder.comment "Obstacle group: #{name}".dress
          builder.text "\n"
          builder.Ogr({ source: (source if AIXM.ofmx?) }.compact) do |ogr|
            ogr.comment(indented_comment) if comment
            add_uid_to(ogr)
            ogr.codeDatum('WGE')
            if xy_accuracy
              ogr.valGeoAccuracy(xy_accuracy.dim.trim)
              ogr.uomGeoAccuracy(xy_accuracy.unit.upcase)
            end
            if z_accuracy
              ogr.valElevAccuracy(z_accuracy.to_ft.dim.round)
              ogr.uomElevAccuracy('FT')
            end
            ogr.txtRmk(remarks) if remarks
          end
        end
        obstacles.each do |obstacle|
          obstacle.add_to(builder, delegate: false)
        end
      end
    end

  end
end