aixm 0.3.1 → 0.3.2

data/lib/aixm/feature/obstacle_group.rb

@@ -0,0 +1,104 @@
+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
+    #     name: String 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
+    #   )
+    #   obstacle_group.id              # UUID v3 calculated from the group payload
+    #
+    # As soon as an obstacle is added to a group, it's extended with new the
+    # following attributes:
+    # * group - the group this object belongs to
+    # * linked_to - obstacle this one is linked to (if any)
+    # * link_type - type of link between the two obstacles (if any)
+    #
+    # The source set on the group is handed down to each of it's obstacles and
+    # will be used there unless the individual obstacle overrides it with a
+    # different source of it's own.
+    #
+    # @see https://github.com/openflightmaps/ofmx/wiki/Obstacle
+    class ObstacleGroup < Feature
+      public_class_method :new
+
+      LINK_TYPES = {
+        CABLE: :cable,
+        SOLID: :solid,
+        OTHER: :other
+      }.freeze
+
+      # @return [String] group name
+      attr_reader :name
+
+      # @return [Array<AIXM::Feature::Obstacle>] obstacles in this group
+      attr_reader :obstacles
+
+      def initialize(source: nil, name: nil)
+        super(source: source)
+        self.name = name
+        @obstacles = []
+      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
+
+      # Add an obstacle to the group and optionally link it to another obstacle
+      # from the group.
+      #
+      # @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 group
+      #   * AIXM::Feature::Obstacle - link to this specific obstacle
+      # @param link_type [Symbol, nil] type of link (see {LINK_TYPES})
+      # @return [self]
+      def add_obstacle(obstacle, linked_to: nil, link_type: :other)
+        obstacle.extend AIXM::Feature::Obstacle::Grouped
+        obstacle.send(:group=, self)
+        if linked_to && link_type
+          obstacle.send(:linked_to=, linked_to == :previous ? @obstacles.last : linked_to)
+          obstacle.send(:link_type=, link_type)
+        end
+        @obstacles << obstacle
+        self
+      end
+
+      # @return [String] UUID version 3 group identifier
+      def id
+        ([name] + @obstacles.map { |o| o.xy.to_s }).to_uuid
+      end
+      alias_method :to_uid, :id   # features need "to_uid" for "==" to work
+
+      # @return [String] AIXM or OFMX markup
+      def to_xml
+        @obstacles.map { |o| o.to_xml }.join
+      end
+    end
+
+  end
+end

data/lib/aixm/refinements.rb

@@ -13,13 +13,6 @@ module AIXM
       "Ø" => "Oe"
     }.freeze
 
-    KM_FACTORS = {
-      km: 1,
-      m: 0.001,
-      nm: 1.852,
-      ft: 0.0003048
-    }.freeze
-
     # @!method to_digest
     #   Builds a 4 byte hex digest from the Array payload.
     #
@@ -35,6 +28,83 @@ module AIXM
       end
     end
 
