aixm 0.3.5 → 0.3.6

data/lib/aixm/component/layer.rb

@@ -111,10 +111,10 @@ module AIXM
         %Q(#<#{original_class} class=#{@klass.inspect}>)
       end
 
-      alias_method :original_class, :class
-
       # @!attribute class
+      # @note Use +original_class+ to query the Ruby object class.
       # @return [Symbol] class of layer (see {CLASSES})
+      alias_method :original_class, :class
       def class
         @klass
       end

data/lib/aixm/component/lighting.rb

@@ -0,0 +1,133 @@
+using AIXM::Refinements
+
+module AIXM
+  class Component
+
+    # Lighting of a runway, helipad etc
+    #
+    # ===Cheat Sheet in Pseudo Code:
+    #   lighting = AIXM.lighting(
+    #     position: POSITIONS
+    #   )
+    #   lighting.description = String or nil
+    #   lighting.intensity = INTENSITIES or nil
+    #   lighting.color = COLORS or nil
+    #   lighting.remarks = String or nil
+    #
+    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#rls-runway-direction-lighting
+    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#fls-fato-direction-lighting
+    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#tls-helipad-tlof-lighting
+    class Lighting
+      POSITIONS = {
+        TDZ: :touch_down_zone,
+        AIM: :aiming_point,
+        CL: :center_line,
+        EDGE: :edge,
+        THR: :threshold,
+        SWYEDGE: :stopway_edge,
+        DESIG: :runway_designation,
+        AFTTHR: :after_threshold,
+        DISPTHR: :displaced_threshold,
+        SWYCL: :stopway_center_line,
+        END: :runway_end,
+        SWYEND: :stopway_end,
+        TWYINT: :taxiway_intersection,
+        HOLDBAY: :taxyway_hold_bay,
+        RTWYINT: :rapid_taxiway_intersection,
+        OTHER: :other   # specify in remarks
+      }
+
+      INTENSITIES = {
+        LIL: :low,
+        LIM: :medium,
+        LIH: :high,
+        OTHER: :other   # specify in remarks
+      }
+
+      COLORS = {
+        YEL: :yellow,
+        RED: :red,
+        WHI: :white,
+        BLU: :blue,
+        GRN: :green,
+        PRP: :purple,
+        OTHER: :other   # specify in remarks
+      }
+
+      # @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction, AIXM::Component::Helipad] lighted entity
+      attr_reader :lightable
+
+      # @return [Symbol, nil] position of the lighting system (see {POSITIONS})
+      attr_reader :position
+
+      # @return [String, nil] detailed description
+      attr_reader :description
+
+      # @return [Symbol, nil] intensity of lights (see {INTENSITIES})
+      attr_reader :intensity
+
+      # @return [Symbol, nil] color of lights (see {COLORS})
+      attr_reader :color
+
+      # @return [String, nil] free text remarks
+      attr_reader :remarks
+
+      def initialize(position:)
+        self.position = position
+      end
+
+      # @return [String]
+      def inspect
+        %Q(#<#{self.class} position=#{position.inspect}>)
+      end
+
+      def lightable=(value)
+        fail(ArgumentError, "invalid lightable") unless value.respond_to? :lightings
+        @lightable = value
+      end
+      private :lightable=
+
+      def position=(value)
+        @position = POSITIONS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid position")
+      end
+
+      def description=(value)
+        @description = value&.to_s
+      end
+
+      def intensity=(value)
+        @intensity = value.nil? ? nil : INTENSITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid intensity")
+      end
+
+      def color=(value)
+        @color = value.nil? ? nil : COLORS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid color")
+      end
+
+      def remarks=(value)
+        @remarks = value&.to_s
+      end
+
+      # @return [String] UID markup
+      def to_uid(as:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(as) do |tag|
+          tag << lightable.to_uid.indent(2)
+          tag.codePsn(POSITIONS.key(position).to_s)
+        end
+      end
+
+      # @return [String] AIXM or OFMX markup
+      def to_xml(as:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(as) do |tag|
+          tag << to_uid(as: "#{as}Uid").indent(2)
+          tag.txtDescr(description) if description
+          tag.codeIntst(INTENSITIES.key(intensity).to_s) if intensity
+          tag.codeColour(COLORS.key(color).to_s) if color
+          tag.txtRmk(remarks) if remarks
+        end
+        builder.target!
+      end
+    end
+  end
+end

data/lib/aixm/component/runway.rb

@@ -157,8 +157,9 @@ module AIXM
           rwy.txtRmk(remarks) if remarks
         end
         %i(@forth @back).each do |direction|
-          direction = instance_variable_get(direction)
-          builder << direction.to_xml if direction
+          if direction = instance_variable_get(direction)
+            builder << direction.to_xml
+          end
         end
         builder.target!
       end
@@ -200,8 +201,12 @@ module AIXM
         # @return [String, nil] free text remarks
         attr_reader :remarks
 
+        # @return [Array<AIXM::Component::Lighting>] installed lighting systems
+        attr_reader :lightings
+
         def initialize(runway:, name:)
           self.runway, self.name = runway, name
+          @lightings = []
         end
 
         # @return [String]
@@ -258,6 +263,17 @@ module AIXM
           @remarks = value&.to_s
         end
 
+        # Add a lighting system to the runway direction.
+        #
+        # @param lighting [AIXM::Component::Lighting] lighting instance
+        # @return [self]
+        def add_lighting(lighting)
+          fail(ArgumentError, "invalid lighting") unless lighting.is_a? AIXM::Component::Lighting
+          lighting.send(:lightable=, self)
+          @lightings << lighting
+          self
+        end
+
         # @return [AIXM::A] magnetic orientation (magnetic bearing) in degrees
         def magnetic_orientation
           if geographic_orientation && runway.airport.declination
@@ -265,14 +281,20 @@ module AIXM
           end
         end
 
+        # @return [String] UID markup
+        def to_uid
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.RdnUid do |rdn_uid|
+            rdn_uid << runway.to_uid.indent(2)
+            rdn_uid.txtDesig(name)
+          end
+        end
+
         # @return [String] AIXM or OFMX markup
         def to_xml
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Rdn do |rdn|
-            rdn.RdnUid do |rdn_uid|
-              rdn_uid << runway.to_uid.indent(4)
-              rdn_uid.txtDesig(name)
-            end
+            rdn << to_uid.indent(2)
             rdn.geoLat(xy.lat(AIXM.schema))
             rdn.geoLong(xy.long(AIXM.schema))
             rdn.valTrueBrg(geographic_orientation) if geographic_orientation
@@ -299,6 +321,9 @@ module AIXM
               rdd.txtRmk(remarks) if remarks
             end
           end
+          lightings.each do |lighting|
+            builder << lighting.to_xml(as: :Rls)
+          end
           builder.target!
         end
       end

data/lib/aixm/component/surface.rb

@@ -6,12 +6,15 @@ module AIXM
     # Surface of a runway, helipad etc
     #
     # ===Cheat Sheet in Pseudo Code:
-    #   surface = AIXM.surfaceservice(
+    #   surface = AIXM.surface(
     #     composition: COMPOSITIONS or nil
     #     preparation: PREPARATIONS or nil
     #     condition: CONDITIONS or nil
     #   )
-    #   surface.pcn = String
+    #   surface.pcn = String or nil
+    #   surface.siwl_weight = AIXM.w
+    #   surface.siwl_tire_pressure = AIXM.p
+    #   surface.auw_weight = AIXM.w
     #   surface.remarks = String or nil
     #
     # ===Constants:
@@ -24,11 +27,15 @@ module AIXM
         ASPH: :asphalt,
         BITUM: :bitumen,        # dug up, bound and rolled ground
         CONC: :concrete,
+        'CONC+ASPH': :concrete_and_asphalt,
+        'CONC+GRS': :concrete_and_grass,
         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
+        METAL: :metal,
         SAND: :sand,
+        SNOW: :snow,
         WATER: :water,
         OTHER: :other           # specify in remarks
       }
@@ -61,6 +68,15 @@ module AIXM
       # @return [Symbol, nil] condition of the surface (see {CONDITIONS})
       attr_reader :condition
 
+      # @return [AIXM::W, nil] single isolated wheel load weight
+      attr_reader :siwl_weight
+
+      # @return [AIXM::P, nil] single isolated wheel load tire pressure
+      attr_reader :siwl_tire_pressure
+
+      # @return [AIXM::W, nil] all-up wheel weight
+      attr_reader :auw_weight
+
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
@@ -96,6 +112,21 @@ module AIXM
         @pcn = match.named_captures.reject{ |k| k == 'pcn' }
       end
 
+      def siwl_weight=(value)
+        fail(ArgumentError, "invalid siwl_weight") unless value.nil? || value.is_a?(AIXM::W)
+        @siwl_weight = value
+      end
+
+      def siwl_tire_pressure=(value)
+        fail(ArgumentError, "invalid siwl_tire_pressure") unless value.nil? || value.is_a?(AIXM::P)
+        @siwl_tire_pressure = value
+      end
+
+      def auw_weight=(value)
+        fail(ArgumentError, "invalid auw_weight") unless value.nil? || value.is_a?(AIXM::W)
+        @auw_weight = value
+      end
+
       def remarks=(value)
         @remarks = value&.to_s
       end
@@ -114,6 +145,18 @@ module AIXM
           builder.codePcnEvalMethod(@pcn['evaluation_method'])
         end
         builder.txtPcnNote(@remarks) if remarks
+        if siwl_weight
+          builder.valSiwlWeight(siwl_weight.wgt.trim)
+          builder.uomSiwlWeight(siwl_weight.unit.to_s.upcase)
+        end
+        if siwl_tire_pressure
+          builder.valSiwlTirePressure(siwl_tire_pressure.pres.trim)
+          builder.uomSiwlTirePressure(siwl_tire_pressure.unit.to_s.upcase)
+        end
+        if auw_weight
+          builder.valAuwWeight(auw_weight.wgt.trim)
+          builder.uomAuwWeight(auw_weight.unit.to_s.upcase)
+        end
         builder.target!
       end
     end

data/lib/aixm/d.rb

@@ -18,7 +18,7 @@ module AIXM
     }.freeze
 
     # @!method zero?
-    #   @return [Boolean] whether length is zero
+    #   @return [Boolean] whether distance is zero
     def_delegator :@dist, :zero?
 
     # @return [Float] distance
@@ -56,7 +56,7 @@ module AIXM
     # @!method to_km
     # @!method to_m
     # @!method to_nm
-    # @return [AIXM::d] convert distance
+    # @return [AIXM::D] convert distance
     UNITS.each_key do |target_unit|
       define_method "to_#{target_unit}" do
         return self if unit == target_unit
@@ -67,7 +67,7 @@ module AIXM
     # @see Object#<=>
     # @return [Integer]
     def <=>(other)
-      to_m.dist <=> other.to_m.dist
+      dist <=> other.send(:"to_#{unit}").dist
     end
 
     # @see Object#==

data/lib/aixm/document.rb

@@ -15,6 +15,8 @@ module AIXM
   #
   # @see https://github.com/openflightmaps/ofmx/wiki/Snapshot
   class Document
+    REGION_RE = /\A[A-Z]{2}\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
@@ -43,7 +45,7 @@ module AIXM
     end
 
     def region=(value)
-      fail(ArgumentError, "invalid region") unless value.nil? || value.is_a?(String)
+      fail(ArgumentError, "invalid region") unless value.nil? || value&.upcase&.match?(REGION_RE)
       @region = value&.upcase
     end
 

data/lib/aixm/feature/airport.rb

@@ -20,12 +20,17 @@ module AIXM
     #   airport.declination = Float or nil
     #   airport.transition_z = AIXM.z or nil
     #   airport.timetable = AIXM.timetable or nil
+    #   airport.operator = String or nil
     #   airport.remarks = String or nil
     #   airport.add_runway(AIXM.runway)
+    #   airport.add_fato(AIXM.fato)
     #   airport.add_helipad(AIXM.helipad)
     #   airport.add_usage_limitation(UsageLimitation::TYPES)
     #   airport.add_address(AIXM.address)
     #
+    # For airports without an +id+, you may assign the two character region
+    # (e.g. "LF") which will be combined with an 8 character digest of +name+.
+    #
     # @see https://github.com/openflightmaps/ofmx/wiki/Airport#ahp-airport
     class Airport < Feature
       public_class_method :new
@@ -79,12 +84,18 @@ module AIXM
       # @return [AIXM::Component::Timetable, nil] operating hours
       attr_reader :timetable
 
+      # @return [String, nil] operator of the airport
+      attr_reader :operator
+
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
       # @return [Array<AIXM::Component::Runway>] runways present at this airport
       attr_reader :runways
 
+      # @return [Array<AIXM::Component::FATO>] FATOs present at this airport
+      attr_reader :fatos
+
       # @return [Array<AIXM::Component::Helipad>] helipads present at this airport
       attr_reader :helipads
 
@@ -94,10 +105,10 @@ module AIXM
       # @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:)
+      def initialize(source: nil, organisation:, id: nil, name:, xy:)
         super(source: source)
         self.organisation, self.id, self.name, self.xy = organisation, id, name, xy
-        @runways, @helipads, @usage_limitations, @addresses = [], [], [], []
+        @runways, @fatos, @helipads, @usage_limitations, @addresses = [], [], [], [], []
       end
 
       # @return [String]
@@ -110,8 +121,11 @@ module AIXM
         @organisation = value
       end
 
+      # For airports without an +id+, you may assign the two character region
+      # (e.g. "LF") which will be combined with an 8 character digest of +name+.
       def id=(value)
-        fail(ArgumentError, "invalid id `#{id}'") unless value&.upcase&.match? ID_RE
+        value = [value, [name].to_digest].join.upcase if value&.upcase&.match? AIXM::Document::REGION_RE
+        fail(ArgumentError, "invalid id") unless value&.upcase&.match? ID_RE
         @id = value.upcase
       end
 
@@ -134,9 +148,9 @@ module AIXM
       def type
         @type = case
           when @type then @type
-          when runways.any? && helipads.any? then :aerodrome_and_heliport
+          when runways.any? && (helipads.any? || fatos.any?) then :aerodrome_and_heliport
           when runways.any? then :aerodrome
-          when helipads.any? then :heliport
+          when helipads.any? || fatos.any? then :heliport
         end
       end
 
@@ -172,6 +186,11 @@ module AIXM
         @timetable = value
       end
 
+      def operator=(value)
+        fail(ArgumentError, "invalid name") unless value.nil? || value.is_a?(String)
+        @operator = value&.uptrans
+      end
+
       def remarks=(value)
         @remarks = value&.to_s
       end
@@ -187,6 +206,17 @@ module AIXM
         self
       end
 
+      # Add a FATO to the airport.
+      #
+      # @param FATO [AIXM::Component::FATO] FATO instance
+      # @return [self]
+      def add_fato(fato)
+        fail(ArgumentError, "invalid FATO") unless fato.is_a? AIXM::Component::FATO
+        fato.send(:airport=, self)
+        @fatos << fato
+        self
+      end
+
       # Add a helipad to the airport.
       #
       # @param helipad [AIXM::Component::Helipad] helipad instance
@@ -272,6 +302,7 @@ module AIXM
             ahp.uomDistVer(z.unit.upcase.to_s)
           end
           ahp.valMagVar(declination) if declination
+          ahp.txtNameAdmin(operator) if operator
           if transition_z
             ahp.valTransitionAlt(transition_z.alt)
             ahp.uomTransitionAlt(transition_z.unit.upcase.to_s)
@@ -282,6 +313,9 @@ module AIXM
         runways.each do |runway|
           builder << runway.to_xml
         end
+        fatos.each do |fato|
+          builder << fato.to_xml
+        end
         helipads.each do |helipad|
           builder << helipad.to_xml
         end