aixm 1.1.0 → 1.2.0

data/lib/aixm/f.rb

@@ -7,6 +7,7 @@ module AIXM
   # @example
   #   AIXM.f(123.35, :mhz)
   class F
+    include AIXM::Concerns::HashEquality
     extend Forwardable
 
     UNITS = %i(ghz mhz khz).freeze
@@ -15,12 +16,23 @@ module AIXM
     #   @return [Boolean] whether frequency is zero
     def_delegator :@freq, :zero?
 
-    # @return [Float] frequency
+    # Frequency
+    #
+    # @overload freq
+    #   @return [Float]
+    # @overload freq=(value)
+    #   @param value [Float]
     attr_reader :freq
 
-    # @return [Symbol] unit (see {UNITS})
+    # Unit
+    #
+    # @overload unit
+    #   @return [Symbol] any of {UNITS}
+    # @overload unit=(value)
+    #   @param value [Symbol] any of {UNITS}
     attr_reader :unit
 
+    # See the {overview}[AIXM::F] for examples.
     def initialize(freq, unit)
       self.freq, self.unit = freq, unit
     end
@@ -46,26 +58,22 @@ module AIXM
       fail(ArgumentError, "invalid unit") unless UNITS.include? @unit
     end
 
-    # @return [Boolean] whether this frequency is part of a frequency band
+    # Whether this frequency is part of a frequency band.
+    #
+    # @return [Boolean]
     def between?(lower_freq, upper_freq, unit)
       freq.between?(lower_freq, upper_freq) && self.unit == unit
     end
 
     # @see Object#==
-    # @return [Boolean]
     def ==(other)
       self.class === other && freq == other.freq && unit == other.unit
     end
-    alias_method :eql?, :==
-
-    # @see Object#hash
-    # @return [Integer]
-    def hash
-      to_s.hash
-    end
 
-    # @return [Boolean] whether this frequency is part of the voice airband
-    #   for civil aviation using `AIXM.config.voice_channel_separation`
+    # Whether this frequency is part of the voice airband for civil aviation
+    # using +AIXM.config.voice_channel_separation+.
+    #
+    # @return [Boolean]
     def voice?
       return false unless unit == :mhz
       case AIXM.config.voice_channel_separation
@@ -78,15 +86,19 @@ module AIXM
 
     private
 
-    # @return [Boolean] whether this frequency is part of the voice airband
-    #   for civil aviation using 25 kHz channel separation
+    # Whether this frequency is part of the voice airband for civil aviation
+    # using 25 kHz channel separation.
+    #
+    # @return [Boolean]
     def voice_25?
       return false unless unit == :mhz && freq == freq.round(3) && freq.between?(118, 136.975)
       ((freq * 1000).round % 25).zero?
     end
 
-    # @return [Boolean] whether this frequency is part of the voice airband
-    #   for civil aviation using 8.33 kHz channel separation
+    # Whether this frequency is part of the voice airband for civil aviation
+    # using 8.33 kHz channel separation.
+    #
+    # @return [Boolean]
     def voice_833?
       return false unless unit == :mhz && freq == freq.round(3) && freq.between?(118, 136.99)
       [0.005, 0.01, 0.015].any? { |d| (((freq - d) * 1000).round % 25).zero? }

data/lib/aixm/feature/airport.rb

@@ -38,6 +38,8 @@ module AIXM
     class Airport < Feature
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Timetable
+      include AIXM::Concerns::Remarks
 
       public_class_method :new
 
@@ -112,7 +114,7 @@ module AIXM
       #   @return [AIXM::Feature::Organisation] superior organisation
       belongs_to :organisation, as: :member
 
-      # ICAO indicator, IATA indicator or generated indicator
+      # ICAO, IATA or generated airport indicator.
       #
       # * four letter ICAO indicator (e.g. "LFMV")
       # * three letter IATA indicator (e.g. "AVN")
@@ -120,19 +122,42 @@ module AIXM
       # * two letter ICAO country code + at least four letters/digits (e.g.
       #   "LFFOOBAR123" or "LF" + GPS code)
       #
-      # @return [String] airport indicator
+      # @overload id
+      #   @return [String]
+      # @overload id=(value)
+      #   @param value [String]
       attr_reader :id
 
-      # @return [String] full name
+      # Full name
+      #
+      # @overload name
+      #   @return [String]
+      # @overload name=(value)
+      #   @param value [String]
       attr_reader :name
 
-      # @return [AIXM::XY] reference point
+      # Reference point
+      #
+      # @overload xy
+      #   @return [AIXM::XY]
+      # @overload xy=(value)
+      #   @param value [AIXM::XY]
       attr_reader :xy
 
