aixm 0.2.0 → 0.2.1

data/lib/aixm/component/geometry/circle.rb

@@ -21,8 +21,8 @@ module AIXM
         end
 
         ##
-        # Render AIXM
-        def to_xml(*extensions)
+        # Render AIXM markup
+        def to_aixm(*extensions)
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
             avx.codeType('CWA')

data/lib/aixm/component/geometry/point.rb

@@ -18,8 +18,8 @@ module AIXM
         end
 
         ##
-        # Render AIXM
-        def to_xml(*extensions)
+        # Render AIXM markup
+        def to_aixm(*extensions)
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
             avx.codeType('GRC')

data/lib/aixm/component/schedule.rb

@@ -33,8 +33,8 @@ module AIXM
       end
 
       ##
-      # Render AIXM
-      def to_xml(*extensions)
+      # Render AIXM markup
+      def to_aixm(*extensions)
         Builder::XmlMarkup.new(indent: 2).codeWorkHr(CODES.key(code).to_s)
       end
     end

data/lib/aixm/component/vertical_limits.rb

@@ -35,8 +35,8 @@ module AIXM
       end
 
       ##
-      # Render AIXM
-      def to_xml(*extensions)
+      # Render AIXM markup
+      def to_aixm(*extensions)
         %i(upper lower max min).each_with_object(Builder::XmlMarkup.new(indent: 2)) do |limit, builder|
           if z = send(:"#{limit}_z")
             builder.tag!(:"codeDistVer#{TAGS[limit]}", CODES[z.code].to_s)

data/lib/aixm/document.rb

@@ -34,17 +34,17 @@ module AIXM
     # Validate against the XSD and return an array of errors
     def errors
       xsd = Nokogiri::XML::Schema(File.open(AIXM::SCHEMA))
-      xsd.validate(Nokogiri::XML(to_xml)).reject do |error|
+      xsd.validate(Nokogiri::XML(to_aixm)).reject do |error|
         error.message =~ IGNORE_ERROR_PATTERN
       end
     end
 
     ##
-    # Render AIXM
+    # Render AIXM markup
     #
     # Extensions:
     # * +:ofm+ - Open Flightmaps
