aixm 0.3.7 → 1.0.0

data/lib/aixm/feature/airspace.rb

@@ -8,13 +8,14 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   airspace = AIXM.airspace(
     #     source: String or nil
+    #     region: String or nil
     #     id: String or nil   # nil is converted to an 8 character digest
     #     type: String or Symbol
     #     local_type: String or nil
     #     name: String or nil
     #   )
-    #   airspace.geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
-    #   airspace.layers << AIXM.layer
+    #   airspace.add_layer(AIXM.layer)
+    #   airspace.geometry.add_segment(AIXM.point or AIXM.arc or AIXM.border or AIXM.circle)
     #
     # The +id+ is mandatory, however, you may omit it when initializing a new
     # airspace or assign +nil+ to an existing airspace which will generate a 8
@@ -27,8 +28,11 @@ module AIXM
     #
     #   airspace= AIXM.airspace(type: :regulated_airspace, local_type: "RMZ")
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Airspace#ase-airspace
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#ase-airspace
     class Airspace < Feature
+      include AIXM::Association
+      include AIXM::Memoize
+
       public_class_method :new
 
       TYPES = {
@@ -74,6 +78,18 @@ module AIXM
         PART: :part_of_airspace
       }.freeze
 
+      # @!method geometry
+      #   @return [AIXM::Component::Geometry] horizontal geometry shape
+      # @!method geometry=(geometry)
+      #   @param geometry [AIXM::Component::Geometry]
+      has_one :geometry
+
+      # @!method layers
+      #   @return [Array<AIXM::Compoment::Layer>] vertical layers
+      # @!method add_layer(layer)
+      #   @param layer [AIXM::Compoment::Layer]
+      has_many :layers
+
       # @note When assigning +nil+, a 4 byte hex derived from {#type}, {#name}
       #   and {#local_type} is written instead.
       # @return [String] published identifier (e.g. "LFP81")
@@ -90,18 +106,11 @@ module AIXM
       # @return [String, nil] full name (e.g. "LF P 81 CHERBOURG")
       attr_reader :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, id: nil, type:, local_type: nil, name: nil)
-        super(source: source)
+      def initialize(source: nil, region: nil, id: nil, type:, local_type: nil, name: nil)
+        super(source: source, region: region)
         self.type, self.local_type, self.name = type, local_type, name
         self.id = id
-        @geometry = AIXM.geometry
-        @layers = []
+        self.geometry = AIXM.geometry
       end
 
       # @return [String]
@@ -133,9 +142,19 @@ module AIXM
       # @return [String] UID markup
       def to_uid(as: :AseUid)
         builder = Builder::XmlMarkup.new(indent: 2)
-        builder.tag!(as) do |tag|
+        builder.tag!(as, ({ region: (region if AIXM.ofmx?) }.compact)) do |tag|
           tag.codeType(TYPES.key(type).to_s)
           tag.codeId(id)
+          tag.txtLocalType(local_type) if AIXM.ofmx? && local_type && local_type != name
+        end
+      end
+      memoize :to_uid
+
+      # @return [String] UID markup
+      def to_wrapped_uid(as: :AseUid, with:)
+        builder = Builder::XmlMarkup.new(indent: 2)
+        builder.tag!(with) do |tag|
+          tag << to_uid(as: as).indent(2)
         end
       end
 
@@ -148,32 +167,45 @@ module AIXM
         builder.comment! "Airspace: [#{TYPES.key(type)}] #{name || :UNNAMED}"
         builder.Ase({ source: (source if AIXM.ofmx?) }.compact) do |ase|
           ase << to_uid.indent(2)
-          ase.txtLocalType(local_type) if local_type && local_type != name
+          ase.txtLocalType(local_type) if AIXM.aixm? && local_type && local_type != name
           ase.txtName(name) if name
           unless layered?
             ase << layers.first.to_xml.indent(2)
           end
         end
         builder.Abd do |abd|
-          abd.AbdUid do |abd_uid|
-            abd_uid << to_uid.indent(4)
-          end
+          abd << to_wrapped_uid(with: :AbdUid).indent(2)
           abd << geometry.to_xml.indent(2)
         end
         if layered?
           layers.each.with_index do |layer, index|
