aixm 0.3.3 → 0.3.4

data/lib/aixm/component/surface.rb

@@ -0,0 +1,121 @@
+using AIXM::Refinements
+
+module AIXM
+  class Component
+
+    # Surface of a runway, helipad etc
+    #
+    # ===Cheat Sheet in Pseudo Code:
+    #   surface = AIXM.surfaceservice(
+    #     composition: COMPOSITIONS or nil
+    #     preparation: PREPARATIONS or nil
+    #     condition: CONDITIONS or nil
+    #   )
+    #   surface.pcn = String
+    #   surface.remarks = String or nil
+    #
+    # ===Constants:
+    # * +AIXM::PCN_RE+ - regular expression to match PCN notations
+    #
+    #
+    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#rwy-runway
+    class Surface
+      COMPOSITIONS = {
+        ASPH: :asphalt,
+        BITUM: :bitumen,        # dug up, bound and rolled ground
+        CONC: :concrete,
+        GRADE: :graded_earth,   # graded or rolled earth possibly with some grass
+        GRASS: :grass,          # lawn
+        GRAVE: :gravel,         # small and midsize rounded stones
+        MACADAM: :macadam,      # small rounded stones
+        SAND: :sand,
+        WATER: :water,
+        OTHER: :other           # specify in remarks
+      }
+
+      PREPARATIONS = {
+        AFSC: :aggregate_friction_seal_coat,
+        GROOVED: :grooved,      # cut or plastic grooved
+        NATURAL: :natural,      # no treatment
+        OILED: :oiled,
+        PAVED: :paved,
+        PFC: :porous_friction_course,
+        RFSC: :rubberized_friction_seal_coat,
+        ROLLED: :rolled,
+        OTHER: :other
+      }
+
+      CONDITIONS = {
+        GOOD: :good,
+        FAIR: :fair,
+        POOR: :poor,
+        OTHER: :other
+      }
+
+      # @return [Symbol, nil] composition of the surface (see {COMPOSITIONS})
+      attr_reader :composition
+
+      # @return [Symbol, nil] preparation of the surface (see {PREPARATIONS})
+      attr_reader :preparation
+
+      # @return [Symbol, nil] condition of the surface (see {CONDITIONS})
+      attr_reader :condition
+
+      # @return [String, nil] free text remarks
+      attr_reader :remarks
+
+      def initialize
+        @pcn = {}
+      end
+
+      # @return [String]
+      def inspect
+        %Q(#<#{self.class} composition=#{composition.inspect} preparation=#{preparation.inspect} condition=#{condition.inspect} pcn=#{pcn.inspect}>)
+      end
+
+      def composition=(value)
+        @composition = value.nil? ? nil : COMPOSITIONS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid composition")
+      end
+
+      def preparation=(value)
+        @preparation = value.nil? ? nil : PREPARATIONS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid preparation")
+      end
+
+      def condition=(value)
+        @condition = value.nil? ? nil : CONDITIONS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid condition")
+      end
+
+      # @return [String, nil] pavement classification number (e.g. "59/F/A/W/T")
+      def pcn
+        @pcn.none? ? nil : @pcn.values.join("/")
+      end
+
+      def pcn=(value)
+        return @pcn = {} if value.nil?
+        fail(ArgumentError, "invalid PCN") unless match = value.to_s.upcase.match(PCN_RE)
+        @pcn = match.named_captures.reject{ |k| k == 'pcn' }
+      end
+
+      def remarks=(value)
+        @remarks = value&.to_s
+      end
+
+      # @return [String] AIXM or OFMX markup
+      def to_xml
+        builder = Builder::XmlMarkup.new(indent: true)
+        builder.codeComposition(COMPOSITIONS.key(composition).to_s) if composition
+        builder.codePreparation(PREPARATIONS.key(preparation).to_s) if preparation
+        builder.codeCondSfc(CONDITIONS.key(condition).to_s) if condition
+        if pcn
+          builder.valPcnClass(@pcn['capacity'])
+          builder.codePcnPavementType(@pcn['type'])
+          builder.codePcnPavementSubgrade(@pcn['subgrade'])
+          builder.codePcnMaxTirePressure(@pcn['tire_pressure'])
+          builder.codePcnEvalMethod(@pcn['evaluation_method'])
+        end
+        builder.txtPcnNote(@remarks) if remarks
+        builder.target!
+      end
+    end
+  end
+end

data/lib/aixm/component/timetable.rb

@@ -15,6 +15,7 @@ module AIXM
     #
     # ===Shortcuts:
     # * +AIXM::H24+ - continuous, all day and all night
+    # * +AIXM::H_RE+ - pattern matching working hour codes
     #
     # @see https://github.com/openflightmaps/ofmx/wiki/Timetable#predefined-timetable
     class Timetable

data/lib/aixm/constants.rb

@@ -0,0 +1,40 @@
+module AIXM
+
+  # Characters recognized as symbols for "minute" in DMS notations
+  MIN = %Q('\u2018\u2019\u00b4).freeze
+
+  # Characters recognized as symbols for "second" in DMS notations
+  SEC = %Q("\u201c\u201d\u201f).freeze
+
+  # Pattern matching geographical coordinates in various DMS notations
+  DMS_RE = %r(
+    (?<dms>
+      (?<sgn>-)?
+      (?<deg>\d{1,3})[° ]{1,2}
+      (?<min>\d{2})[#{MIN}#{SEC} ]{1,2}
+      (?<sec>\d{2}(?:[\.,]\d{0,2})?)[#{SEC}#{MIN} ]{0,2}
+      (?<hem_ne>[NE])?(?<hem_sw>[SW])?
+    |
+      (?<sgn>-)?
+      (?<deg>\d{1,3})
+      (?<min>\d{2})
+      (?<sec>\d{2}(?:[\.,]\d{0,2})?)
+      (?:(?<hem_ne>[NE])|(?<hem_sw>[SW]))
+    )
+  )xi.freeze
+
+  # Pattern matching PCN surface strength notations
+  PCN_RE = %r(
+    (?<pcn>
+      (?<capacity>\d+)\W+
+      (?<type>[RF])\W+
+      (?<subgrade>[A-D])\W+
+      (?<tire_pressure>[W-Z])\W+
+      (?<evaluation_method>[TU])
+    )
+  )x.freeze
+
+  # Pattern matching timetable working hour codes
+  H_RE = /H(?:24|J|N|X|O)/.freeze
+
+end

data/lib/aixm/d.rb

@@ -8,6 +8,7 @@ module AIXM
   #   AIXM.d(123, :m)
   class D
     include Comparable
+    extend Forwardable
 
     UNITS = {
       ft: { km: 0.0003048, m: 0.3048, nm: 0.000164578833554 },
@@ -16,6 +17,10 @@ module AIXM
       nm: { ft: 6076.11548554, km: 1.852, m: 1852 }
     }.freeze
 
+    # @!method zero?
+    #   @return [Boolean] whether length is zero
+    def_delegator :@dist, :zero?
+
     # @return [Float] distance
     attr_reader :dist
 

data/lib/aixm/document.rb

@@ -15,7 +15,7 @@ module AIXM
   #
   # @see https://github.com/openflightmaps/ofmx/wiki/Snapshot
   class Document
-    NAMESPACE_PATTERN = /\A[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}\z/.freeze
+    NAMESPACE_RE = /\A[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}\z/.freeze
 
     # @return [String] OFMX region all features in this document belong to
     attr_reader :region
@@ -48,7 +48,7 @@ module AIXM
     end
 
     def namespace=(value)
-      fail(ArgumentError, "invalid namespace") unless value.nil? || value.match?(NAMESPACE_PATTERN)
+      fail(ArgumentError, "invalid namespace") unless value.nil? || value.match?(NAMESPACE_RE)
       @namespace = value || SecureRandom.uuid
     end
 

data/lib/aixm/f.rb

@@ -7,8 +7,14 @@ module AIXM
   # @example
   #   AIXM.f(123.35, :mhz)
   class F
+    extend Forwardable
+
     UNITS = %i(ghz mhz khz).freeze
 
+    # @!method zero?
+    #   @return [Boolean] whether frequency is zero
+    def_delegator :@freq, :zero?
+
     # @return [Float] frequency
     attr_reader :freq
 

data/lib/aixm/feature/address.rb

@@ -0,0 +1,100 @@
+using AIXM::Refinements
+
+module AIXM
+  class Feature
+
+    # Address or similar means to contact an entity.
+    #
+    # ===Cheat Sheet in Pseudo Code:
+    #   address = AIXM.address(
+    #     source: String or nil
+    #     type: TYPES
+    #     address: String
+    #   )
+    #   service.remarks = String or nil
+    #
+    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#aha-airport-address
+    class Address < Feature
+      public_class_method :new
+
+      TYPES = {
+        POST: :postal_address,
+        PHONE: :phone,
+        'PHONE-MET': :weather_phone,
+        FAX: :fax,
+        TLX: :telex,
+        SITA: :sita,
+        AFS: :aeronautical_fixed_service_address,
+        EMAIL: :email,
+        URL: :url,
+        'URL-CAM': :webcam,
+        'URL-MET': :weather_url,
+        RADIO: :radio_frequency,
+        OTHER: :other   # specify in remarks
+      }
+
+      # @return [AIXM::Feature] addressable feature
+      attr_reader :addressable
+
+      # @return [Symbol] type of address (see {TYPES})
+      attr_reader :type
+
+      # @return [String] postal address, phone number, radio frequency etc
+      attr_reader :address
+
+      # @return [String, nil] free text remarks
+      attr_reader :remarks
+
+      def initialize(source: nil, type:, address:)
+        super(source: source)
+        self.type, self.address = type, address
+      end
+
+      # @return [String]
+      def inspect
+        %Q(#<#{self.class} type=#{type.inspect}>)
+      end
+
+      def addressable=(value)
+        fail(ArgumentError, "invalid addressable") unless value.is_a? AIXM::Feature
+        @addressable = value
+      end
+      private :addressable=
+
+      def type=(value)
+        @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
+      end
+
+      def address=(value)
+        fail(ArgumentError, "invalid address") unless value.is_a? String
+        @address = value&.to_s
+      end
+
+      def remarks=(value)
+        @remarks = value&.to_s
+      end
+
+      # @return [String] UID markup
+      def to_uid(as:, sequence:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(as) do |tag|
+          tag << addressable.to_uid.indent(2) if addressable
+          tag.codeType(TYPES.key(type).to_s.then { |t| AIXM.aixm? ? t.sub(/-\w+$/, '') : t })
+          tag.noSeq(sequence)
+        end
+      end
+
+      # @return [String] AIXM or OFMX markup
+      def to_xml(as:, sequence:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.comment! ["Address: #{TYPES.key(type)}", addressable&.id].compact.join(' for ')
+        builder.tag!(as, { source: (source if AIXM.ofmx?) }.compact) do |tag|
+          tag << to_uid(as: :"#{as}Uid", sequence: sequence).indent(2)
+          tag.txtAddress(address)
+          tag.txtRmk(remarks) if remarks
+        end
+      end
+    end
+
+  end
+end

data/lib/aixm/feature/airport.rb

@@ -24,12 +24,13 @@ module AIXM
     #   airport.add_runway(AIXM.runway)
     #   airport.add_helipad(AIXM.helipad)
     #   airport.add_usage_limitation(UsageLimitation::TYPES)
+    #   airport.add_address(AIXM.address)
     #
     # @see https://github.com/openflightmaps/ofmx/wiki/Airport#ahp-airport
     class Airport < Feature
       public_class_method :new
 
-      ID_PATTERN = /^([A-Z]{3,4}|[A-Z]{2}[A-Z\d]{4,})$/.freeze
+      ID_RE = /^([A-Z]{3,4}|[A-Z]{2}[A-Z\d]{4,})$/.freeze
 
       TYPES = {
         AD: :aerodrome,
@@ -90,10 +91,13 @@ module AIXM
       # @return [Array<AIXM::Feature::Airport::UsageLimitation>] usage limitations
       attr_accessor :usage_limitations
 
+      # @return [Array<AIXM::Feature::Address>] postal address, url, A/A or A/G frequency etc
+      attr_reader :addresses
+
       def initialize(source: nil, organisation:, id:, name:, xy:)
         super(source: source)
         self.organisation, self.id, self.name, self.xy = organisation, id, name, xy
-        @runways, @helipads, @usage_limitations = [], [], []
+        @runways, @helipads, @usage_limitations, @addresses = [], [], [], []
       end
 
       # @return [String]
@@ -107,7 +111,7 @@ module AIXM
       end
 
       def id=(value)
-        fail(ArgumentError, "invalid id `#{id}'") unless value&.upcase&.match? ID_PATTERN
+        fail(ArgumentError, "invalid id `#{id}'") unless value&.upcase&.match? ID_RE
         @id = value.upcase
       end
 
@@ -155,7 +159,7 @@ module AIXM
       def declination=(value)
         return @declination = value if value.nil?
         fail(ArgumentError, "invalid declination") unless value.is_a?(Numeric) && (-180..180).include?(value)
-        @declination = value.to_f
+        @declination = value.to_f + 0   # adding zero prevents -0.0
       end
 
       def transition_z=(value)
@@ -229,11 +233,22 @@ module AIXM
         self
       end
 
+      # Add an address (postal address, url, A/A or A/G frequency etc) to the airport.
+      #
+      # @params address [AIXM::Feature::Address] address instance
+      # @return [self]
+      def add_address(address)
+        fail(ArgumentError, "invalid address") unless address.is_a? AIXM::Feature::Address
+        address.send(:addressable=, self)
+        @addresses << address
+        self
+      end
+
       # @return [String] UID markup
-      def to_uid
+      def to_uid(as: :AhpUid)
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.AhpUid do |ahp_uid|
-          ahp_uid.codeId(id)
+        builder.tag!(as) do |tag|
+          tag.codeId(id)
         end
       end
 
@@ -280,6 +295,10 @@ module AIXM
             end
           end
         end
+        addresses.each.with_object({}) do |address, sequences|
+          sequences[address.type] = (sequences[address.type] || 0) + 1
+          builder << address.to_xml(as: :Aha, sequence: sequences[address.type])
+        end
         builder.target!
       end
 

data/lib/aixm/feature/airspace.rb

@@ -16,6 +16,13 @@ module AIXM
     #   airspace.geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
     #   airspace.layers << AIXM.layer
     #
+    # Some regions define additional airspace types. In LF (France) for
+    # intance, the types RMZ (radio mandatory zone) and TMZ (transponder
+    # mandatory zone) exist. Such airspaces are usually specified together
+    # with a generic type such as +:regulated_airspace+:
+    #
+    #   airspace= AIXM.airspace(type: :regulated_airspace, local_type: "RMZ")
+    #
     # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#ase-airspace
     class Airspace < Feature
       public_class_method :new
@@ -71,7 +78,9 @@ module AIXM
       # @return [Symbol] type of airspace (see {TYPES})
       attr_reader :type
 
-      # @return [String, nil] short name (e.g. "LF P 81")
+      # Some regions define additional types. They are usually specified with
+      #
+      # @return [String, nil] local type (e.g. "RMZ" or "TMZ")
       attr_reader :local_type
 
       # @return [String, nil] full name (e.g. "LF P 81 CHERBOURG")

data/lib/aixm/feature/navigational_aid.rb

@@ -85,7 +85,7 @@ module AIXM
 
       def to_builder
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.comment! "NavigationalAid: [#{kind}] #{name || :UNNAMED}"
+        builder.comment! "NavigationalAid: [#{kind}] #{[id, name].compact.join(' / ')}"
         builder
       end
     end

data/lib/aixm/feature/navigational_aid/designated_point.rb

@@ -15,6 +15,7 @@ module AIXM
       #     xy: AIXM.xy
       #     type: TYPES
       #   )
+      #   designated_point.airport = AIXM.airport or nil
       #   designated_point.remarks = String or nil
       #
       # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#dpn-designated-point
@@ -24,15 +25,23 @@ module AIXM
         private :organisation
 
         TYPES = {
-          ICAO: :icao,           # five-letter ICAO name
-          ADHP: :adhp,           # airport related name
-          COORD: :coordinates,   # derived from geographical coordinates
-          OTHER: :other          # specify in remarks
+          ICAO: :icao,                                 # five-letter ICAO id
+          ADHP: :adhp,                                 # airport related id
+          COORD: :coordinates,                         # derived from geographical coordinates
+          'VFR-RP': :vfr_reporting_point,              # usually one or two letter id
+          'VFR-MRP': :vfr_mandatory_reporting_point,   # usually one or two letter id
+          'VFR-ENR': :vfr_en_route_point,
+          'VFR-GLD': :vfr_glider_point,
+          OTHER: :other                                # specify in remarks
         }.freeze
 
         # @return [Symbol] type of designated point
         attr_reader :type
 
+        # @return [AIXM::Feature::Airport] airport this designated point is
+        #   associated with
+        attr_reader :airport
+
         def initialize(type:, **arguments)
           super(organisation: false, z: nil, **arguments)
           self.type = type
@@ -42,6 +51,11 @@ module AIXM
           @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
         end
 
+        def airport=(value)
+          fail(ArgumentError, "invalid airport") unless value.nil? || value.is_a?(AIXM::Feature::Airport)
+          @airport = value
+        end
+
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
@@ -57,8 +71,9 @@ module AIXM
           builder = to_builder
           builder.Dpn({ source: (source if AIXM.ofmx?) }.compact) do |dpn|
             dpn << to_uid.indent(2)
+            dpn << airport.to_uid(as: :AhpUidAssoc).indent(2) if airport
             dpn.codeDatum('WGE')
-            dpn.codeType(type_key.to_s)
+            dpn.codeType(AIXM.aixm? && type_key =~ /^VFR/ ? 'OTHER' : type_key.to_s)
             dpn.txtName(name) if name
             dpn.txtRmk(remarks) if remarks
             dpn.target!