aixm 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe9565888ad7ed4bcf509211380c7b7102551ebe9ae30a3aa18810e51eb6c30
-  data.tar.gz: 4b2d98978eeedb786c6df9ee15d1a58965da68661e8e8fe3e74706d5f2d403bc
+  metadata.gz: 893b141929be3f77025e38496a060f415c2262e48d0ef102ad4da84e601e4ff4
+  data.tar.gz: fb65d43a1d2493b1ceadffdf9c8a0671cb8bb46dc5be026c538d9f86435620da
 SHA512:
-  metadata.gz: 0437a116319aaa8aef2bb8107b6d86481686a735734ba172ed451cc73924389fb4a160d518d87d817ef7a79f84c3388b9d39f3d925bab8329b93c84e3b92c1bb
-  data.tar.gz: c8fdeec76012ffe37a66096f6e57f620ea9a2c0b731ff569f8b325fec2a315cdab74080ddf53553880c5acfa7df17b24059047dd935802821c0d637955cc54ec
+  metadata.gz: 9104a9562a75872c26780e711f2744c7717c1349901ad89e661ea08cf444b00de5fa344c314c9cfc082b12e3e9a8247553af1c225a21f2f85a75924a1136b432
+  data.tar.gz: 4ce0eb72f3e26fde3aee41175771f83718d8dc2c4818fef1bcd6eaa47ae54d7f26d40d19df39ee449acdd2da0516a82ae552acb3c3ddfd90d224b4e41c49a50b

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 Nothing so far
 
+## 1.4.0
+
+#### Additions
+* Runways include the center line from edge to edge as two `Rcp` features if
+  the center line is known (bidirectional runway) or can be calculated
+  (unidirectional runway with known dimensions).
+* `Airspace#alternative_name` (OFMX only)
+* `Helipad#geographic_bearing` (OFMX only)
+* `AIXM::L` for lines with optional elevation profile
+* Refinement `Numeric#to_deg`
+* `AIXM::XY#bearing` and `AIXM::XY@add_distance`
+
+#### Breaking Changes
+* Up until now, `Rdn->geoLat` and `Rdn->geoLong` were set to the THR. This
+  change sets them to the DTHR if any.
+* `Runway::Direction#displaced_threshold=` fails when set as distance unless
+  `Runway::Direction#xy` and `Runway::Direction#bearing` are known.
+* `Runway::Direction#displaced_threshold` always returns coordinates.
+
+#### Changes
+* `Document#created_at` and similar accept local times and convert them to UTC
+  when the XML is generated.
+* Moved refinements `Float#to_dms` and `Float#to_rad` to `Numeric`
+
 ## 1.3.4
 
 #### Additions

data/lib/aixm/classes.rb

@@ -6,6 +6,7 @@ module AIXM
     xy: 'AIXM::XY',
     z: 'AIXM::Z',
     d: 'AIXM::D',
+    l: 'AIXM::L',
     r: 'AIXM::R',
     f: 'AIXM::F',
     a: 'AIXM::A',

data/lib/aixm/component/helipad.rb

@@ -11,6 +11,7 @@ module AIXM
     #     name: String
     #     xy: AIXM.xy
     #   )
+    #   helipad.geographic_bearing = AIXM.a or nil (OFMX only)
     #   helipad.z = AIXM.z or nil
     #   helipad.dimensions = AIXM.r or nil
     #   helipad.surface = AIXM.surface
@@ -77,6 +78,9 @@ module AIXM
       #   @param value [String]
       attr_reader :name
 
+      # @return [AIXM::A, nil] (true) geographic bearing of H-marking in degrees
+      attr_reader :geographic_bearing
+
       # Center point
       #
       # @overload center_xy
@@ -135,6 +139,12 @@ module AIXM
         @name = value.uptrans
       end
 
+      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 xy=(value)
         fail(ArgumentError, "invalid xy") unless value.is_a? AIXM::XY
         @xy = value
@@ -174,6 +184,7 @@ module AIXM
           tla.geoLat(xy.lat(AIXM.schema))
           tla.geoLong(xy.long(AIXM.schema))
           tla.codeDatum('WGE')
+          tla.valTrueBrg(geographic_bearing.to_s(:bearing)) if AIXM.ofmx? && geographic_bearing
           if z
             tla.valElev(z.alt)
             tla.uomDistVer(z.unit.upcase)

data/lib/aixm/component/runway.rb