+    # @!method to_uuid
+    #   Builds a UUID version 3 digest from the Array payload.
+    #
+    #   @example
+    #     ['foo', :bar, nil, [123]].to_uuid
+    #     # => "f3920098"
+    #
+    #   @note This is a refinement for +Array+
+    #   @return [String] UUID version 3
+    refine Array do
+      def to_uuid
+        ::Digest::MD5.hexdigest(flatten.map(&:to_s).join('|')).unpack("a8a4a4a4a12").join("-")
+      end
+    end
+
+
+    # @!method to_dms(padding=3)
+    #   Convert DD angle to DMS with the degrees zero padded to +padding+
+    #   length.
+    #
+    #   @example
+    #     43.22164444444445.to_dms(2)
+    #     # => "43°12'77.92\""
+    #     43.22164444444445.to_dms
+    #     # => "043°12'77.92\""
+    #
+    #   @note This is a refinement for +Float+
+    #   @param padding [Integer] number of digits for the degree part
+    #   @return [String] angle in DMS notation +{-}D°MM'SS.SS"+
+    refine Float do
+      def to_dms(padding=3)
+        degrees = self.abs.floor
+        minutes = ((self.abs - degrees) * 60).floor
+        seconds = (self.abs - degrees - minutes.to_f / 60) * 3600
+        minutes, seconds = minutes + 1, 0 if seconds.round(2) == 60
+        degrees, minutes = degrees + 1, 0 if minutes == 60
+        %Q(%s%0#{padding}d°%02d'%05.2f") % [
+          ('-' if self.negative?),
+          self.abs.truncate,
+          minutes.abs.truncate,
+          seconds.abs
+        ]
+      end
+    end
+
+    # @!method to_rad
+    #   Convert an angle from degree to radian.
+    #
+    #   @example
+    #     45.to_rad
+    #     # => 0.7853981633974483
+    #
+    #   @note This is a refinement for +Float+
+    #   @return [Float] radian angle
+    refine Float do
+      def to_rad
+        self * Math::PI / 180
+      end
+    end
+
+    # @!method trim
+    #   Convert whole numbers to Integer and leave all other untouched.
+    #
+    #   @example
+    #     3.0.trim
+    #     # => 3
+    #     3.3.trim
+    #     # => 3.3
+    #
+    #   @note This is a refinement for +Float+
+    #   @return [Integer, Float] converted Float
+    refine Float do
+      def trim
+        (self % 1).zero? ? self.to_i : self
+      end
+    end
+
     # @!method lookup(key_or_value, fallback=omitted=true)
     #   Fetch a value from the hash, but unlike +Hash#fetch+, if +key_or_value+
     #   is no hash key, check whether +key_or_value+ is a hash value and if so
@@ -79,32 +149,6 @@ module AIXM
       end
     end
 