-      # @return [String, nil] GPS code
+      # GPS code
+      #
+      # @overload gps
+      #   @return [String, nil]
+      # @overload gps=(value)
+      #   @param value [String, nil]
       attr_reader :gps
 
-      # @return [AIXM::Z, nil] elevation in +:qnh+
+      # Elevation in +:qnh+
+      #
+      # @overload z
+      #   @return [AIXM::Z, nil]
+      # @overload z=(value)
+      #   @param value [AIXM::Z, nil]
       attr_reader :z
 
       # When looking towards the geographic (aka: true) north, a positive
@@ -146,18 +171,24 @@ module AIXM
       # @return [Float, nil] magnetic declination in degrees
       attr_reader :declination
 
-      # @return [AIXM::Z, nil] transition altitude in +:qnh+
+      # Transition altitude in +:qnh+
+      #
+      # @overload transition_z
+      #   @return [AIXM::Z, nil]
+      # @overload transition_z=(value)
+      #   @param value [AIXM::Z, nil]
       attr_reader :transition_z
 
-      # @return [AIXM::Component::Timetable, nil] operating hours
-      attr_reader :timetable
-
-      # @return [String, nil] operator of the airport
+      # Operator of the airport
+      #
+      # @overload operator
+      #   @return [String, nil]
+      # @overload operator=(value)
+      #   @param value [String, nil]
       attr_reader :operator
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Feature::Airport] for examples on how to
+      # create instances of this class.
       def initialize(source: nil, region: nil, organisation:, id: nil, name:, xy:)
         super(source: source, region: region)
         self.organisation, self.name, self.id, self.xy = organisation, name, id, xy   # name must be set before id
@@ -186,12 +217,17 @@ module AIXM
         @gps = value&.upcase
       end
 
+      # Type of airport.
+      #
       # The type is usually derived from the presence of runways and helipads,
       # however, this may be overridden by setting an alternative value, most
       # notably +:landing_site+.
       #
       # @!attribute type
-      # @return [Symbol] type of airport (see {TYPES})
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       def type
         @type = case
           when @type then @type
@@ -228,20 +264,11 @@ module AIXM
         @transition_z = value
       end
 
-      def timetable=(value)
-        fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
-        @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
-
       # @return [String] UID markup
       def to_uid(as: :AhpUid)
         builder = Builder::XmlMarkup.new(indent: 2)
@@ -350,6 +377,8 @@ module AIXM
       # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#ahu-airport-usage
       class UsageLimitation
         include AIXM::Association