@@ -23,9 +23,11 @@ module AIXM
     #   runway.remarks = String or nil
     #   runway.forth.name = AIXM.a   # preset based on the runway name
     #   runway.forth.geographic_bearing = AIXM.a or nil
-    #   runway.forth.xy = AIXM.xy
-    #   runway.forth.z = AIXM.z or nil   # highest point of the TDZ
-    #   runway.forth.displaced_threshold = AIXM.xy or AIXM.d or nil
+    #   runway.forth.xy = AIXM.xy   # center point at beginning edge of runway
+    #   runway.forth.z = AIXM.z or nil   # center point at beginning edge of runway
+    #   runway.forth.touch_down_zone_z = AIXM.z or nil
+    #   runway.forth.displaced_threshold = AIXM.d or nil       # sets displaced_threshold_xy as well
+    #   runway.forth.displaced_threshold_xy = AIXM.xy or nil   # sets displaced_threshold as well
     #   runway.forth.vasis = AIXM.vasis or nil (default: unspecified VASIS)
     #   runway.forth.add_lighting = AIXM.lighting
     #   runway.forth.add_approach_lighting = AIXM.approach_lighting
@@ -143,6 +145,25 @@ module AIXM
         @status = value.nil? ? nil : (STATUSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid status"))
       end
 
+      # Center line of the runway
+      #
+      # The center line of unidirectional runwawys is calculated using the
+      # runway dimensions. If they are unknown, the calculation is not possible
+      # and this method returns +nil+.
+      #
+      # @return [AIXM::L, nil]
+      def center_line
+        if back || dimensions
+          AIXM.l.add_line_point(
+            xy: forth.xy,
+            z: forth.z
+          ).add_line_point(
+            xy: (back&.xy || forth.xy.add_distance(dimensions.length, forth.geographic_bearing)),
+            z: back&.z
+          )
+        end
+      end
+
       # @!visibility private
       def add_uid_to(builder)
         builder.RwyUid do |rwy_uid|
@@ -165,6 +186,20 @@ module AIXM
           rwy.txtMarking(marking) if marking
           rwy.txtRmk(remarks) if remarks
         end
+        center_line.line_points.each do |line_point|
+          builder.Rcp do |rcp|
+            rcp.RcpUid do |rcp_uid|
+              add_uid_to(rcp)
+              rcp.geoLat(line_point.xy.lat(AIXM.schema))
+              rcp.geoLong(line_point.xy.long(AIXM.schema))
+            end
+            rcp.codeDatum('WGE')
+            if line_point.z
+              rcp.valElev(line_point.z.alt)
+              rcp.uomDistVer(line_point.z.unit.upcase)
+            end
+          end
+        end
         %i(@forth @back).each do |direction|
           if direction = instance_variable_get(direction)
             direction.add_to(builder)
@@ -197,7 +232,8 @@ module AIXM
         has_many :lightings, as: :lightable
 
         # @!method approach_lightings
-        #   @return [Array<AIXM::Component::ApproachLighting>] installed approach lighting systems
+        #   @return [Array<AIXM::Component::ApproachLighting>] installed approach
+        #     lighting systems
         #
         # @!method add_approach_lighting(approach_lighting)
         #   @param approach_lighting [AIXM::Component::ApproachLighting]
@@ -205,7 +241,8 @@ module AIXM
         has_many :approach_lightings, as: :approach_lightable
 
         # @!method runway
-        #   @return [AIXM::Component::Runway] runway the runway direction is further describing
+        #   @return [AIXM::Component::Runway] runway the runway direction is
+        #     further describing
         belongs_to :runway, readonly: true
 
         # Partial name of runway (e.g. "12" or "16L")
@@ -219,17 +256,22 @@ module AIXM
         # @return [AIXM::A, nil] (true) geographic bearing in degrees
         attr_reader :geographic_bearing
 
-        # @return [AIXM::XY] beginning point (middle of the runway width)
+        # @return [AIXM::XY] center point at the beginning edge of the runway
         attr_reader :xy
 
-        # @return [AIXM::Z, nil] elevation of the touch down zone in +qnh+
+        # @return [AIXM::Z, nil] elevation of the center point at the beginning
+        #   edge of the runway in +qnh+
         attr_reader :z
 
-        # @return [AIXM::XY, AIXM::D, nil] displaced threshold point either as
-        #   coordinates (AIXM::XY) or distance (AIXM::D) from the beginning
-        #   point
+        # @return [AIXM::Z, nil] elevation of the touch down zone in +qnh+
+        attr_reader :touch_down_zone_z
+
+        # @return [AIXM::D, nil] displaced threshold distance from edge of runway
         attr_reader :displaced_threshold
 
+        # @return [AIXM::XY, nil] displaced threshold point
+        attr_reader :displaced_threshold_xy
+
         # @return [AIXM::Component::VASIS, nil] visual approach slope indicator
         #   system
         attr_reader :vasis
@@ -270,17 +312,31 @@ module AIXM
           @z = value
         end
 
+        def touch_down_zone_z=(value)
+          fail(ArgumentError, "invalid touch_down_zone_z") unless value.nil? || (value.is_a?(AIXM::Z) && value.qnh?)
+          @touch_down_zone_z = value
+        end
+
         def displaced_threshold=(value)
-          case value
-          when AIXM::XY
-            @displaced_threshold = @xy.distance(value)
-          when AIXM::D
-            fail(ArgumentError, "invalid displaced threshold") unless value.dim > 0
+          if value
+            fail(ArgumentError, "invalid displaced threshold") unless value.is_a?(AIXM::D) && value.dim > 0
+            fail(RuntimeError, "xy required to calculate displaced threshold xy") unless xy
+            fail(RuntimeError, "geographic bearing required to calculate displaced threshold xy") unless geographic_bearing
             @displaced_threshold = value
-          when NilClass
-            @displaced_threshold = nil
+            @displaced_threshold_xy = xy.add_distance(value, geographic_bearing)
+          else
+            @displaced_threshold = @displaced_threshold_xy = nil
+          end
+        end
+
+        def displaced_threshold_xy=(value)
+          if value
+            fail(ArgumentError, "invalid displaced threshold xy") unless value.is_a? AIXM::XY
+            fail(RuntimeError, "xy required to calculate displaced threshold") unless xy
+            @displaced_threshold_xy = value
+            @displaced_threshold = xy.distance(value)
           else
-            fail(ArgumentError, "invalid displaced threshold")
+            @displaced_threshold = @displaced_threshold_xy = nil
           end
         end
 
@@ -300,6 +356,11 @@ module AIXM
           end
         end
 
+        # @return [AIXM::XY] displaced threshold if any or edge of runway otherwise
+        def threshold_xy
+          displaced_threshold_xy || xy
+        end
+
         # @!visibility private
         def add_uid_to(builder)
           builder.RdnUid do |rdn_uid|
@@ -312,13 +373,13 @@ module AIXM
         def add_to(builder)
           builder.Rdn do |rdn|
             add_uid_to(rdn)
-            rdn.geoLat(xy.lat(AIXM.schema))
-            rdn.geoLong(xy.long(AIXM.schema))
+            rdn.geoLat(threshold_xy.lat(AIXM.schema))
+            rdn.geoLong(threshold_xy.long(AIXM.schema))
             rdn.valTrueBrg(geographic_bearing.to_s(:bearing)) if geographic_bearing
             rdn.valMagBrg(magnetic_bearing.to_s(:bearing)) if magnetic_bearing
-            if z
-              rdn.valElevTdz(z.alt)
-              rdn.uomElevTdz(z.unit.upcase)
+            if touch_down_zone_z
+              rdn.valElevTdz(touch_down_zone_z.alt)
+              rdn.uomElevTdz(touch_down_zone_z.unit.upcase)
             end
             vasis.add_to(rdn) if vasis
             rdn.codeVfrPattern(VFR_PATTERNS.key(vfr_pattern)) if vfr_pattern

data/lib/aixm/document.rb

@@ -80,7 +80,6 @@ module AIXM
 
     def created_at=(value)
       @created_at = if time = value&.to_time
-        fail(ArgumentError, "must be UTC") unless time.utc_offset.zero?
         time.round
       else
         Time.now.utc.round
@@ -89,7 +88,6 @@ module AIXM
 
     def effective_at=(value)
       @effective_at = if time = value&.to_time
-        fail(ArgumentError, "must be UTC") unless time.utc_offset.zero?
         time.round
       else
         created_at || Time.now.utc.round
@@ -99,7 +97,6 @@ module AIXM
     def expiration_at=(value)
       @expiration_at = value&.to_time
       @expiration_at = if time = value&.to_time
-        fail(ArgumentError, "must be UTC") unless time.utc_offset.zero?
         time.round
       end
     end
@@ -164,9 +161,9 @@ module AIXM
         origin: "rubygem aixm-#{AIXM::VERSION}",
         namespace: (namespace if AIXM.ofmx?),
         regions: (regions.join(' '.freeze) if AIXM.ofmx?),
-        created: @created_at.xmlschema,
-        effective: @effective_at.xmlschema,
-        expiration: (@expiration_at&.xmlschema if AIXM.ofmx?)
+        created: @created_at.utc.xmlschema,
+        effective: @effective_at.utc.xmlschema,
+        expiration: (@expiration_at&.utc&.xmlschema if AIXM.ofmx?)
       }.compact
       Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |builder|
         builder.send(AIXM.schema(:root), meta) do |root|