-    # @!method uptrans
-    #   Upcase and transliterate to match the reduced character set for
-    #   AIXM names and titles.
-    #
-    #   See {UPTRANS_MAP} for supported diacryts and {UPTRANS_FILTER} for the
-    #   list of allowed characters in the returned value.
-    #
-    #   @example
-    #     "Nîmes-Alès".uptrans
-    #     # => "NIMES-ALES"
-    #     "Zürich".uptrans
-    #     # => "ZUERICH"
-    #
-    #   @note This is a refinement for +String+
-    #   @return [String] upcased and transliterated String
-    refine String do
-      def uptrans
-        self.dup.tap do |string|
-          string.upcase!
-          string.gsub!(/(#{UPTRANS_MAP.keys.join('|')})/, UPTRANS_MAP)
-          string.unicode_normalize!(:nfd)
-          string.gsub!(UPTRANS_FILTER, '')
-        end
-      end
-    end
-
     # @!method to_dd
     #   Convert DMS angle to DD or +nil+ if the notation is not recognized.
     #
@@ -129,85 +173,44 @@ module AIXM
       end
     end
 
-    # @!method trim
-    #   Convert whole numbers to Integer and leave all other untouched.
-    #
-    #   @example
-    #     3.0.trim
-    #     # => 3
-    #     3.3.trim
-    #     # => 3.3
-    #
-    #   @note This is a refinement for +Float+
-    #   @return [Integer, Float] converted Float
-    refine Float do
-      def trim
-        (self % 1).zero? ? self.to_i : self
-      end
-    end
-
-    # @!method to_rad
-    #   Convert an angle from degree to radian.
+    # @!method to_time
+    #   Parse string to date and time.
     #
     #   @example
-    #     45.to_rad
-    #     # => 0.7853981633974483
+    #     '2018-01-01 15:00'.to_time
+    #     # => 2018-01-01 15:00:00 +0100
     #
-    #   @note This is a refinement for +Float+
-    #   @return [Float] radian angle
-    refine Float do
-      def to_rad
-        self * Math::PI / 180
+    #   @note This is a refinement for +String+
+    #   @return [Time] date and time
+    refine String do
+      def to_time
+        Time.parse(self)
       end
     end
 
-    # @!method to_dms(padding=3)
-    #   Convert DD angle to DMS with the degrees zero padded to +padding+
-    #   length.
-    #
-    #   @example
-    #     43.22164444444445.to_dms(2)
-    #     # => "43°12'77.92\""
-    #     43.22164444444445.to_dms
-    #     # => "043°12'77.92\""
+    # @!method uptrans
+    #   Upcase and transliterate to match the reduced character set for
+    #   AIXM names and titles.
     #
-    #   @note This is a refinement for +Float+
-    #   @param padding [Integer] number of digits for the degree part
-    #   @return [String] angle in DMS notation +{-}D°MM'SS.SS"+
-    refine Float do
-      def to_dms(padding=3)
-        degrees = self.abs.floor
-        minutes = ((self.abs - degrees) * 60).floor
-        seconds = (self.abs - degrees - minutes.to_f / 60) * 3600
-        minutes, seconds = minutes + 1, 0 if seconds.round(2) == 60
-        degrees, minutes = degrees + 1, 0 if minutes == 60
-        %Q(%s%0#{padding}d°%02d'%05.2f") % [
-          ('-' if self.negative?),
-          self.abs.truncate,
-          minutes.abs.truncate,
-          seconds.abs
-        ]
-      end
-    end
-
-    # @!method to_km(from:)
-    #   Convert a distance from the source unit +from+ to kilometers.
+    #   See {UPTRANS_MAP} for supported diacryts and {UPTRANS_FILTER} for the
+    #   list of allowed characters in the returned value.
     #
     #   @example
-    #     10.to_km(from: :nm)
-    #     # => 18.52
-    #     10.to_km(from: :foobar)
-    #     # => ArgumentError
+    #     "Nîmes-Alès".uptrans
+    #     # => "NIMES-ALES"
+    #     "Zürich".uptrans
+    #     # => "ZUERICH"
     #
-    #   @note This is a refinement for +Float+
-    #   @param from [Symbol] source unit (see {KM_FACTORS})
-    #   @raise [ArgumentError] if the specified unit is not supported
-    #   @return [Float] value converted to kilometers
-    refine Float do
-      def to_km(from:)
-        self * KM_FACTORS.fetch(from.downcase.to_sym)
-      rescue KeyError
-        raise(ArgumentError, "unit `#{from}' not supported")
+    #   @note This is a refinement for +String+
+    #   @return [String] upcased and transliterated String
+    refine String do
+      def uptrans
+        self.dup.tap do |string|
+          string.upcase!
+          string.gsub!(/(#{UPTRANS_MAP.keys.join('|')})/, UPTRANS_MAP)
+          string.unicode_normalize!(:nfd)
+          string.gsub!(UPTRANS_FILTER, '')
+        end
       end
     end
   end

data/lib/aixm/shortcuts.rb

@@ -4,6 +4,7 @@ module AIXM
     document: Document,
     xy: XY,
     z: Z,
+    d: D,
     f: F,
     organisation: Feature::Organisation,
     unit: Feature::Unit,
@@ -26,6 +27,8 @@ module AIXM
     tacan: Feature::NavigationalAid::TACAN,
     ndb: Feature::NavigationalAid::NDB,
     vor: Feature::NavigationalAid::VOR,
+    obstacle: Feature::Obstacle,
+    obstacle_group: Feature::ObstacleGroup,
     timetable: Component::Timetable
   }.freeze
 

data/lib/aixm/version.rb

@@ -1,3 +1,3 @@
 module AIXM
-  VERSION = "0.3.1".freeze
+  VERSION = "0.3.2".freeze
 end

data/lib/aixm/xy.rb

@@ -68,19 +68,20 @@ module AIXM
       other.is_a?(self.class) && lat == other.lat && long == other.long
     end
 
-    # @return [Float] distance in meters as calculated by use of the Haversine formula
+    # @return [AIXM::D] distance as calculated by use of the Haversine formula
     def distance(other)
       if self == other
-        0
+        AIXM.d(0, :m)
       else
-        2 * EARTH_RADIUS * Math.asin(
+        value = 2 * EARTH_RADIUS * Math.asin(
           Math.sqrt(
             Math.sin((other.lat.to_rad - lat.to_rad) / 2) ** 2 +
               Math.cos(lat.to_rad) * Math.cos(other.lat.to_rad) *
               Math.sin((other.long.to_rad - long.to_rad) / 2) ** 2
           )
         )
-      end.round
+        AIXM.d(value.round, :m)
+      end
     end
 
     private

data/lib/aixm/z.rb

@@ -5,8 +5,8 @@ module AIXM
   # Height, elevation or altitude
   #
   # @example
-  #   AIXM.z(1000, :qfe)   # height: 1000 ft above ground
-  #   AIXM.z(2000, :qnh)   # elevation or altitude: 2000 ft above mean sea level
+  #   AIXM.z(1000, :qfe)   # height (ft): 1000 ft above ground
+  #   AIXM.z(2000, :qnh)   # elevation or altitude (ft): 2000 ft above mean sea level
   #   AIXM.z(45, :qne)     # altitude: flight level 45
   #
   # ===Shortcuts:
@@ -15,7 +15,7 @@ module AIXM
   class Z
     CODES = %i(qfe qnh qne).freeze
 
-    # @return [Integer] elevation or altitude value
+    # @return [Integer] altitude or elevation value
     attr_reader :alt
 
     # @return [Symbol] Q code - either +:qfe+ (height in feet), +:qnh+ (altitude in feet or +:qne+ (altitude as flight level)

data/spec/factory.rb

@@ -12,6 +12,10 @@ module AIXM
         AIXM.z(1000, :qnh)
       end
 
+      def d
+        AIXM.d(123, :m)
+      end
+
       def f
         AIXM.f(123.35, :mhz)
       end
@@ -69,7 +73,7 @@ module AIXM
         AIXM.geometry.tap do |geometry|
           geometry << AIXM.circle(
             center_xy: AIXM.xy(lat: %q(47°35'00"N), long: %q(004°53'00"E)),
-            radius: 10
+            radius: AIXM.d(10, :km)
           )
         end
       end
@@ -313,8 +317,8 @@ module AIXM
 
       def runway
         AIXM.runway(name: '16L/34R').tap do |runway|
-          runway.length = 650
-          runway.width = 80
+          runway.length = AIXM.d(650, :m)
+          runway.width = AIXM.d(80, :m)
           runway.composition = :graded_earth
           runway.status = :closed
           runway.remarks = "Markings eroded"
@@ -335,14 +339,110 @@ module AIXM
         AIXM.helipad(name: 'H1').tap do |helipad|
           helipad.xy = AIXM.xy(lat: %q(43°59'56.94"N), long: %q(004°45'05.56"E))
           helipad.z = AIXM.z(141, :qnh)
-          helipad.length = 20
-          helipad.width = 20
+          helipad.length = AIXM.d(20, :m)
+          helipad.width = AIXM.d(20, :m)
           helipad.composition = :grass
           helipad.status = :other
           helipad.remarks = "Authorizaton by AD operator required"
         end
       end
 
+      # Obstacle
+
+      def obstacle
+        AIXM.obstacle(
+          name: "Eiffel Tower",
+          type: :tower,
+          xy: AIXM.xy(lat: %q(48°51'29.7"N), long: %q(002°17'40.52"E)),
+          radius: AIXM.d(88, :m),
+          z: AIXM.z(1187 , :qnh)
+        ).tap do |obstacle|
+          obstacle.lighting = true
+          obstacle.lighting_remarks = "red strobes"
+          obstacle.marking = nil
+          obstacle.marking_remarks = nil
+          obstacle.height = AIXM.d(324, :m)
+          obstacle.xy_accuracy = AIXM.d(2, :m)
+          obstacle.z_accuracy = AIXM.d(1, :m)
+          obstacle.height_accurate = true
+          obstacle.valid_from = Time.parse('2018-01-01 12:00:00 +0100')
+          obstacle.valid_until = Time.parse('2019-01-01 12:00:00 +0100')
+          obstacle.remarks = "Temporary light installations (white strobes, gyro light etc)"
+        end
+      end
+
+      def unlinked_obstacle_group
+        AIXM.obstacle_group(
+          name: "Mirmande éoliennes"
+        ).tap do |obstacle_group|
+          obstacle_group.add_obstacle(
+            AIXM.obstacle(
+              name: "La Teissonière 1",
+              type: :wind_turbine,
+              xy: AIXM.xy(lat: %q(44°40'30.05"N), long: %q(004°52'21.24"E)),
+              radius: AIXM.d(80, :m),
+              z: AIXM.z(1764, :qnh)
+            ).tap do |obstacle|
+              obstacle.height = AIXM.d(80, :m)
+              obstacle.xy_accuracy = AIXM.d(50, :m)
+              obstacle.z_accuracy = AIXM.d(10, :m)
+              obstacle.height_accurate = false
+            end
+          )
+          obstacle_group.add_obstacle(
+            AIXM.obstacle(
+              name: "La Teissonière 2",
+              type: :wind_turbine,
+              xy: AIXM.xy(lat: %q(44°40'46.08"N), long: %q(004°52'25.72"E)),
+              radius: AIXM.d(80, :m),
+              z: AIXM.z(1738 , :qnh)
+            ).tap do |obstacle|
+              obstacle.height = AIXM.d(80, :m)
+              obstacle.xy_accuracy = AIXM.d(50, :m)
+              obstacle.z_accuracy = AIXM.d(10, :m)
+              obstacle.height_accurate = false
+            end
+          )
+        end
+      end
+
+      def linked_obstacle_group
+        AIXM.obstacle_group(
+          name: "Droitwich longwave antenna"
+        ).tap do |obstacle_group|
+          obstacle_group.add_obstacle(
+            AIXM.obstacle(
+              name: "Droitwich LW north",
+              type: :mast,
+              xy: AIXM.xy(lat: %q(52°17'47.03"N), long: %q(002°06'24.31"W)),
+              radius: AIXM.d(200, :m),
+              z: AIXM.z(848 , :qnh)
+            ).tap do |obstacle|
+              obstacle.height = AIXM.d(700, :ft)
+              obstacle.xy_accuracy = AIXM.d(0, :m)
+              obstacle.z_accuracy = AIXM.d(0, :ft)
+              obstacle.height_accurate = true
+            end
+          )
+          obstacle_group.add_obstacle(
+            AIXM.obstacle(
+              name: "Droitwich LW north",
+              type: :mast,
+              xy: AIXM.xy(lat: %q(52°17'40.48"N), long: %q(002°06'20.47"W)),
+              radius: AIXM.d(200, :m),
+              z: AIXM.z(848 , :qnh)
+            ).tap do |obstacle|
+              obstacle.height = AIXM.d(700, :ft)
+              obstacle.xy_accuracy = AIXM.d(0, :m)
+              obstacle.z_accuracy = AIXM.d(0, :ft)
+              obstacle.height_accurate = true
+            end,
+            linked_to: :previous,
+            link_type: :cable
+          )
+        end
+      end
+
       # Document
 
       def document
@@ -366,6 +466,9 @@ module AIXM
           document.features << vor
           document.features << vordme
           document.features << vortac
+          document.features << obstacle
+          document.features << unlinked_obstacle_group
+          document.features << linked_obstacle_group
         end
       end