aixm 0.3.0 → 0.3.1

data/lib/aixm/feature.rb

@@ -7,8 +7,8 @@ module AIXM
     # @return [String] reference to source of the feature data
     attr_reader :source
 
-    def initialize(source: nil, region: nil)
-      self.source, self.region = source, region
+    def initialize(source: nil)
+      self.source = source
     end
 
     # @return [String] reference to source of the feature data
@@ -17,18 +17,6 @@ module AIXM
       @source = value
     end
 
-    # @!attribute region
-    # @note When assigning +nil+, the global default +AIXM.config.region+ is written instead.
-    # @return [String] region the feature belongs to
-    def region
-      @region || AIXM.config.region&.upcase
-    end
-
-    def region=(value)
-      fail(ArgumentError, "invalid region") unless value.nil? || value.is_a?(String)
-      @region = value&.upcase
-    end
-
     # @return [Boolean]
     def ==(other)
       other.is_a?(self.class) && self.to_uid == other.to_uid

data/lib/aixm/feature/airport.rb

@@ -9,9 +9,8 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   airport = AIXM.airport(
     #     source: String or nil
-    #     region: String or nil (falls back to AIXM.config.region)
     #     organisation: AIXM.organisation
-    #     code: String
+    #     id: String
     #     name: String
     #     xy: AIXM.xy
     #   )
@@ -30,7 +29,7 @@ module AIXM
     class Airport < Feature
       public_class_method :new
 
-      CODE_PATTERN = /^[A-Z]{2}([A-Z]{1,2}|\d{4})$/.freeze
+      ID_PATTERN = /^([A-Z]{3,4}|[A-Z]{2}[A-Z\d]{4,})$/.freeze
 
       TYPES = {
         AD: :aerodrome,
@@ -42,14 +41,16 @@ module AIXM
       # @return [AIXM::Feature::Organisation] superior organisation
       attr_reader :organisation
 
-      # ICAO indicator, IATA indicator or ICAO serial number
+      # ICAO indicator, IATA indicator or generated indicator
       #
       # * four letter ICAO indicator (e.g. "LFMV")
       # * three letter IATA indicator (e.g. "AVN")
       # * two letter ICAO country code + four digit number (e.g. "LF1234")
+      # * two letter ICAO country code + at least four letters/digits (e.g.
+      #   "LFFOOBAR123" or "LF" + GPS code)
       #
-      # @return [String] airport indicator code
-      attr_reader :code
+      # @return [String] airport indicator
+      attr_reader :id
 
       # @return [String] full name
       attr_reader :name
@@ -89,15 +90,15 @@ module AIXM
       # @return [Array<AIXM::Feature::Airport::UsageLimitation>] usage limitations
       attr_accessor :usage_limitations
 
-      def initialize(source: nil, region: nil, organisation:, code:, name:, xy:)
-        super(source: source, region: region)
-        self.organisation, self.code, self.name, self.xy = organisation, code, name, xy
+      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 = [], [], []
       end
 
       # @return [String]
       def inspect
-        %Q(#<#{self.class} code=#{code.inspect}>)
+        %Q(#<#{self.class} id=#{id.inspect}>)
       end
 
       def organisation=(value)
@@ -105,9 +106,9 @@ module AIXM
         @organisation = value
       end
 
-      def code=(value)
-        fail(ArgumentError, "invalid code `#{code}'") unless value&.upcase&.match? CODE_PATTERN
-        @code = value.upcase
+      def id=(value)
+        fail(ArgumentError, "invalid id `#{id}'") unless value&.upcase&.match? ID_PATTERN
+        @id = value.upcase
       end
 
       def name=(value)
@@ -230,21 +231,21 @@ module AIXM
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.AhpUid({ region: (region if AIXM.ofmx?) }.compact) do |ahp_uid|
-          ahp_uid.codeId(code)
+        builder.AhpUid do |ahp_uid|
+          ahp_uid.codeId(id)
         end
       end
 
       # @return [String] AIXM or OFMX markup
       def to_xml
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.comment! "Airport: #{code} #{name}"
+        builder.comment! "Airport: #{id} #{name}"
         builder.Ahp({ source: (source if AIXM.ofmx?) }.compact) do |ahp|
           ahp << to_uid.indent(2)
           ahp << organisation.to_uid.indent(2)
           ahp.txtName(name)
-          ahp.codeIcao(code) if code.length == 4
-          ahp.codeIata(code) if code.length == 3
+          ahp.codeIcao(id) if id.length == 4
+          ahp.codeIata(id) if id.length == 3
           ahp.codeGps(gps) if AIXM.ofmx? && gps
           ahp.codeType(TYPES.key(type).to_s) if type
           ahp.geoLat(xy.lat(AIXM.schema))

data/lib/aixm/feature/airspace.rb

@@ -8,11 +8,10 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   airspace = AIXM.airspace(
     #     source: String or nil
-    #     region: String or nil (falls back to AIXM.config.region)
     #     id: String
     #     type: String or Symbol
+    #     local_type: String or nil
     #     name: String or nil
-    #     short_name: String or nil
     #   )
     #   airspace.geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
     #   airspace.layers << AIXM.layer
@@ -65,28 +64,28 @@ module AIXM
       }.freeze
 
       # @note When assigning +nil+, a 4 byte hex derived from {#type}, {#name}
-      #   and {#short_name} is written instead.
+      #   and {#local_type} is written instead.
       # @return [String] published identifier (e.g. "LFP81")
       attr_reader :id
 
       # @return [Symbol] type of airspace (see {TYPES})
       attr_reader :type
 
+      # @return [String, nil] short name (e.g. "LF P 81")
+      attr_reader :local_type
+
       # @return [String, nil] full name (e.g. "LF P 81 CHERBOURG")
       attr_reader :name
 
-      # @return [String, nil] short name (e.g. "LF P 81")
-      attr_reader :short_name
-
       # @return [AIXM::Component::Geometry] horizontal geometrical shape
       attr_accessor :geometry
 
       # @return [Array<AIXM::Compoment::Layer>] vertical layers
       attr_accessor :layers
 
-      def initialize(source: nil, region: nil, id: nil, type:, name: nil, short_name: nil)
-        super(source: source, region: region)
-        self.type, self.name, self.short_name = type, name, short_name
+      def initialize(source: nil, id: nil, type:, local_type: nil, name: nil)
+        super(source: source)
+        self.type, self.local_type, self.name = type, local_type, name
         self.id = id
         @geometry = AIXM.geometry
         @layers = []
@@ -99,27 +98,27 @@ module AIXM
 
       def id=(value)
         fail(ArgumentError, "invalid id") unless value.nil? || value.is_a?(String)
-        @id = value&.uptrans || [type, name, short_name].to_digest.upcase
+        @id = value&.uptrans || [type, local_type, name].to_digest.upcase
       end
 
       def type=(value)
         @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
       end
 
+      def local_type=(value)
+        fail(ArgumentError, "invalid short name") unless value.nil? || value.is_a?(String)
+        @local_type = value&.uptrans
+      end
+
       def name=(value)
         fail(ArgumentError, "invalid name") unless value.nil? || value.is_a?(String)
         @name = value&.uptrans
       end
 
-      def short_name=(value)
-        fail(ArgumentError, "invalid short name") unless value.nil? || value.is_a?(String)
-        @short_name = value&.uptrans
-      end
-
       # @return [String] UID markup
       def to_uid(as: :AseUid)
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.tag!(as, { region: (region if AIXM.ofmx?) }.compact) do |tag|
+        builder.tag!(as) do |tag|
           tag.codeType(TYPES.key(type).to_s)
           tag.codeId(id)
         end
@@ -129,15 +128,14 @@ module AIXM
       # @raise [AIXM::LayerError] if no layers are defined
       # @return [String] AIXM or OFMX markup
       def to_xml
-        fail(LayerError, "no layers defined") unless layers.any?
+        fail(LayerError.new("no layers defined", self)) unless layers.any?
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.comment! "Airspace: [#{TYPES.key(type)}] #{name || :UNNAMED}"
         builder.Ase({
-          source: (source if AIXM.ofmx?),
-          classLayers: (layers.count if AIXM.ofmx? && layered?)
+          source: (source if AIXM.ofmx?)
         }.compact) do |ase|
           ase << to_uid.indent(2)
-          ase.txtLocalType(short_name) if short_name && short_name != name
+          ase.txtLocalType(local_type) if local_type && local_type != name
           ase.txtName(name) if name
           unless layered?
             ase << layers.first.to_xml.indent(2)
@@ -151,7 +149,7 @@ module AIXM
         end
         if layered?
           layers.each.with_index do |layer, index|
-            layer_airspace = AIXM.airspace(region: region, type: 'CLASS', name: "#{name} LAYER #{index + 1}")
+            layer_airspace = AIXM.airspace(type: 'CLASS', name: "#{name} LAYER #{index + 1}")
             builder.Ase do |ase|
               ase << layer_airspace.to_uid.indent(2)
               ase.txtName(layer_airspace.name)

data/lib/aixm/feature/navigational_aid.rb

@@ -28,8 +28,8 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(source: nil, region: nil, organisation:, id:, name: nil, xy:, z: nil)
-        super(source: source, region: region)
+      def initialize(source: nil, organisation:, id:, name: nil, xy:, z: nil)
+        super(source: source)
         self.organisation, self.id, self.name, self.xy, self.z = organisation, id, name, xy, z
       end
 

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

@@ -10,7 +10,6 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   designated_point = AIXM.designated_point(
       #     source: String or nil
-      #     region: String or nil (falls back to AIXM.config.region)
       #     id: String
       #     name: String or nil
       #     xy: AIXM.xy
@@ -46,7 +45,7 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.DpnUid({ region: (region if AIXM.ofmx?) }.compact) do |dpn_uid|
+          builder.DpnUid do |dpn_uid|
             dpn_uid.codeId(id)
             dpn_uid.geoLat(xy.lat(AIXM.schema))
             dpn_uid.geoLong(xy.long(AIXM.schema))

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

@@ -12,7 +12,6 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   dme = AIXM.dme(
       #     source: String or nil
-      #     region: String or nil (falls back to AIXM.config.region)
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -27,6 +26,8 @@ module AIXM
       class DME < NavigationalAid
         public_class_method :new
 
+        CHANNEL_PATTERN = /\A([1-9]|[1-9]\d|1[0-1]\d|12[0-6])[XY]\z/.freeze
+
         # @return [String] radio channel
         attr_reader :channel
 
@@ -39,8 +40,24 @@ module AIXM
         end
 
         def channel=(value)
-          fail(ArgumentError, "invalid channel") unless value.is_a? String
-          @channel = value.upcase
+          fail(ArgumentError, "invalid channel") unless value.is_a?(String) && value.match?(CHANNEL_PATTERN)
+          @channel = value
+        end
+
+        # @return [AIXM::F] ghost frequency matching the channel
+        def ghost_f
+          if channel
+            number, letter = channel.split(/(?=[XY])/)
+            integer = case number.to_i
+              when (1..16) then 13430
+              when (17..59) then 10630
+              when (60..69) then 12730
+              when (70..126) then 10530
+            end
+            integer += number.to_i * 10
+            integer += 5 if letter == 'Y'
+            AIXM.f(integer.to_f / 100, :mhz)
+          end
         end
 
         def vor=(value)
@@ -52,7 +69,7 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.DmeUid({ region: (region if AIXM.ofmx?) }.compact) do |dme_uid|
+          builder.DmeUid do |dme_uid|
             dme_uid.codeId(id)
             dme_uid.geoLat(xy.lat(AIXM.schema))
             dme_uid.geoLong(xy.long(AIXM.schema))
@@ -68,6 +85,10 @@ module AIXM
             dme << vor.to_uid.indent(2) if vor
             dme.txtName(name) if name
             dme.codeChannel(channel)
+            unless vor
+              dme.valGhostFreq(ghost_f.freq.trim)
+              dme.uomGhostFreq('MHZ')
+            end
             dme.codeDatum('WGE')
             if z
               dme.valElev(z.alt)

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

@@ -11,7 +11,6 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   marker = AIXM.marker(
       #     source: String or nil
-      #     region: String or nil (falls back to AIXM.config.region)
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -54,7 +53,7 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.MkrUid({ region: (region if AIXM.ofmx?) }.compact) do |mkr_uid|
+          builder.MkrUid do |mkr_uid|
             mkr_uid.codeId(id)
             mkr_uid.geoLat(xy.lat(AIXM.schema))
             mkr_uid.geoLong(xy.long(AIXM.schema))

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

@@ -10,7 +10,6 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   ndb = AIXM.ndb(
       #     source: String or nil
-      #     region: String or nil (falls back to AIXM.config.region)
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -56,7 +55,7 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.NdbUid({ region: (region if AIXM.ofmx?) }.compact) do |ndb_uid|
+          builder.NdbUid do |ndb_uid|
             ndb_uid.codeId(id)
             ndb_uid.geoLat(xy.lat(AIXM.schema))
             ndb_uid.geoLong(xy.long(AIXM.schema))

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

@@ -11,7 +11,6 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   tacan = AIXM.tacan(
       #     source: String or nil
-      #     region: String or nil (to use +AIXM.config.region+)
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -29,7 +28,7 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.TcnUid({ region: (region if AIXM.ofmx?) }.compact) do |tcn_uid|
+          builder.TcnUid do |tcn_uid|
             tcn_uid.codeId(id)
             tcn_uid.geoLat(xy.lat(AIXM.schema))
             tcn_uid.geoLong(xy.long(AIXM.schema))
@@ -45,6 +44,10 @@ module AIXM
             tcn << vor.to_uid.indent(2) if vor
             tcn.txtName(name) if name
             tcn.codeChannel(channel)
+            if !vor && AIXM.ofmx?
+              tcn.valGhostFreq(ghost_f.freq.trim)
+              tcn.uomGhostFreq('MHZ')
+            end
             tcn.codeDatum('WGE')
             if z
               tcn.valElev(z.alt)

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

@@ -11,7 +11,6 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   vor = AIXM.vor(
       #     source: String or nil
-      #     region: String or nil (falls back to AIXM.config.region)
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -79,21 +78,21 @@ module AIXM
         # Associate a DME which turns the VOR into a VOR/DME
         def associate_dme(channel:)
           @dme = AIXM.dme(organisation: organisation, id: id, name: name, xy: xy, z: z, channel: channel)
-          @dme.region, @dme.timetable, @dme.remarks = region, timetable, remarks
+          @dme.timetable, @dme.remarks = timetable, remarks
           @dme.send(:vor=, self)
         end
 
         # Associate a TACAN which turns the VOR into a VORTAC
         def associate_tacan(channel:)
           @tacan = AIXM.tacan(organisation: organisation, id: id, name: name, xy: xy, z: z, channel: channel)
-          @tacan.region, @tacan.timetable, @tacan.remarks = region, timetable, remarks
+          @tacan.timetable, @tacan.remarks = timetable, remarks
           @tacan.send(:vor=, self)
         end
 
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.VorUid({ region: (region if AIXM.ofmx?) }.compact) do |vor_uid|
+          builder.VorUid do |vor_uid|
             vor_uid.codeId(id)
             vor_uid.geoLat(xy.lat(AIXM.schema))
             vor_uid.geoLong(xy.long(AIXM.schema))

data/lib/aixm/feature/organisation.rb

@@ -9,7 +9,6 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   organisation = AIXM.organisation(
     #     source: String or nil
-    #     region: String or nil (falls back to +AIXM.config.region+)
     #     name: String
     #     type: TYPES
     #   )
@@ -44,8 +43,8 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(source: nil, region: nil, name:, type:)
-        super(source: source, region: region)
+      def initialize(source: nil, name:, type:)
+        super(source: source)
         self.name, self.type = name, type
       end
 
@@ -75,7 +74,7 @@ module AIXM
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.OrgUid({ region: (region if AIXM.ofmx?) }.compact) do |org_uid|
+        builder.OrgUid do |org_uid|
           org_uid.txtName(name)
         end
       end