data/lib/aixm/feature/airspace.rb

@@ -14,6 +14,7 @@ module AIXM
     #     local_type: String or nil
     #     name: String or nil
     #   )
+    #   airspace.alternative_name = String (OFMX only)
     #   airspace.comment = Object or nil
     #   airspace.add_layer(AIXM.layer)
     #   airspace.geometry.add_segment(AIXM.point or AIXM.arc or AIXM.border or AIXM.circle)
@@ -132,6 +133,14 @@ module AIXM
       #   @param value [String, nil]
       attr_reader :name
 
+      # Alternative name (e.g. "LF P 81")
+      #
+      # @overload alternative_name
+      #   @return [String, nil]
+      # @overload alternative_name=(value)
+      #   @param value [String, nil]
+      attr_reader :alternative_name
+
       # See the {cheat sheet}[AIXM::Feature::Airspace] for examples on how to
       # create instances of this class.
       def initialize(source: nil, region: nil, id: nil, type:, local_type: nil, name: nil)
@@ -167,6 +176,11 @@ module AIXM
         @name = value&.uptrans
       end
 
+      def alternative_name=(value)
+        fail(ArgumentError, "invalid alternative name") unless value.nil? || value.is_a?(String)
+        @alternative_name = value&.uptrans
+      end
+
       # @!visibility private
       def add_uid_to(builder, as: :AseUid)
         builder.send(as, ({ region: (region if AIXM.ofmx?) }.compact)) do |tag|
