aixm 0.3.7 → 1.0.0

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
     class Geometry
 
       # Borders are following natural or artifical border lines referenced by
@@ -13,8 +13,10 @@ module AIXM
       #     name: String
       #   )
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#frontier
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#frontier
       class Border < Point
+        include AIXM::Memoize
+
         # @return [String] name of the border
         attr_reader :name
 
@@ -33,13 +35,20 @@ module AIXM
           @name = value
         end
 
+        # @return [String] UID markup
+        def to_uid(as: :GbrUid)
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.tag!(as) do |tag|
+            tag.txtName(name.to_s)
+          end
+        end
+        memoize :to_uid
+
         # @return [String] AIXM or OFMX markup
         def to_xml
           builder = Builder::XmlMarkup.new(indent: 2)
           builder.Avx do |avx|
-            avx.GbrUid do |gbr_uid|
-              gbr_uid.txtName(name.to_s)
-            end
+            avx << to_uid.indent(2)
             avx.codeType('FNT')
             avx.geoLat(xy.lat(AIXM.schema))
             avx.geoLong(xy.long(AIXM.schema))

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

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
     class Geometry
 
       # Circles are defined by a {#center_xy} and a {#radius}.
@@ -12,8 +12,14 @@ module AIXM
       #     radius: AIXM.d
       #   )
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#circle
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#circle
       class Circle
+        include AIXM::Association
+
+        # @!method geometry
+        #   @return [AIXM::Component::Geometry] geometry this segment belongs to
+        belongs_to :geometry, as: :segment
+
         # @return [AIXM::XY] center point
         attr_reader :center_xy
 

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

@@ -1,18 +1,25 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
     class Geometry
 
-      # Points are defined by {#xy} coordinates.
+      # Either an individual point or the starting point of a great circle
+      # line. Defined by {#xy} coordinates.
       #
       # ===Cheat Sheet in Pseudo Code:
       #   point = AIXM.point(
       #     xy: AIXM.xy
       #   )
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#point
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#point
       class Point
+        include AIXM::Association
+
+        # @!method geometry
+        #   @return [AIXM::Component::Geometry] geometry this segment belongs to
+        belongs_to :geometry, as: :segment
+
         # @return [AIXM::XY] (starting) point
         attr_reader :xy
 

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