+        include AIXM::Concerns::Timetable
+        include AIXM::Concerns::Remarks
 
         TYPES = {
           PERMIT: :permitted,
@@ -370,15 +399,16 @@ module AIXM
         #   @return [AIXM::Feature::Airport] airport this usage limitation is assigned to
         belongs_to :airport
 
-        # @return [Symbol] type of limitation
+        # Type of limitation
+        #
+        # @overload type
+        #   @return [Symbol] any of {TYPES}
+        # @overload type=(value)
+        #   @param value [Symbol] any of {TYPES}
         attr_reader :type
 
-        # @return [AIXM::Component::Timetable, nil] limitation application hours
-        attr_reader :timetable
-
-        # @return [String, nil] free text remarks
-        attr_reader :remarks
-
+        # See the {cheat sheet}[AIXM::Feature::Airport::UsageLimitation] for
+        #   examples on how to create instances of this class.
         def initialize(type:)
           self.type = type
         end
@@ -392,15 +422,6 @@ module AIXM
           @type = TYPES.lookup(value&.to_s&.to_sym, nil) || fail(ArgumentError, "invalid type")
         end
 
-        def timetable=(value)
-          fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
-          @timetable = value
-        end
-
-        def remarks=(value)
-          @remarks = value&.to_s
-        end
-
         # @return [String] AIXM or OFMX markup
         def to_xml
           builder = Builder::XmlMarkup.new(indent: 2)
@@ -471,19 +492,44 @@ module AIXM
           #   @return [AIXM::Feature::Airport::UsageLimitation] usage limitation the condition belongs to
           belongs_to :usage_limitation
 
-          # @return [Symbol, nil] kind of aircraft (see {AIRCRAFT})
+          # Kind of aircraft.
+          #
+          # @overload aircraft
+          #   @return [Symbol, nil] any of {AIRCRAFT}
+          # @overload aircraft=(value)
+          #   @param value [Symbol, nil] any of {AIRCRAFT}
           attr_reader :aircraft
 
-          # @return [String, nil] flight rule (see {RULES})
+          # Flight rule.
+          #
+          # @overload rule
+          #   @return [Symbol, nil] any of {RULES}
+          # @overload rule=(value)
+          #   @param value [Symbol, nil] any of {RULES}
           attr_reader :rule
 
-          # @return [String, nil] whether military or civil (see {REALMS})
+          # Military, civil etc.
+          #
+          # @overload realm
+          #   @return [Symbol, nil] any of {REALMS}
+          # @overload realm=(value)
+          #   @param value [Symbol, nil] any of {REALMS}
           attr_reader :realm
 
-          # @return [String, nil] geographic origin of the flight (see {ORIGINS})
+          # Geographic origin of the flight.
+          #
+          # @overload origin
+          #   @return [Symbol, nil] any of {ORIGINS}
+          # @overload origin=(value)
+          #   @param value [Symbol, nil] any of {ORIGINS}
           attr_reader :origin
 
-          # @return [String, nil] purpose of the flight (see {PURPOSES})
+          # Purpose of the flight.
+          #
+          # @overload purpose
+          #   @return [Symbol, nil] any of {PURPOSES}
+          # @overload purpose=(value)
+          #   @param value [Symbol, nil] any of {PURPOSES}
           attr_reader :purpose
 
           # @return [String]

data/lib/aixm/feature/airspace.rb

@@ -92,23 +92,46 @@ module AIXM
       #   @param layer [AIXM::Compoment::Layer]
       has_many :layers
 
+      # Published identifier (e.g. "LFP81").
+      #
       # @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")
+      # @overload id
+      #   @return [String]
+      # @overload id=(value)
+      #   @param value [String]
       attr_reader :id
 
-      # @return [Symbol] type of airspace (see {TYPES})
+      # Type of airspace (see {TYPES})
+      #
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       attr_reader :type
 
-      # Some regions define additional types. They are usually specified with
+      # Local type.
       #
-      # @return [String, nil] local type (e.g. "RMZ" or "TMZ")
+      # Some regions define additional local types such as "RMZ" or "TMZ". They
+      # are often further specifying type +:regulated_airspace+.
+      #
+      # @overload local_type
+      #   @return [String, nil]
+      # @overload local_type=(value)
+      #   @param value [String, nil]
       attr_reader :local_type
 
-      # @return [String, nil] full name (e.g. "LF P 81 CHERBOURG")
+      # Full name (e.g. "LF P 81 CHERBOURG")
+      #
+      # @overload name
+      #   @return [String, nil]
+      # @overload name=(value)
+      #   @param value [String, nil]
       attr_reader :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)
         super(source: source, region: region)
         self.type, self.local_type, self.name = type, local_type, name

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

@@ -41,9 +41,16 @@ module AIXM
         #   associated with
         belongs_to :airport
 
-        # @return [Symbol] type of designated point
+        # Type of designated point
+        #
+        # @overload type
+        #   @return [Symbol] any of {TYPES}
+        # @overload type=(value)
+        #   @param value [Symbol] any of {TYPES}
         attr_reader :type
 
+        # See the {cheat sheet}[AIXM::Feature::NavigationalAid::DesignatedPoint]
+        # for examples on how to create instances of this class.
         def initialize(type:, **arguments)
           super(organisation: nil, z: nil, **arguments)
           self.type = type

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

@@ -43,9 +43,20 @@ module AIXM
         #   @return [AIXM::Feature::NavigationalAid::VOR, nil] associated VOR
         belongs_to :vor, readonly: true
 
-        # @return [String] radio channel
+        # Radio channel
+        #
+        # @overload channel
+        #   @return [String]
+        # @overload channel=(value)
+        #   @param value [String]
+        # @overload ghost_f
+        #   @return [AIXM::F] ghost frequency matching the {#channel}
+        # @overload ghost_f=(value)
+        #   @param value [AIXM::F] ghost frequency matching the {#channel}
         attr_reader :channel
 
+        # See the {cheat sheet}[AIXM::Feature::NavigationalAid::DME] for examples
+        # on how to create instances of this class.
         def initialize(channel: nil, ghost_f: nil, **arguments)
           super(**arguments)
           case
@@ -72,7 +83,6 @@ module AIXM
           self.channel = "#{number}#{letter}"
         end
 
-        # @return [AIXM::F] ghost frequency matching the channel
         def ghost_f
           if channel
             number, letter = channel.split(/(?=[XY])/)

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

@@ -39,13 +39,20 @@ module AIXM
           OTHER: :other     # specify in remarks
         }
 
-        # @return [Symbol] type of marker (see {TYPES})
+        # Type of marker
+        #
+        # @overload type
+        #   @return [Symbol, nil] any of {TYPES}
+        # @overload type=(value)
+        #   @param value [Symbol, nil] any of {TYPES}
         attr_reader :type
 
-        # TODO: Marker require an associated ILS (not yet implemented)
+        # See the {cheat sheet}[AIXM::Feature::NavigationalAid::Marker] for
+        # examples on how to create instances of this class.
         def initialize(type:, **arguments)
           super(**arguments)
           self.type = type