-            layer_airspace = AIXM.airspace(type: 'CLASS', name: "#{name} LAYER #{index + 1}")
+            layer_airspace = AIXM.airspace(region: region, type: 'CLASS', name: "#{name} LAYER #{index + 1}")
             builder.Ase do |ase|
               ase << layer_airspace.to_uid.indent(2)
               ase.txtName(layer_airspace.name)
               ase << layers[index].to_xml.indent(2)
             end
             builder.Adg do |adg|
-              adg.AdgUid do |adg_uid|
-                adg_uid << layer_airspace.to_uid.indent(4)
-              end
+              adg << layer_airspace.to_wrapped_uid(with: :AdgUid).indent(2)
               adg << to_uid(as: :AseUidSameExtent).indent(2)
             end
+            layer.services.each do |service|
+              builder.Sae do |sae|
+                sae.SaeUid do |sae_uid|
+                  sae_uid << service.to_uid.indent(4)
+                  sae_uid << layer_airspace.to_uid.indent(4)
+                end
+              end
+            end
+          end
+        else
+          layers.first.services.each do |service|
+            builder.Sae do |sae|
+              sae.SaeUid do |sae_uid|
+                sae_uid << service.to_uid.indent(4)
+                sae_uid << to_uid.indent(4)
+              end
+            end
           end
         end
         builder.target!
@@ -184,7 +216,6 @@ module AIXM
       def layered?
         layers.count > 1
       end
-
     end
   end
 end

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

