aixm 1.0.0 → 1.1.0

data/lib/aixm/component/approach_lighting.rb

@@ -0,0 +1,136 @@
+using AIXM::Refinements
+
+module AIXM
+  class Component
+
+    # Approach lighting system (ALS)
+    #
+    # ===Cheat Sheet in Pseudo Code:
+    #   approach_lighting = AIXM.approach_lighting(
+    #     type: TYPES
+    #   )
+    #   approach_lighting.length = AIXM.d or nil
+    #   approach_lighting.intensity = INTENSITIES or nil
+    #   approach_lighting.sequenced_flash = true or false or nil (means: unknown, default)
+    #   approach_lighting.flash_description = String or nil
+    #   approach_lighting.remarks = String or nil
+    #
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#rda-runway-direction-approach-lighting
+    class ApproachLighting < Component
+      include AIXM::Association
+      include AIXM::Memoize
+
+      TYPES = {
+        A: :cat_1,
+        B: :cat_2,
+        C: :cat_3,
+        D: :cat_2_and_3,
+        E: :simple,
+        F: :circling,
+        G: :alignment,
+        ALSAF: :high_intensity,
+        MALS: :medium_intensity,
+        MALSR: :medium_intensity_with_alignment,
+        SALS: :short,
+        SSALS: :simplified_short,
+        SSALR: :simplified_short_with_alignment,
+        LDIN: :lead_in,
+        ODALS: :omni_directional,
+        AFOVRN: :usaf_overrun,
+        MILOVRN: :military_overrun,
+        OTHER: :other   # specify in remarks
+      }.freeze
+
+      INTENSITIES = {
+        LIL: :low,
+        LIM: :medium,
+        LIH: :high,
+        OTHER: :other   # specify in remarks
+      }.freeze
+
+      # @!method approach_lightable
+      #   @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction] approach lighted entity
+      belongs_to :approach_lightable
+
+      # @return [Symbol, nil] type of the approach lighting system (see {TYPES})
+      attr_reader :type
+
+      # @return [AIXM::D, nil] length
+      attr_reader :length
+
+      # @return [Symbol, nil] intensity of lights (see {INTENSITIES})
+      attr_reader :intensity
+
+      # @return [Boolean, nil] whether sequenced flash is available
+      attr_reader :sequenced_flash
+
+      # @return [String, nil] description of the flash sequence
+      attr_reader :flash_description
+
+      # @return [String, nil] free text remarks
+      attr_reader :remarks
+
+      def initialize(type:)
+        self.type = type
+      end
+
+      # @return [String]
+      def inspect
+        %Q(#<#{self.class} type=#{type.inspect}>)
+      end
+
+      def type=(value)
+        @type = TYPES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid type")
+      end
+
+      def length=(value)
+        fail(ArgumentError, "invalid length") unless value.nil? || value.is_a?(AIXM::D)
+        @length = value
+      end
+
+      def intensity=(value)
+        @intensity = value.nil? ? nil : INTENSITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid intensity")
+      end
+
+      def sequenced_flash=(value)
+        fail(ArgumentError, "invalid sequenced flash") unless [true, false, nil].include? value
+        @sequenced_flash = value
+      end
+
+      def flash_description=(value)
+        @flash_description = value&.to_s
+      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 << approach_lightable.to_uid.indent(2)
+          tag.codeType(TYPES.key(type).to_s)
+        end
+      end
+      memoize :to_uid
+
+      # @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)
+          if length
+            tag.valLen(length.dim.round)
+            tag.uomLen(length.unit.to_s.upcase)
+          end
+          tag.codeIntst(INTENSITIES.key(intensity).to_s) if intensity
+          tag.codeSequencedFlash(sequenced_flash ? 'Y' : 'N') unless sequenced_flash.nil?
+          tag.txtDescrFlash(flash_description) if flash_description
+          tag.txtRmk(remarks) if remarks
+        end
+        builder.target!
+      end
+    end
+  end
+end

data/lib/aixm/component/fato.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
 
     # FATO (final approach and take-off area) for vertical take-off aircraft
     # such as helicopters.
@@ -10,8 +10,7 @@ module AIXM
     #   fato = AIXM.fato(
     #     name: String
     #   )
-    #   fato.length = AIXM.d or nil   # must use same unit as width
-    #   fato.width = AIXM.d or nil    # must use same unit as length
+    #   fato.dimensions = AIXM.r or nil
     #   fato.surface = AIXM.surface
     #   fato.marking = String or nil
     #   fato.profile = String or nil
@@ -20,12 +19,15 @@ module AIXM
     #   fato.add_direction(
     #     name: String
     #   ) do |direction|
-    #     direction.geographic_orientation = AIXM.a[precision=3] or nil
+    #     direction.geographic_bearing = AIXM.a or nil
+    #     direction.vasis = AIXM.vasis or nil (default: unspecified VASIS)
+    #     fato.add_lighting = AIXM.lighting
+    #     fato.add_approach_lighting = AIXM.approach_lighting
     #     direction.remarks = String or nil
     #   end
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#fto-fato
-    class FATO
+    class FATO < Component
       include AIXM::Association
       include AIXM::Memoize
 
@@ -40,12 +42,14 @@ module AIXM
 
       # @!method surface
       #   @return [AIXM::Component::Surface] surface of the FATO
+      #
       # @!method surface=(surface)
       #   @param surface [AIXM::Component::Surface]
       has_one :surface
 
       # @!method directions
       #   @return [Array<AIXM::Component::FATO::Direction>] maps added direction names to full FATO directions
+      #
       # @!method add_direction(direction)
       #   @param direction [AIXM::A] name of the FATO direction (e.g. "12" or "16L")
       #   @return [self]
@@ -62,11 +66,8 @@ module AIXM
       # @return [String] full name (e.g. "H1")
       attr_reader :name
 
-      # @return [AIXM::D, nil] length
-      attr_reader :length
-
-      # @return [AIXM::D, nil] width
-      attr_reader :width
+      # @return [AIXM::R, nil] dimensions
+      attr_reader :dimensions
 
       # @return [String, nil] markings
       attr_reader :marking
@@ -95,20 +96,9 @@ module AIXM
         @name = value.uptrans
       end
 
-      def length=(value)
-        @length = if value
-          fail(ArgumentError, "invalid length") unless value.is_a?(AIXM::D) && value.dist > 0
-          fail(ArgumentError, "invalid length unit") if width && width.unit != value.unit
-          @length = value
-        end
-      end
-
-      def width=(value)
-        @width = if value
-          fail(ArgumentError, "invalid width") unless value.is_a?(AIXM::D)  && value.dist > 0
-          fail(ArgumentError, "invalid width unit") if length && length.unit != value.unit
-          @width = value
-        end
+      def dimensions=(value)
+        fail(ArgumentError, "invalid dimensions") unless value.nil? || value.is_a?(AIXM::R)
+        @dimensions = value
       end
 
       def marking=(value)
@@ -142,10 +132,11 @@ module AIXM
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.Fto do |fto|
           fto << to_uid.indent(2)
-          fto.valLen(length.dist.trim) if length
-          fto.valWid(width.dist.trim) if width
-          fto.uomDim(length.unit.to_s.upcase) if length
-          fto.uomDim(width.unit.to_s.upcase) if width && !length
+          if dimensions
+            fto.valLen(dimensions.length.to_m.dim.trim)
+            fto.valWid(dimensions.width.to_m.dim.trim)
+            fto.uomDim('M')
+          end
           unless  (xml = surface.to_xml).empty?
             fto << xml.indent(2)
           end
@@ -169,10 +160,19 @@ module AIXM
 
         # @!method lightings
         #   @return [Array<AIXM::Component::Lighting>] installed lighting systems
+        #
         # @!method add_lighting(lighting)
         #   @param lighting [AIXM::Component::Lighting]
         has_many :lightings, as: :lightable
 
+        # @!method approach_lightings
+        #   @return [Array<AIXM::Component::ApproachLighting>] installed approach lighting systems
+        #
+        # @!method add_approach_lighting(approach_lighting)
+        #   @param approach_lighting [AIXM::Component::ApproachLighting]
+        #   @return [self]
+        has_many :approach_lightings, as: :approach_lightable
+
         # @!method fato
         #   @return [AIXM::Component::FATO] FATO the FATO direction is further describing
         belongs_to :fato
@@ -180,19 +180,24 @@ module AIXM
         # @return [AIXM::A] name of the FATO direction (e.g. "12" or "16L")
         attr_reader :name
 
-        # @return [AIXM::A, nil] geographic orientation (true bearing) in degrees
-        attr_reader :geographic_orientation
+        # @return [AIXM::A, nil] (true) geographic bearing in degrees
+        attr_reader :geographic_bearing
+
+        # @return [AIXM::Component::VASIS, nil] visual approach slope indicator
+        #   system
+        attr_reader :vasis
 
         # @return [String, nil] free text remarks
         attr_reader :remarks
 
         def initialize(name:)
           self.name = name
+          self.vasis = AIXM.vasis
         end
 
         # @return [String]
         def inspect
-          %Q(#<#{self.class} airport=#{fato&.airport&.id.inspect} name=#{name.inspect}>)
+          %Q(#<#{self.class} airport=#{fato&.airport&.id.inspect} name=#{name.to_s(:runway).inspect}>)
         end
 
         def name=(value)
@@ -200,29 +205,34 @@ module AIXM
           @name = AIXM.a(value)
         end
 
-        def geographic_orientation=(value)
-          return @geographic_orientation = nil if value.nil?
-          fail(ArgumentError, "invalid geographic orientation") unless value.is_a? AIXM::A
-          @geographic_orientation = value
+        def geographic_bearing=(value)
+          return @geographic_bearing = nil if value.nil?
+          fail(ArgumentError, "invalid geographic bearing") unless value.is_a? AIXM::A
+          @geographic_bearing = value
         end
 
         def remarks=(value)
           @remarks = value&.to_s
         end
 
-        # @return [AIXM::A] magnetic orientation (magnetic bearing) in degrees
-        def magnetic_orientation
-          if geographic_orientation && fato.airport.declination
-            geographic_orientation - fato.airport.declination
+        # @return [AIXM::A] magnetic bearing in degrees
+        def magnetic_bearing
+          if geographic_bearing && fato.airport.declination
+            geographic_bearing - fato.airport.declination
           end
         end
 
+        def vasis=(value)
+          fail(ArgumentError, "invalid vasis") unless value.nil? || value.is_a?(AIXM::Component::VASIS)
+          @vasis = value
+        end
+
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.FdnUid do |fdn_uid|
             fdn_uid << fato.to_uid.indent(2)
-            fdn_uid.txtDesig(name)
+            fdn_uid.txtDesig(name.to_s(:runway))
           end
         end
         memoize :to_uid
@@ -232,13 +242,19 @@ module AIXM
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Fdn do |fdn|
             fdn << to_uid.indent(2)
-            fdn.valTrueBrg(geographic_orientation) if geographic_orientation
-            fdn.valMagBrg(magnetic_orientation) if magnetic_orientation
+            fdn.valTrueBrg(geographic_bearing.to_s(:bearing)) if geographic_bearing
+            fdn.valMagBrg(magnetic_bearing.to_s(:bearing)) if magnetic_bearing
+            if vasis
+              fdn << vasis.to_xml.indent(2)
+            end
             fdn.txtRmk(remarks) if remarks
           end
           lightings.each do |lighting|
             builder << lighting.to_xml(as: :Fls)
           end
+          approach_lightings.each do |approach_lighting|
+            builder << approach_lighting.to_xml(as: :Fda)
+          end
           builder.target!
         end
       end

data/lib/aixm/component/frequency.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
 
     # Voice frequencies used by a service.
     #
@@ -21,7 +21,7 @@ module AIXM
     #   frequency.remarks = String or nil
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Organisation#fqy-frequency
-    class Frequency
+    class Frequency < Component
       include AIXM::Association
       include AIXM::Memoize
 

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
     class Geometry
 
       # Arcs are clockwise or counter clockwise circle segments around a

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
     class Geometry
 
       # Borders are following natural or artifical border lines referenced by

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
     class Geometry
 
       # Circles are defined by a {#center_xy} and a {#radius}.
@@ -41,7 +41,7 @@ module AIXM
         end
 
         def radius=(value)
-          fail(ArgumentError, "invalid radius") unless value.is_a?(AIXM::D) && value.dist > 0
+          fail(ArgumentError, "invalid radius") unless value.is_a?(AIXM::D) && value.dim > 0
           @radius = value
         end
 
@@ -64,7 +64,7 @@ module AIXM
         # and on the circumference of the circle.
         def north_xy
           AIXM.xy(
-            lat: center_xy.lat + radius.to_km.dist / (AIXM::XY::EARTH_RADIUS / 1000) * 180 / Math::PI,
+            lat: center_xy.lat + radius.to_km.dim / (AIXM::XY::EARTH_RADIUS / 1000) * 180 / Math::PI,
             long: center_xy.long
           )
         end

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
     class Geometry
 
       # Either an individual point or the starting point of a great circle

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
     class Geometry
 
       # Starting point of a rhumb line which describes a spiral on a sphere

data/lib/aixm/component/geometry.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
 
     # Geometries define a 3D airspace horizontally.
     #
@@ -26,7 +26,7 @@ module AIXM
     #   geometry.add_segment(AIXM.point(...))
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#avx-border-vertex
-    class Geometry
+    class Geometry < Component
       include AIXM::Association
 
       # @!method segments
@@ -35,6 +35,7 @@ module AIXM
       #     AIXM::Component::Geometry::Arc,
       #     AIXM::Component::Geometry::Circle,
       #     AIXM::Component::Geometry::Border>] points, rhumb lines, arcs, borders or circle
+      #
       # @!method add_segment(segment)
       #   @param segment [AIXM::Component::Geometry::Point,
       #     AIXM::Component::Geometry::RhumbLine,

data/lib/aixm/component/helipad.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
 
     # Helipads are TLOF (touch-down and lift-off areas) for vertical take-off
     # aircraft such as helicopters.
@@ -9,24 +9,24 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   helipad = AIXM.helipad(
     #     name: String
-    #     xy = AIXM.xy
+    #     xy: AIXM.xy
     #   )
     #   helipad.z = AIXM.z or nil
-    #   helipad.length = AIXM.d or nil   # must use same unit as width
-    #   helipad.width = AIXM.d or nil    # must use same unit as length
+    #   helipad.dimensions = AIXM.r or nil
     #   helipad.surface = AIXM.surface
     #   helipad.marking = String or nil
+    #   helipad.add_lighting = AIXM.lighting
     #   helipad.fato = AIXM.fato or nil
-    #   helipad.helicopter_class = HELICOPTER_CLASSES or nil
+    #   helipad.performance_class = PERFORMANCE_CLASSES or nil
     #   helipad.status = STATUSES or nil
     #   helipad.remarks = String or nil
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#tla-helipad-tlof
-    class Helipad
+    class Helipad < Component
       include AIXM::Association
       include AIXM::Memoize
 
-      HELICOPTER_CLASSES = {
+      PERFORMANCE_CLASSES = {
         '1': :'1',
         '2': :'2',
         '3': :'3',
@@ -44,18 +44,21 @@ module AIXM
 
       # @!method fato
       #   @return [AIXM::Component::FATO, nil] FATO the helipad is situated on
+      #
       # @!method fato=(fato)
       #   @param fato [AIXM::Component::FATO, nil]
       has_one :fato, allow_nil: true
 
       # @!method surface
       #   @return [AIXM::Component::Surface] surface of the helipad
+      #
       # @!method surface=(surface)
       #   @param surface [AIXM::Component::Surface]
-      has_one :surface
+      has_one :surface, accept: 'AIXM::Component::Surface'
 
       # @!method lightings
       #   @return [Array<AIXM::Component::Lighting>] installed lighting systems
+      #
       # @!method add_lighting(lighting)
       #   @param lighting [AIXM::Component::Lighting]
       #   @return [self]
@@ -74,17 +77,14 @@ module AIXM
       # @return [AIXM::Z, nil] elevation in +:qnh+
       attr_reader :z
 
-      # @return [AIXM::D, nil] length
-      attr_reader :length
-
-      # @return [AIXM::D, nil] width
-      attr_reader :width
+      # @return [AIXM::R, nil] dimensions
+      attr_reader :dimensions
 
       # @return [String, nil] markings
       attr_reader :marking
 
-      # @return [Integer, Symbol, nil] suitable helicopter class
-      attr_reader :helicopter_class
+      # @return [Integer, Symbol, nil] suitable performance class
+      attr_reader :performance_class
 
       # @return [Symbol, nil] status of the helipad (see {STATUSES}) or +nil+ for normal operation
       attr_reader :status
@@ -117,28 +117,17 @@ module AIXM
         @z = value
       end
 
-      def length=(value)
-        @length = if value
-          fail(ArgumentError, "invalid length") unless value.is_a?(AIXM::D) && value.dist > 0
-          fail(ArgumentError, "invalid length unit") if width && width.unit != value.unit
-          @length = value
-        end
-      end
-
-      def width=(value)
-        @width = if value
-          fail(ArgumentError, "invalid width") unless value.is_a?(AIXM::D)  && value.dist > 0
-          fail(ArgumentError, "invalid width unit") if length && length.unit != value.unit
-          @width = value
-        end
+      def dimensions=(value)
+        fail(ArgumentError, "invalid dimensions") unless value.nil? || value.is_a?(AIXM::R)
+        @dimensions = value
       end
 
       def marking=(value)
         @marking = value&.to_s
       end
 
-      def helicopter_class=(value)
-        @helicopter_class = value.nil? ? nil : (HELICOPTER_CLASSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid helicopter class"))
+      def performance_class=(value)
+        @performance_class = value.nil? ? nil : (PERFORMANCE_CLASSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid performance class"))
       end
 
       def status=(value)
@@ -172,14 +161,15 @@ module AIXM
             tla.valElev(z.alt)
             tla.uomDistVer(z.unit.upcase.to_s)
           end
-          tla.valLen(length.dist.trim) if length
-          tla.valWid(width.dist.trim) if width
-          tla.uomDim(length.unit.to_s.upcase) if length
-          tla.uomDim(width.unit.to_s.upcase) if width && !length
+          if dimensions
+            tla.valLen(dimensions.length.to_m.dim.trim)
+            tla.valWid(dimensions.width.to_m.dim.trim)
+            tla.uomDim('M')
+          end
           unless  (xml = surface.to_xml).empty?
             tla << xml.indent(2)
           end
-          tla.codeClassHel(HELICOPTER_CLASSES.key(helicopter_class).to_s) if helicopter_class
+          tla.codeClassHel(PERFORMANCE_CLASSES.key(performance_class).to_s) if performance_class
           tla.txtMarking(marking) if marking
           tla.codeSts(STATUSES.key(status).to_s) if status
           tla.txtRmk(remarks) if remarks

data/lib/aixm/component/layer.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
 
     # Each airspace has one or more layers with optional airspace class and
     # mandatory vertical limit.
@@ -16,10 +16,10 @@ module AIXM
     #   layer.timetable = AIXM.timetable or nil
     #   layer.selective = true or false (default)
     #   layer.remarks = String or nil
-    #   airspace.add_service(AIXM.service)
+    #   layer.add_service(AIXM.service)
     #
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace
-    class Layer
+    class Layer < Component
       include AIXM::Association
 
       CLASSES = (:A..:G).freeze
@@ -90,12 +90,14 @@ module AIXM
 
       # @!method vertical_limit
       #   @return [AIXM::Component::VerticalLimit] vertical limit of this layer
+      #
       # @!method vertical_limit=(vertical_limit)
       #   @param vertical_limit [AIXM::Component::VerticalLimit]
       has_one :vertical_limit
 
       # @!method services
       #   @return [Array<AIXM::Component::Service>] services
+      #
       # @!method add_service(service)
       #   @param service [AIXM::Component::Service]
       has_many :services

data/lib/aixm/component/lighting.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  module Component
+  class Component
 
     # Lighting of a runway, helipad etc
     #
@@ -17,7 +17,7 @@ module AIXM
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#rls-runway-direction-lighting
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#fls-fato-direction-lighting
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#tls-helipad-tlof-lighting
-    class Lighting
+    class Lighting < Component
       include AIXM::Association
       include AIXM::Memoize
 
@@ -38,14 +38,14 @@ module AIXM
         HOLDBAY: :taxyway_hold_bay,
         RTWYINT: :rapid_taxiway_intersection,
         OTHER: :other   # specify in remarks
-      }
+      }.freeze
 
       INTENSITIES = {
         LIL: :low,
         LIM: :medium,
         LIH: :high,
         OTHER: :other   # specify in remarks
-      }
+      }.freeze
 
       COLORS = {
         YEL: :yellow,
@@ -55,7 +55,7 @@ module AIXM
         GRN: :green,
         PRP: :purple,
         OTHER: :other   # specify in remarks
-      }
+      }.freeze
 
       # @!method lightable
       #   @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction, AIXM::Component::Helipad] lighted entity