@@ -193,6 +207,7 @@ module AIXM
           add_uid_to(ase)
           ase.txtLocalType(local_type) if AIXM.aixm? && local_type && local_type != name
           ase.txtName(name) if name
+          ase.txtNameAlt(alternative_name) if AIXM.ofmx? && alternative_name
           layers.first.add_to(ase) unless layered?
         end
         builder.Abd do |abd|

data/lib/aixm/feature/obstacle.rb

@@ -363,8 +363,8 @@ module AIXM
               linked_to.add_uid_to(obs, as: :ObsUidLink)
               obs.codeLinkType(LINK_TYPES.key(link_type))
             end
-            obs.datetimeValidWef(valid_from.xmlschema) if valid_from
-            obs.datetimeValidTil(valid_until.xmlschema) if valid_until
+            obs.datetimeValidWef(valid_from.utc.xmlschema) if valid_from
+            obs.datetimeValidTil(valid_until.utc.xmlschema) if valid_until
           end
           obs.txtRmk(remarks) if remarks
         end

data/lib/aixm/l.rb

@@ -0,0 +1,61 @@
+module AIXM
+
+  # Geographical line with optional profile
+  #
+  # Each line point is an OStruct which can be queried for its coordinates with
+  # `.xy` or its optional elevation with `.z`
+  #
+  # @example All of the below are equivalent
+  #   line = AIXM.l   # or:
+  #   line = AIXM.l(xy: AIXM.xy(...), z: AIXM.z(...))
+  #   line.add_line_point(xy: AIXM.xy(...), z: AIXM.z(...))
+  #   line.line_points.first.xy   # => AIXM::XY
+  #   line.line_points.first.z    # => AIXM::Z
+  class L
+
+    # Array of line points
+    #
+    # @return [Array<OStruct>]
+    attr_reader :line_points
+
+    # See the {overview}[AIXM::L] for examples.
+    def initialize(xy: nil, z: nil)
+      @line_points = []
+      add_line_point(xy: xy, z: z) if xy
+    end
+
+    # @return [String]
+    def inspect
+      %Q(#<#{self.class} #{to_s}>)
+    end
+
+    # @return [String] human readable representation
+    def to_s
+      line_points.map { _1.to_h.values.map(&:to_s).join(' ') }.join(', ')
+    end
+
+    # Add a line point to the line
+    #
+    # @param xy [AIXM::XY] coordinates
+    # @param z [AIXM::Z, nil] elevation
+    # @return [self]
+    def add_line_point(xy:, z: nil)
+      fail(ArgumentError, "invalid xy") unless xy.instance_of?(AIXM::XY)
+      fail(ArgumentError, "invalid z") unless !z || z.instance_of?(AIXM::Z)
+      line_points << OpenStruct.new(xy: xy, z: z)
+      self
+    end
+
+    # Whether there are enough line points to define a line
+    #
+    # @return [Boolean]
+    def line?
+      line_points.count >= 2
+    end
+
+    # @see Object#==
+    def ==(other)
+      self.class === other && to_s == other.to_s
+    end
+  end
+end

data/lib/aixm/refinements.rb

@@ -53,7 +53,7 @@ module AIXM
     #   @note This is a refinement for +Float+
     #   @param padding [Integer] number of digits for the degree part
     #   @return [String] angle in DMS notation +{-}D°MM'SS.SS"+
-    refine Float do
+    refine Numeric do
       def to_dms(padding=3)
         degrees = self.abs.floor
         minutes = ((self.abs - degrees) * 60).floor
@@ -69,6 +69,21 @@ module AIXM
       end
     end
 
+    # @!method to_deg
+    #   Convert an angle from radian to degrees.
+    #
+    #   @example
+    #     0.5.to_rad
+    #     # => 28.6478897565
+    #
+    #   @note This is a refinement for +Float+
+    #   @return [Float] angle in degrees
+    refine Numeric do
+      def to_deg
+        180 * self / Math::PI
+      end
+    end
+
     # @!method to_rad
     #   Convert an angle from degree to radian.
     #
@@ -77,8 +92,8 @@ module AIXM
     #     # => 0.7853981633974483
     #
     #   @note This is a refinement for +Float+
-    #   @return [Float] radian angle
-    refine Float do
+    #   @return [Float] angle in radian
+    refine Numeric do
       def to_rad
         self * Math::PI / 180
       end

data/lib/aixm/version.rb

@@ -1,3 +1,3 @@
 module AIXM
-  VERSION = "1.3.4".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/aixm/xy.rb

@@ -31,7 +31,7 @@ module AIXM
   class XY
     include AIXM::Concerns::HashEquality
 
-    EARTH_RADIUS = 6_371_008.8
+    EARTH_RADIUS = 6_371_008.8   # meters
 
     # See the {overview}[AIXM::XY] for examples.
     def initialize(lat:, long:)
@@ -105,7 +105,7 @@ module AIXM
       AIXM.point(xy: self)
     end
 
-    # Distance as calculated by the Haversine formula
+    # Distance to another point as calculated by the Haversine formula
     #
     # @return [AIXM::D]
     def distance(other)
@@ -123,6 +123,38 @@ module AIXM
       end
     end
 
+    # Bearing to another point
+    #
+    # @return [AIXM::A]
+    def bearing(other)
+      fail "cannot calculate bearing to identical point" if self == other
+      delta_long = other.long.to_rad - long.to_rad
+      AIXM.a(
+        Math.atan2(
+          Math.cos(other.lat.to_rad) * Math.sin(delta_long),
+          Math.cos(lat.to_rad) * Math.sin(other.lat.to_rad) -
+            Math.sin(lat.to_rad) * Math.cos(other.lat.to_rad) *
+            Math.cos(delta_long)
+        ).to_deg
+      )
+    end
+
+    # Calculate a new point by adding the distance in the given bearing
+    #
+    # @return [AIXM::XY]
+    def add_distance(distance, bearing)
+      angular_dist = distance.to_m.dim / EARTH_RADIUS
+      dest_lat = Math.asin(
+        Math.sin(lat.to_rad) * Math.cos(angular_dist) +
+        Math.cos(lat.to_rad) * Math.sin(angular_dist) * Math.cos(bearing.to_f.to_rad)
+      )
+      dest_long = long.to_rad + Math.atan2(
+        Math.sin(bearing.to_f.to_rad) * Math.sin(angular_dist) * Math.cos(lat.to_rad),
+        Math.cos(angular_dist) - Math.sin(lat.to_rad) * Math.sin(dest_lat)
+      )
+      AIXM.xy(lat: dest_lat.to_deg, long: dest_long.to_deg)
+    end
+
     # @see Object#==
     def ==(other)
       self.class === other && lat == other.lat && long == other.long

data/lib/aixm.rb

@@ -36,6 +36,7 @@ require_relative 'aixm/document'
 require_relative 'aixm/xy'
 require_relative 'aixm/z'
 require_relative 'aixm/d'
+require_relative 'aixm/l'
 require_relative 'aixm/r'
 require_relative 'aixm/f'
 require_relative 'aixm/a'