@@ -10,6 +10,7 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   designated_point = AIXM.designated_point(
       #     source: String or nil
+      #     region: String or nil
       #     id: String
       #     name: String or nil
       #     xy: AIXM.xy
@@ -18,11 +19,12 @@ module AIXM
       #   designated_point.airport = AIXM.airport or nil
       #   designated_point.remarks = String or nil
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#dpn-designated-point
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#dpn-designated-point
       class DesignatedPoint < NavigationalAid
+        include AIXM::Association
+        include AIXM::Memoize
+
         public_class_method :new
-        private :organisation=
-        private :organisation
 
         TYPES = {
           ICAO: :icao,                                 # five-letter ICAO id
@@ -35,15 +37,15 @@ module AIXM
           OTHER: :other                                # specify in remarks
         }.freeze
 
-        # @return [Symbol] type of designated point
-        attr_reader :type
-
         # @return [AIXM::Feature::Airport] airport this designated point is
         #   associated with
-        attr_reader :airport
+        belongs_to :airport
+
+        # @return [Symbol] type of designated point
+        attr_reader :type
 
         def initialize(type:, **arguments)
-          super(organisation: false, z: nil, **arguments)
+          super(organisation: nil, z: nil, **arguments)
           self.type = type
         end
 
@@ -51,20 +53,16 @@ module AIXM
           @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
         end
 
-        def airport=(value)
-          fail(ArgumentError, "invalid airport") unless value.nil? || value.is_a?(AIXM::Feature::Airport)
-          @airport = value
-        end
-
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.DpnUid do |dpn_uid|
+          builder.DpnUid({ region: (region if AIXM.ofmx?) }.compact) do |dpn_uid|
             dpn_uid.codeId(id)
             dpn_uid.geoLat(xy.lat(AIXM.schema))
             dpn_uid.geoLong(xy.long(AIXM.schema))
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml

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

@@ -12,6 +12,7 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   dme = AIXM.dme(
       #     source: String or nil
+      #     region: String or nil
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -22,18 +23,21 @@ module AIXM
       #   dme.timetable = AIXM.timetable or nil
       #   dme.remarks = String or nil
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#dme-dme
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#dme-dme
       class DME < NavigationalAid
+        include AIXM::Memoize
+
         public_class_method :new
 
         CHANNEL_RE = /\A([1-9]|[1-9]\d|1[0-1]\d|12[0-6])[XY]\z/.freeze
 
+        # @!method vor
+        #   @return [AIXM::Feature::NavigationalAid::VOR, nil] associated VOR
+        belongs_to :vor, readonly: true
+
         # @return [String] radio channel
         attr_reader :channel
 
-        # @return [AIXM::Feature::NavigationalAid::VOR, nil] associated VOR
-        attr_reader :vor
-
         def initialize(channel:, **arguments)
           super(**arguments)
           self.channel = channel
@@ -60,21 +64,16 @@ module AIXM
           end
         end
 
-        def vor=(value)
-          fail(ArgumentError, "invalid VOR") unless value.is_a? VOR
-          @vor = value
-        end
-        private :vor=
-
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.DmeUid do |dme_uid|
+          builder.DmeUid({ region: (region if AIXM.ofmx?) }.compact) do |dme_uid|
             dme_uid.codeId(id)
             dme_uid.geoLat(xy.lat(AIXM.schema))
             dme_uid.geoLong(xy.long(AIXM.schema))
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml

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

@@ -11,6 +11,7 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   marker = AIXM.marker(
       #     source: String or nil
+      #     region: String or nil
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -24,8 +25,10 @@ module AIXM
       # @note Marker are not fully implemented because they usually have to be
       #   associated with an ILS which are not implemented as of now.
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#mkr-marker-beacon
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#mkr-marker-beacon
       class Marker < NavigationalAid
+        include AIXM::Memoize
+        
         public_class_method :new
 
         TYPES = {
@@ -53,12 +56,13 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.MkrUid do |mkr_uid|
+          builder.MkrUid({ region: (region if AIXM.ofmx?) }.compact) do |mkr_uid|
             mkr_uid.codeId(id)
             mkr_uid.geoLat(xy.lat(AIXM.schema))
             mkr_uid.geoLong(xy.long(AIXM.schema))
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml

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

@@ -10,6 +10,7 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   ndb = AIXM.ndb(
       #     source: String or nil
+      #     region: String or nil
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -21,8 +22,10 @@ module AIXM
       #   ndb.timetable = AIXM.timetable or nil
       #   ndb.remarks = String or nil
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#ndb-ndb
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#ndb-ndb
       class NDB < NavigationalAid
+        include AIXM::Memoize
+        
         public_class_method :new
 
         TYPES = {
@@ -55,12 +58,13 @@ module AIXM
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.NdbUid do |ndb_uid|
+          builder.NdbUid({ region: (region if AIXM.ofmx?) }.compact) do |ndb_uid|
             ndb_uid.codeId(id)
             ndb_uid.geoLat(xy.lat(AIXM.schema))
             ndb_uid.geoLong(xy.long(AIXM.schema))
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml

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

@@ -11,6 +11,7 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   tacan = AIXM.tacan(
       #     source: String or nil
+      #     region: String or nil
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -21,19 +22,22 @@ module AIXM
       # tacan.timetable = AIXM.timetable or nil
       # tacan.remarks = String or nil
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#tcn-tacan
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#tcn-tacan
       class TACAN < DME
+        include AIXM::Memoize
+        
         public_class_method :new
 
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.TcnUid do |tcn_uid|
+          builder.TcnUid({ region: (region if AIXM.ofmx?) }.compact) do |tcn_uid|
             tcn_uid.codeId(id)
             tcn_uid.geoLat(xy.lat(AIXM.schema))
             tcn_uid.geoLong(xy.long(AIXM.schema))
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml

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

@@ -11,6 +11,7 @@ module AIXM
       # ===Cheat Sheet in Pseudo Code:
       #   vor = AIXM.vor(
       #     source: String or nil
+      #     region: String or nil
       #     organisation: AIXM.organisation
       #     id: String
       #     name: String
@@ -25,8 +26,10 @@ module AIXM
       #   vor.associate_dme(channel: String)     # turns the VOR into a VOR/DME
       #   vor.associate_tacan(channel: String)   # turns the VOR into a VORTAC
       #
-      # @see https://github.com/openflightmaps/ofmx/wiki/Navigational-aid#vor-vor
+      # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#vor-vor
       class VOR < NavigationalAid
+        include AIXM::Memoize
+        
         public_class_method :new
 
         TYPES = {
@@ -42,6 +45,18 @@ module AIXM
           OTHER: :other        # specify in remarks
         }.freeze
 
+        # @!method dme
+        #   @return [AIXM::Feature::NavigationalAid::DME, nil] associated DME
+        # @!method dme=(dme)
+        #   @param dme [AIXM::Feature::NavigationalAid::DME, nil]
+        has_one :dme, allow_nil: true
+
+        # @!method tacan
+        #   @return [AIXM::Feature::NavigationalAid::TACAN, nil] associated TACAN
+        # @!method tacan=(tacan)
+        #   @param tacan [AIXM::Feature::NavigationalAid::TACAN, nil]
+        has_one :tacan, allow_nil: true
+
         # @return [Symbol] type of VOR (see {TYPES})
         attr_reader :type
 
@@ -51,12 +66,6 @@ module AIXM
         # @return [Symbol] north indication (see {NORTHS})
         attr_reader :north
 
-        # @return [AIXM::Feature::NavigationalAid::DME, nil] associated DME
-        attr_reader :dme
-
-        # @return [AIXM::Feature::NavigationalAid::TACAN, nil] associated TACAN
-        attr_reader :tacan
-
         def initialize(type:, f:, north:, **arguments)
           super(**arguments)
           self.type, self.f, self.north = type, f, north
@@ -77,27 +86,26 @@ 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.timetable, @dme.remarks = timetable, remarks
-          @dme.send(:vor=, self)
+          self.dme = AIXM.dme(region: region, organisation: organisation, id: id, name: name, xy: xy, z: z, channel: channel)
+          dme.timetable, @dme.remarks = timetable, remarks
         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.timetable, @tacan.remarks = timetable, remarks
-          @tacan.send(:vor=, self)
+          self.tacan = AIXM.tacan(region: region, organisation: organisation, id: id, name: name, xy: xy, z: z, channel: channel)
+          tacan.timetable, @tacan.remarks = timetable, remarks
         end
 
         # @return [String] UID markup
         def to_uid
           builder = Builder::XmlMarkup.new(indent: 2)
-          builder.VorUid do |vor_uid|
+          builder.VorUid({ region: (region if AIXM.ofmx?) }.compact) do |vor_uid|
             vor_uid.codeId(id)
             vor_uid.geoLat(xy.lat(AIXM.schema))
             vor_uid.geoLong(xy.long(AIXM.schema))
           end
         end
+        memoize :to_uid
 
         # @return [String] AIXM or OFMX markup
         def to_xml

data/lib/aixm/feature/navigational_aid.rb

@@ -5,10 +5,13 @@ module AIXM
 
     # @abstract
     class NavigationalAid < Feature
+      include AIXM::Association
+
       private_class_method :new
 
-      # @return [AIXM::Feature::Organisation] superior organisation
-      attr_reader :organisation
+      # @!method organisation
+      #   @return [AIXM::Feature::Organisation] superior organisation
+      belongs_to :organisation, as: :member
 
       # @return [String] published identifier
       attr_reader :id
@@ -28,8 +31,8 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      def initialize(source: nil, organisation:, id:, name: nil, xy:, z: nil)
-        super(source: source)
+      def initialize(source: nil, region: nil, organisation:, id:, name: nil, xy:, z: nil)
+        super(source: source, region: region)
         self.organisation, self.id, self.name, self.xy, self.z = organisation, id, name, xy, z
       end
 
@@ -38,11 +41,6 @@ module AIXM
         %Q(#<#{self.class} id=#{id.inspect} name=#{name.inspect}>)
       end
 
-      def organisation=(value)
-        fail(ArgumentError, "invalid organisation") unless value == false || value.is_a?(AIXM::Feature::Organisation)
-        @organisation = value
-      end
-
       def id=(value)
         fail(ArgumentError, "invalid id") unless value.is_a? String
         @id = value.upcase

data/lib/aixm/feature/obstacle.rb

@@ -9,11 +9,12 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   obstacle = AIXM.obstacle(
     #     source: String or nil
+    #     region: String or nil
     #     name: String or nil
     #     type: TYPES
     #     xy: AIXM.xy
     #     z: AIXM.z
-    #     radius: AIXM.d
+    #     radius: AIXM.d or nil
     #   )
     #   obstacle.lighting = true or false (default for AIXM) or nil (means: unknown, default for OFMX)
     #   obstacle.lighting_remarks = String or nil
@@ -34,10 +35,15 @@ module AIXM
     #
     # Please note: As soon as an obstacle is added to an obstacle group, the
     # +xy_accuracy+ and +z_accuracy+ of the obstacle group overwrite whatever
-    # is set on the individual obstacles!
+    # is set on the individual obstacles. On the other hand, if the obstacle
+    # group has no +source+ set, it will inherit this value from the first
+    # obstacle in the group.
     #
-    # @see https://github.com/openflightmaps/ofmx/wiki/Obstacle
+    # @see https://gitlab.com/openflightmaps/ofmx/wikis/Obstacle
     class Obstacle < Feature
+      include AIXM::Association
+      include AIXM::Memoize
+
       public_class_method :new
 
       TYPES = {
@@ -57,6 +63,10 @@ module AIXM
         OTHER: :other
       }.freeze
 
+      # @!method obstacle_group
+      #   @return [AIXM::Feature::ObstacleGroup] group this obstacle belongs to
+      belongs_to :obstacle_group
+
       # @return [String] full name
       attr_reader :name
 
@@ -108,24 +118,21 @@ module AIXM
       # @return [String, nil] free text remarks
       attr_reader :remarks
 
-      # @return [AIXM::Feature::ObstacleGroup] group this obstacle belongs to
-      attr_reader :obstacle_group
-
       # @return [Symbol, nil] another obstacle to which a physical link exists
       attr_reader :linked_to
 
       # @return [Symbol, nil] type of physical link between this and another obstacle
       attr_reader :link_type
 
-      def initialize(source: nil, name: nil, type:, xy:, z:, radius:)
-        super(source: source)
+      def initialize(source: nil, region: nil, name: nil, type:, xy:, z:, radius: nil)
+        super(source: source, region: region)
         self.name, self.type, self.xy, self.z, self.radius = name, type, xy, z, radius
-        @lighting = @marking = @height_accurate = false
+        @lighting = @marking = false
       end
 
       # @return [String]
       def inspect
-        %Q(#<#{self.class} xy="#{xy.to_s}" type=#{type.inspect}>)
+        %Q(#<#{self.class} xy="#{xy.to_s}" type=#{type.inspect} name=#{name.inspect}>)
       end
 
       def name=(value)
@@ -202,12 +209,6 @@ module AIXM
         @remarks = value&.to_s
       end
 
-      def obstacle_group=(value)
-        fail(ArgumentError, "invalid obstacle group") unless value.is_a?(AIXM::Feature::ObstacleGroup)
-        @obstacle_group = value
-      end
-      private :obstacle_group=
-
       def linked_to=(value)
         fail(ArgumentError, "invalid linked to") unless value.is_a?(AIXM::Feature::Obstacle)
         @linked_to = value
@@ -231,7 +232,7 @@ module AIXM
 
       # @return [String] UID markup
       def to_uid(as: :ObsUid)
-        self.obstacle_group ||= singleton_obstacle_group
+        obstacle_group = self.obstacle_group || singleton_obstacle_group
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.tag!(as) do |tag|
           tag << obstacle_group.to_uid.indent(2) if AIXM.ofmx?
@@ -239,14 +240,15 @@ module AIXM
           tag.geoLong((xy.long(AIXM.schema)))
         end
       end
+      memoize :to_uid
 
       # @return [String] AIXM or OFMX markup
       def to_xml(delegate: true)
-        self.obstacle_group ||= singleton_obstacle_group
+        obstacle_group = self.obstacle_group || singleton_obstacle_group
         return obstacle_group.to_xml if delegate && AIXM.ofmx?
         builder = Builder::XmlMarkup.new(indent: 2)
         builder.comment! "Obstacle: [#{type}] #{xy.to_s} #{name}".strip
-        builder.Obs do |obs|
+        builder.Obs({ source: (source if AIXM.ofmx?) }.compact) do |obs|
           obs << to_uid.indent(2)
           obs.txtName(name) if name
           if AIXM.ofmx?
@@ -298,7 +300,7 @@ module AIXM
       # OFMX requires single, ungrouped obstacles to be the only member of a
       # singleton obstacle group.
       def singleton_obstacle_group
-        AIXM.obstacle_group.add_obstacle self
+        AIXM.obstacle_group(region: region).add_obstacle self
       end
 
     end