-    def to_xml(*extensions)
+    def to_aixm(*extensions)
       now = Time.now.xmlschema
       meta = {
         'xmlns:xsi': 'http://www.aixm.aero/schema/4.5/AIXM-Snapshot.xsd',
@@ -57,7 +57,7 @@ module AIXM
       builder = Builder::XmlMarkup.new(indent: 2)
       builder.instruct!
       builder.tag!('AIXM-Snapshot', meta) do |aixm_snapshot|
-        aixm_snapshot << features.map { |f| f.to_xml(*extensions) }.join.indent(2)
+        aixm_snapshot << features.map { |f| f.to_aixm(*extensions) }.join.indent(2)
       end
     end
 

data/lib/aixm/feature/airspace.rb

@@ -3,9 +3,8 @@ module AIXM
     class Airspace < Base
       using AIXM::Refinements
 
-      attr_reader :name, :short_name, :type
-      attr_reader :schedule
-      attr_accessor :geometry, :class_layers, :remarks
+      attr_reader :name, :short_name, :type, :schedule, :remarks
+      attr_accessor :geometry, :class_layers
 
       ##
       # Airspace feature
@@ -17,19 +16,37 @@ module AIXM
       #                  uppercase, e.g. +LF P 81 CHERBOURG+)
       # * +type+ - airspace type (e.g. +TMA+ or +P+)
       def initialize(name:, short_name: nil, type:)
-        @name, @short_name, @type = name.uptrans, short_name&.uptrans, type
+        self.name, self.short_name, self.type = name, short_name, type
         @schedule = nil
         @geometry = AIXM.geometry
         @class_layers = []
       end
 
-      ##
-      # Assign a +Schedule+ object or +nil+
+      def name=(value)
+        fail(AttributeError, "invalid name") unless value.is_a? String
+        @name = value.uptrans
+      end
+
+      def short_name=(value)
+        fail(AttributeError, "invalid short name") unless value.nil? || value.is_a?(String)
+        @short_name = value&.uptrans
+      end
+
+      def type=(value)
+        fail(AttributeError, "invalid type") unless value.is_a?(String)
+        @type = value.upcase
+      end
+
       def schedule=(value)
         fail(ArgumentError, "invalid schedule") unless value.nil? || value.is_a?(AIXM::Component::Schedule)
         @schedule = value
       end
 
+      def remarks=(value)
+        fail(AttributeError, "invalid remarks") unless value.is_a?(String)
+        @remarks = value
+      end
+
       ##
       # Check whether the airspace is complete
       def complete?
@@ -43,22 +60,30 @@ module AIXM
       end
 
       ##
-      # Render AIXM
-      def to_xml(*extensions)
+      # Render UID markup
+      def to_uid(*extensions)
+        mid = to_digest
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.AseUid({ mid: mid, newEntity: (true if extensions >> :ofm) }.compact) do |aseuid|
+          aseuid.codeType(type)
+          aseuid.codeId(mid)
+        end
+      end
+
+      ##
+      # Render AIXM markup
+      def to_aixm(*extensions)
         mid = to_digest
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.comment! "Airspace: [#{type}] #{name}"
         builder.Ase({ xt_classLayersAvail: ((class_layers.count > 1) if extensions >> :ofm) }.compact) do |ase|
-          ase.AseUid({ mid: mid, newEntity: (true if extensions >> :ofm) }.compact) do |aseuid|
-            aseuid.codeType(type.to_s)
-            aseuid.codeId(mid)
-          end
+          ase << to_uid(*extensions).indent(2)
           ase.txtLocalType(short_name.to_s) if short_name && short_name != name
           ase.txtName(name.to_s)
-          ase << class_layers.first.to_xml(*extensions).indent(2)
+          ase << class_layers.first.to_aixm(*extensions).indent(2)
           if schedule
             ase.Att do |att|
-              att << schedule.to_xml(*extensions).indent(4)
+              att << schedule.to_aixm(*extensions).indent(4)
             end
           end
           ase.txtRmk(remarks.to_s) if remarks
@@ -67,11 +92,11 @@ module AIXM
         builder.Abd do |abd|
           abd.AbdUid do |abduid|
             abduid.AseUid({ mid: mid, newEntity: (true if extensions >> :ofm) }.compact) do |aseuid|
-              aseuid.codeType(type.to_s)
+              aseuid.codeType(type)
               aseuid.codeId(mid)
             end
           end
-          abd << geometry.to_xml(*extensions).indent(2)
+          abd << geometry.to_aixm(*extensions).indent(2)
         end
         if class_layers.count > 1
           builder.Adg do |adg|
@@ -90,7 +115,7 @@ module AIXM
                 aseuid.codeType("CLASS")
               end
               ase.txtName(name.to_s)
-              ase << class_layers[index].to_xml(*extensions).indent(2)
+              ase << class_layers[index].to_aixm(*extensions).indent(2)
             end
           end
         end

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

@@ -9,21 +9,48 @@ module AIXM
       class Base < AIXM::Feature::Base
         using AIXM::Refinements
 
-        attr_reader :id, :name, :xy, :z
-        attr_accessor :remarks
+        attr_reader :id, :name, :xy, :z, :schedule, :remarks
 
         private_class_method :new
 
         def initialize(id:, name:, xy:, z: nil)
-          @id, @name, @xy, @z = id&.upcase, name&.upcase, xy, z
-          fail(ArgumentError, "invalid xy") unless xy.is_a? AIXM::XY
-          fail(ArgumentError, "invalid z") unless z.nil? || (z.is_a?(AIXM::Z) && z.qnh?)
+          self.id, self.name, self.xy, self.z = id, name, xy, z
+        end
+
+        def id=(value)
+          fail(ArgumentError, "invalid id") unless value.is_a? String
+          @id = value.upcase
+        end
+
+        def name=(value)
+          fail(ArgumentError, "invalid name") unless value.is_a? String
+          @name = value.upcase
+        end
+
+        def xy=(value)
+          fail(ArgumentError, "invalid xy") unless value.is_a? AIXM::XY
+          @xy = value
+        end
+
+        def z=(value)
+          fail(ArgumentError, "invalid z") unless value.nil? || (value.is_a?(AIXM::Z) && value.qnh?)
+          @z = value
+        end
+
+        def schedule=(value)
+          fail(ArgumentError, "invalid schedule") unless value.nil? || value.is_a?(AIXM::Component::Schedule)
+          @schedule = value
+        end
+
+        def remarks=(value)
+          fail(ArgumentError, "invalid remarks") unless value.nil? || value.is_a?(String)
+          @remarks = value
         end
 
         ##
-        # Return either the +type_key+ or +class+
+        # Return a fully descriptive combination of +class+ and +type_key+
         def kind
-          respond_to?(:type_key) ? type_key : self.class.name.split('::').last.to_sym
+          [self.class.name.split('::').last, type_key].compact.join(':')
         end
 
         ##
@@ -36,9 +63,15 @@ module AIXM
         # Create builder to render AIXM in subclasses
         def to_builder(*extensions)
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.comment! "Navigational aid: [#{kind}] #{name}"
+          builder.comment! "NavigationalAid: [#{kind}] #{name}"
           builder
         end
+
+        ##
+        # Fallback type key
+        def type_key
+          nil
+        end
       end
 
     end

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

@@ -10,15 +10,13 @@ module AIXM
       # * +:adhp+ (+:ADHP+) - aerodrome/heliport related name code designator
       # * +:coordinates+ (+:COORD+) - point with identifier derived from its
       #                               geographical coordinates
-      # * +:other+ (+:OTHER+) - other type
       class DesignatedPoint < Base
         using AIXM::Refinements
 
         TYPES = {
           ICAO: :icao,
           ADHP: :adhp,
-          COORD: :coordinates,
-          OTHER: :other
+          COORD: :coordinates
         }.freeze
 
         attr_reader :type
@@ -27,7 +25,15 @@ module AIXM
 
         def initialize(id:, name:, xy:, z: nil, type:)
           super(id: id, name: name, xy: xy, z: z)
-          @type = TYPES.lookup(type&.to_sym, nil) || fail(ArgumentError, "invalid type")
+          self.type = type
+        end
+
+        def type=(value)
+          @type = TYPES.lookup(value&.to_sym, nil) || fail(ArgumentError, "invalid type")
+        end
+
+        def type_key
+          TYPES.key(type)
         end
 
         ##
@@ -37,15 +43,22 @@ module AIXM
         end
 
         ##
-        # Render AIXM
-        def to_xml(*extensions)
+        # Render UID markup
+        def to_uid(*extensions)
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.DpnUid({ newEntity: (true if extensions >> :ofm) }.compact) do |dpnuid|
+            dpnuid.codeId(id)
+            dpnuid.geoLat(xy.lat(format_for(*extensions)))
+            dpnuid.geoLong(xy.long(format_for(*extensions)))
+          end
+        end
+
+        ##
+        # Render AIXM markup
+        def to_aixm(*extensions)
           builder = to_builder(*extensions)
           builder.Dpn do |dpn|
-            dpn.DpnUid({ newEntity: (true if extensions >> :ofm) }.compact) do |dpnuid|
-              dpnuid.codeId(id)
-              dpnuid.geoLat(xy.lat(format_for(*extensions)))
-              dpnuid.geoLong(xy.long(format_for(*extensions)))
-            end
+            dpn << to_uid(*extensions).indent(2)
             dpn.OrgUid
             dpn.txtName(name)
             dpn.codeDatum('WGE')
@@ -54,14 +67,15 @@ module AIXM
               dpn.valElev(z.alt)
               dpn.uomDistVer(z.unit.to_s)
             end
+            if schedule
+              dpn.Dtt do |dtt|
+                dtt << schedule.to_aixm(*extensions).indent(4)
+              end
+            end
             dpn.txtRmk(remarks) if remarks
             dpn.target!   # see https://github.com/jimweirich/builder/issues/42
           end
         end
-
-        def type_key
-          TYPES.key(type)
-        end
       end
 
     end

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

@@ -10,13 +10,23 @@ module AIXM
       class DME < Base
         using AIXM::Refinements
 
-        attr_reader :channel
+        attr_reader :channel, :vor
 
         public_class_method :new
 
         def initialize(id:, name:, xy:, z: nil, channel:)
           super(id: id, name: name, xy: xy, z: z)
-          @channel = channel&.upcase
+          self.channel = channel
+        end
+
+        def channel=(value)
+          fail(ArgumentError, "invalid channel") unless value.is_a? String
+          @channel = value.upcase
+        end
+
+        def vor=(value)
+          fail(ArgumentError, "invalid VOR") unless value.is_a? VOR
+          @vor = value
         end
 
         ##
@@ -26,16 +36,24 @@ module AIXM
         end
 
         ##
-        # Render AIXM
-        def to_xml(*extensions)
+        # Render UID markup
+        def to_uid(*extensions)
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.DmeUid({ newEntity: (true if extensions >> :ofm) }.compact) do |dmeuid|
+            dmeuid.codeId(id)
+            dmeuid.geoLat(xy.lat(format_for(*extensions)))
+            dmeuid.geoLong(xy.long(format_for(*extensions)))
+          end
+        end
+
+        ##
+        # Render AIXM markup
+        def to_aixm(*extensions)
           builder = to_builder(*extensions)
           builder.Dme do |dme|
-            dme.DmeUid({ newEntity: (true if extensions >> :ofm) }.compact) do |dmeuid|
-              dmeuid.codeId(id)
-              dmeuid.geoLat(xy.lat(format_for(*extensions)))
-              dmeuid.geoLong(xy.long(format_for(*extensions)))
-            end
+            dme << to_uid(*extensions).indent(2)
             dme.OrgUid
+            dme << vor.to_uid(*extensions).indent(2) if vor
             dme.txtName(name)
             dme.codeChannel(channel)
             dme.codeDatum('WGE')
@@ -43,6 +61,11 @@ module AIXM
               dme.valElev(z.alt)
               dme.uomDistVer(z.unit.to_s)
             end
+            if schedule
+              dme.Dtt do |dtt|
+                dtt << schedule.to_aixm(*extensions).indent(4)
+              end
+            end
             dme.txtRmk(remarks) if remarks
             dme.target!   # see https://github.com/jimweirich/builder/issues/42
           end

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

@@ -11,16 +11,29 @@ module AIXM
 
         public_class_method :new
 
+        # TODO: Marker require an associated ILS
+        def initialize(**args)
+          warn("WARNING: Maker is not fully implemented yet due to the lack of ILS")
+          super
+        end
+
+        ##
+        # Render UID markup
+        def to_uid(*extensions)
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.MkrUid({ newEntity: (true if extensions >> :ofm) }.compact) do |mkruid|
+            mkruid.codeId(id)
+            mkruid.geoLat(xy.lat(format_for(*extensions)))
+            mkruid.geoLong(xy.long(format_for(*extensions)))
+          end
+        end
+
         ##
-        # Render AIXM
-        def to_xml(*extensions)
+        # Render AIXM markup
+        def to_aixm(*extensions)
           builder = to_builder(*extensions)
           builder.Mkr do |mkr|
-            mkr.MkrUid({ newEntity: (true if extensions >> :ofm) }.compact) do |mkruid|
-              mkruid.codeId(id)
-              mkruid.geoLat(xy.lat(format_for(*extensions)))
-              mkruid.geoLong(xy.long(format_for(*extensions)))
-            end
+            mkr << to_uid(*extensions).indent(2)
             mkr.OrgUid
             mkr.valFreq(75)
             mkr.uomFreq('MHZ')
@@ -30,6 +43,11 @@ module AIXM
               mkr.valElev(z.alt)
               mkr.uomDistVer(z.unit.to_s)
             end
+            if schedule
+              mkr.Mtt do |mtt|
+                mtt << schedule.to_aixm(*extensions).indent(4)
+              end
+            end
             mkr.txtRmk(remarks) if remarks
             mkr.target!   # see https://github.com/jimweirich/builder/issues/42
           end