+          # TODO: Marker require an associated ILS (not yet implemented)
           warn("WARNING: Marker is not fully implemented yet due to the lack of ILS")
         end
 

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

@@ -25,7 +25,7 @@ module AIXM
       # @see https://gitlab.com/openflightmaps/ofmx/wikis/Navigational-aid#ndb-ndb
       class NDB < NavigationalAid
         include AIXM::Memoize
-        
+
         public_class_method :new
 
         TYPES = {
@@ -35,12 +35,24 @@ module AIXM
           OTHER: :other   # specify in remarks
         }.freeze
 
-        # @return [Symbol, nil] type of NDB (see {TYPES})
+        # Type of NDB
+        #
+        # @overload type
+        #   @return [Symbol, nil] any of {TYPES}
+        # @overload type=(value)
+        #   @param value [Symbol, nil] any of {TYPES}
         attr_reader :type
 
-        # @return [AIXM::F] radio frequency
+        # Radio frequency
+        #
+        # @overload f
+        #   @return [AIXM::F]
+        # @overload f=(value)
+        #   @param value [AIXM::F]
         attr_reader :f
 
+        # See the {cheat sheet}[AIXM::Feature::NavigationalAid::NDB] for examples
+        # on how to create instances of this class.
         def initialize(type:, f:, **arguments)
           super(**arguments)
           self.type, self.f = type, f

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

@@ -59,15 +59,32 @@ module AIXM
         #   @param tacan [AIXM::Feature::NavigationalAid::TACAN, nil]
         has_one :tacan, allow_nil: true
 
-        # @return [Symbol] type of VOR (see {TYPES})
+        # Type of VOR
+        #
+        # @overload type
+        #   @return [Symbol] any of {TYPES}
+        # @overload type=(value)
+        #   @param value [Symbol] any of {TYPES}
         attr_reader :type
 
-        # @return [AIXM::F] radio requency
+        # Radio requency
+        #
+        # @overload f
+        #   @return [AIXM::F]
+        # @overload f=(value)
+        #   @param value [AIXM::F]
         attr_reader :f
 
-        # @return [Symbol] north indication (see {NORTHS})
+        # North indication
+        #
+        # @overload north
+        #   @return [Symbol] any of {NORTHS}
+        # @overload north=(value)
+        #   @param value [Symbol] any of {NORTHS}
         attr_reader :north
 
+        # See the {cheat sheet}[AIXM::Feature::VOR] for examples on how to
+        # create instances of this class.
         def initialize(type:, f:, north:, **arguments)
           super(**arguments)
           self.type, self.f, self.north = type, f, north

data/lib/aixm/feature/navigational_aid.rb

@@ -6,6 +6,8 @@ module AIXM
     # @abstract
     class NavigationalAid < Feature
       include AIXM::Association
+      include AIXM::Concerns::Timetable
+      include AIXM::Concerns::Remarks
 
       private_class_method :new
 
@@ -13,24 +15,38 @@ module AIXM
       #   @return [AIXM::Feature::Organisation] superior organisation
       belongs_to :organisation, as: :member
 
-      # @return [String] published identifier
+      # Published identifier
+      #
+      # @overload id
+      #   @return [String]
+      # @overload id=(value)
+      #   @param value [String]
       attr_reader :id
 
-      # @return [String, nil] name of the navigational aid
+      # Name of the navigational aid.
+      #
+      # @overload name
+      #   @return [String, nil]
+      # @overload name=(value)
+      #   @param value [String, nil]
       attr_reader :name
 
-      # @return [AIXM::XY] geographic position
+      # Geographic position.
+      #
+      # @overload xy
+      #   @return [AIXM::XY]
+      # @overload xy=(value)
+      #   @param value [AIXM::XY]
       attr_reader :xy
 
-      # @return [AIXM::Z, nil] elevation in +:qnh+
+      # Elevation in +:qnh+.
+      #
+      # @overload z
+      #   @return [AIXM::Z, nil]
+      # @overload z=(value)
+      #   @param value [AIXM::Z, nil]
       attr_reader :z
 
-      # @return [AIXM::Component::Timetable, nil] operating hours
-      attr_reader :timetable
-
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
       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
@@ -61,16 +77,9 @@ module AIXM
         @z = value
       end
 
-      def timetable=(value)
-        fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
-        @timetable = value
-      end
-
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
-      # @return [String] fully descriptive combination of {#class} and {#type} key
+      # Fully descriptive combination of {#class} and {#type} key.
+      #
+      # @return [String]
       def kind
         [self.class.name.split('::').last, type_key].compact.join(':'.freeze)
       end