@@ -0,0 +1,54 @@
+using AIXM::Refinements
+
+module AIXM
+  module Component
+    class Geometry
+
+      # Starting point of a rhumb line which describes a spiral on a sphere
+      # crossing all meridians at the same angle. Defined by {#xy} coordinates.
+      #
+      # ===Cheat Sheet in Pseudo Code:
+      #   point = AIXM.rhumb_line(
+      #     xy: AIXM.xy
+      #   )
+      #
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#rhumb-line
+      class RhumbLine
+        include AIXM::Association
+
+        # @!method geometry
+        #   @return [AIXM::Component::Geometry] geometry this segment belongs to
+        belongs_to :geometry, as: :segment
+
+        # @return [AIXM::XY] (starting) point
+        attr_reader :xy
+
+        def initialize(xy:)
+          self.xy = xy
+        end
+
+        # @return [String]
+        def inspect
+          %Q(#<#{self.class} xy="#{xy}">)
+        end
+
+        def xy=(value)
+          fail(ArgumentError, "invalid xy") unless value.is_a? AIXM::XY
+          @xy = value
+        end
+
+        # @return [String] AIXM or OFMX markup
+        def to_xml
+          builder = Builder::XmlMarkup.new(indent: 2)
+          builder.Avx do |avx|
+            avx.codeType('RHL')
+            avx.geoLat(xy.lat(AIXM.schema))
+            avx.geoLong(xy.long(AIXM.schema))
+            avx.codeDatum('WGE')
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/aixm/component/geometry.rb

@@ -1,11 +1,9 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
-    # Geometries define a 3D airspace horizontally. It's either exactly one
-    # circle or at least three points, arcs and borders (the last of which
-    # has to be a point with the same coordinates as the first).
+    # Geometries define a 3D airspace horizontally.
     #
     # For a geometry to be valid, it must be comprised of either:
     # * exactly one point
@@ -15,7 +13,7 @@ module AIXM
     #
     # ===Cheat Sheet in Pseudo Code:
     #   geometry = AIXM.geometry
-    #   geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
+    #   geometry.add_segment(AIXM.point or AIXM.arc or AIXM.border or AIXM.circle)
     #
     # @example Built by passing elements to the initializer
     #   geometry = AIXM.geometry(
@@ -23,26 +21,35 @@ module AIXM
     #     AIXM.point(...)
     #   )
     #
-    # @example Built by adding elements
+    # @example Built by adding segments
     #   geometry = AIXM.geometry
-    #   geometry << AIXM.point(...)
-    #   geometry.concat [AIXM.point(...), AIXM.point(...), ...]
+    #   geometry.add_segment(AIXM.point(...))
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#avx-border-vertex
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#avx-border-vertex
     class Geometry
-      include Enumerable
-      extend Forwardable
+      include AIXM::Association
 
-      # @!method each
-      #   @return [Enumerator] see Array#each
-      # @!method <<
-      #   @return [Array] see Array#<<
-      # @!method concat
-      #   @return [Array] see Array#concat
-      def_delegators :@result_array, :each, :<<, :concat
+      # @!method segments
+      #   @return [Array<AIXM::Component::Geometry::Point,
+      #     AIXM::Component::Geometry::RhumbLine
+      #     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,
+      #     AIXM::Component::Geometry::Arc,
+      #     AIXM::Component::Geometry::Circle,
+      #     AIXM::Component::Geometry::Border]
+      #   @return [self]
+      has_many :segments, accept: %i(point rhumb_line arc circle border)
+
+      # @!method airspace
+      #   @return [AIXM::Feature::Airspace] airspace the geometry defines
+      belongs_to :airspace
 
       def initialize(*segments)
-        @result_array = segments
+        segments.each { add_segment(_1) }
       end
 
       # @return [String]
@@ -50,14 +57,6 @@ module AIXM
         %Q(#<#{self.class} segments=#{segments.count.inspect}>)
       end
 
-      # @return [Array<AIXM::Component::Geometry::Point,
-      #   AIXM::Component::Geometry::Arc,
-      #   AIXM::Component::Geometry::Border,
-      #   AIXM::Component::Geometry::Circle>] points, arcs, borders or circle
-      def segments
-        @result_array
-      end
-
       # @return [Boolean] whether the geometry is closed
       def closed?
         point? || circle? || polygon?
@@ -66,26 +65,27 @@ module AIXM
       # @return [String] AIXM or OFMX markup
       def to_xml
         fail(GeometryError.new("geometry is not closed", self)) unless closed?
-        @result_array.map { |h| h.to_xml }.join
+        segments.map { _1.to_xml }.join
       end
 
-      private
-
+      # @return [Boolean] Single point geometry?
       def point?
-        @result_array.size == 1 &&
-          @result_array.first.is_a?(AIXM::Component::Geometry::Point)
+        segments.size == 1 &&
+          segments.first.is_a?(AIXM::Component::Geometry::Point)
       end
 
+      # @return [Boolean] Circle shaped geometry?
       def circle?
-        @result_array.size == 1 &&
-          @result_array.first.is_a?(AIXM::Component::Geometry::Circle)
+        segments.size == 1 &&
+          segments.first.is_a?(AIXM::Component::Geometry::Circle)
       end
 
+      # @return [Boolean] Polygon shaped geometry?
       def polygon?
-        @result_array.size >= 3 &&
-          !@result_array.any? { |h| h.is_a?(AIXM::Component::Geometry::Circle) } &&
-          @result_array.last.is_a?(AIXM::Component::Geometry::Point) &&
-          @result_array.first.xy == @result_array.last.xy
+        segments.size >= 3 &&
+          !segments.any? { _1.is_a?(AIXM::Component::Geometry::Circle) } &&
+          segments.last.is_a?(AIXM::Component::Geometry::Point) &&
+          segments.first.xy == segments.last.xy
       end
     end
 

data/lib/aixm/component/helipad.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
     # Helipads are TLOF (touch-down and lift-off areas) for vertical take-off
     # aircraft such as helicopters.
@@ -21,8 +21,11 @@ module AIXM
     #   helipad.status = STATUSES or nil
     #   helipad.remarks = String or nil
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airport#tla-helipad-tlof
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#tla-helipad-tlof
     class Helipad
+      include AIXM::Association
+      include AIXM::Memoize
+
       HELICOPTER_CLASSES = {
         '1': :'1',
         '2': :'2',
@@ -39,8 +42,28 @@ module AIXM
         OTHER: :other                    # specify in remarks
       }.freeze
 
-      # @return [AIXM::Feature::Airport] airport this helipad belongs to
-      attr_reader :airport
+      # @!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
+
+      # @!method lightings
+      #   @return [Array<AIXM::Component::Lighting>] installed lighting systems
+      # @!method add_lighting(lighting)
+      #   @param lighting [AIXM::Component::Lighting]
+      #   @return [self]
+      has_many :lightings, as: :lightable
+
+      # @!method airport
+      #   @return [AIXM::Feature::Airport] airport this helipad belongs to
+      belongs_to :airport
 
       # @return [String] full name (e.g. "H1")
       attr_reader :name
@@ -57,15 +80,9 @@ module AIXM
       # @return [AIXM::D, nil] width
       attr_reader :width
 
-      # @return [AIXM::Component::Surface] surface of the helipad
-      attr_reader :surface
-
       # @return [String, nil] markings
       attr_reader :marking
 
-      # @return [AIXM::Component::FATO, nil] FATO the helipad is situated on
-      attr_reader :fato
-
       # @return [Integer, Symbol, nil] suitable helicopter class
       attr_reader :helicopter_class
 
@@ -75,13 +92,9 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      # @return [Array<AIXM::Component::Lighting>] installed lighting systems
-      attr_reader :lightings
-
       def initialize(name:, xy:)
         self.name, self.xy = name, xy
-        @surface = AIXM.surface
-        @lightings = []
+        self.surface = AIXM.surface
       end
 
       # @return [String]
@@ -89,12 +102,6 @@ module AIXM
         %Q(#<#{self.class} airport=#{airport&.id.inspect} name=#{name.inspect}>)
       end
 
-      def airport=(value)
-        fail(ArgumentError, "invalid airport") unless value.is_a? AIXM::Feature::Airport
-        @airport = value
-      end
-      private :airport=
-
       def name=(value)
         fail(ArgumentError, "invalid name") unless value.is_a? String
         @name = value.uptrans
@@ -130,11 +137,6 @@ module AIXM
         @marking = value&.to_s
       end
 
-      def fato=(value)
-        fail(ArgumentError, "invalid FATO") unless value.nil? || value.is_a?(AIXM::Component::FATO)
-        @fato = value
-      end
-
       def helicopter_class=(value)
         @helicopter_class = value.nil? ? nil : (HELICOPTER_CLASSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid helicopter class"))
       end
@@ -147,17 +149,6 @@ 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 [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
@@ -166,6 +157,7 @@ module AIXM
           tla_uid.txtDesig(name)
         end
       end
+      memoize :to_uid
 
       # @return [String] AIXM or OFMX markup
       def to_xml

data/lib/aixm/component/layer.rb

@@ -1,24 +1,27 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
     # Each airspace has one or more layers with optional airspace class and
-    # mandatory vertical limits.
+    # mandatory vertical limit.
     #
     # ===Cheat Sheet in Pseudo Code:
     #   layer = AIXM.layer(
     #     class: String or nil
     #     location_indicator: String or nil
-    #     vertical_limits: AIXM.vertical_limits
+    #     vertical_limit: AIXM.vertical_limit
     #   )
     #   layer.activity = String or nil
     #   layer.timetable = AIXM.timetable or nil
     #   layer.selective = true or false (default)
     #   layer.remarks = String or nil
+    #   airspace.add_service(AIXM.service)
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airspace
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace
     class Layer
+      include AIXM::Association
+
       CLASSES = (:A..:G).freeze
 
       ACTIVITIES = {
@@ -85,12 +88,25 @@ module AIXM
         OTHER: :other
       }.freeze
 
+      # @!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
+
+      # @!method airspace
+      #   @return [AIXM::Feature::Airspace] airspace the layer defines
+      belongs_to :airspace
+
       # @return [String, nil] four letter location identifier as published in the ICAO DOC 7910
       attr_reader :location_indicator
 
-      # @return [AIXM::Component::VerticalLimits] vertical limits of this layer
-      attr_reader :vertical_limits
-
       # @return [String, nil] primary activity (e.g. "GLIDER")
       attr_reader :activity
 
@@ -100,21 +116,19 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(class: nil, location_indicator: nil, vertical_limits:)
+      def initialize(class: nil, location_indicator: nil, vertical_limit:)
         self.class = binding.local_variable_get(:class)
-        self.location_indicator, self.vertical_limits = location_indicator, vertical_limits
+        self.location_indicator, self.vertical_limit = location_indicator, vertical_limit
         self.selective = false
       end
 
       # @return [String]
       def inspect
-        %Q(#<#{original_class} class=#{@klass.inspect}>)
+        %Q(#<#{__class__} class=#{@klass.inspect}>)
       end
 
       # @!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
@@ -129,11 +143,6 @@ module AIXM
         @location_indicator = value&.uptrans
       end
 
-      def vertical_limits=(value)
-        fail(ArgumentError, "invalid vertical limits") unless value.is_a? AIXM::Component::VerticalLimits
-        @vertical_limits = value
-      end
-
       def activity=(value)
         @activity = value.nil? ? nil : ACTIVITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid activity")
       end
@@ -164,9 +173,9 @@ module AIXM
         builder.codeClass(self.class.to_s) if self.class
         builder.codeLocInd(location_indicator) if location_indicator
         if activity
-          builder.codeActivity(ACTIVITIES.key(activity).to_s.then_if(AIXM.aixm?) { |a| { 'AIRMODEL' => 'UAV', 'WINCH' => 'GLIDER' }[a] || a })
+          builder.codeActivity(ACTIVITIES.key(activity).to_s.then_if(AIXM.aixm?) { { 'AIRMODEL' => 'UAV', 'WINCH' => 'GLIDER' }[_1] || _1 })
         end
-        builder << vertical_limits.to_xml
+        builder << vertical_limit.to_xml
         builder << timetable.to_xml(as: :Att) if timetable
         builder.codeSelAvbl(selective? ? 'Y' : 'N') if AIXM.ofmx?
         builder.txtRmk(remarks) if remarks

data/lib/aixm/component/lighting.rb

@@ -1,7 +1,7 @@
 using AIXM::Refinements
 
 module AIXM
-  class Component
+  module Component
 
     # Lighting of a runway, helipad etc
     #
@@ -14,10 +14,13 @@ module AIXM
     #   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
+    # @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
+      include AIXM::Association
+      include AIXM::Memoize
+
       POSITIONS = {
         TDZ: :touch_down_zone,
         AIM: :aiming_point,
@@ -54,8 +57,9 @@ module AIXM
         OTHER: :other   # specify in remarks
       }
 
-      # @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction, AIXM::Component::Helipad] lighted entity
-      attr_reader :lightable
+      # @!method lightable
+      #   @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction, AIXM::Component::Helipad] lighted entity
+      belongs_to :lightable
 
       # @return [Symbol, nil] position of the lighting system (see {POSITIONS})
       attr_reader :position
@@ -81,12 +85,6 @@ module AIXM
         %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
@@ -115,6 +113,7 @@ module AIXM
           tag.codePsn(POSITIONS.key(position).to_s)
         end
       end
+      memoize :to_uid
 
       # @return [String] AIXM or OFMX markup
       def to_xml(as:)