aixm 1.1.0 → 1.2.0

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

@@ -20,9 +20,16 @@ module AIXM
         #   @return [AIXM::Component::Geometry] geometry this segment belongs to
         belongs_to :geometry, as: :segment
 
-        # @return [AIXM::XY] (starting) point
+        # (Starting) point
+        #
+        # @overload xy
+        #   @return [AIXM::XY]
+        # @overload xy=(value)
+        #   @param value [AIXM::XY]
         attr_reader :xy
 
+        # See the {cheat sheet}[AIXM::Component::Geometry::RhumbLine] for
+        # examples on how to create instances of this class.
         def initialize(xy:)
           self.xy = xy
         end

data/lib/aixm/component/geometry.rb

@@ -49,6 +49,8 @@ module AIXM
       #   @return [AIXM::Feature::Airspace] airspace the geometry defines
       belongs_to :airspace
 
+      # See the {cheat sheet}[AIXM::Component::Geometry] for examples on how to
+      # create instances of this class.
       def initialize(*segments)
         segments.each { add_segment(_1) }
       end
@@ -58,36 +60,44 @@ module AIXM
         %Q(#<#{self.class} segments=#{segments.count.inspect}>)
       end
 
-      # @return [Boolean] whether the geometry is closed
+      # Whether the geometry is closed
+      #
+      # @return [Boolean]
       def closed?
         point? || circle? || polygon?
       end
 
-      # @return [String] AIXM or OFMX markup
-      def to_xml
-        fail(GeometryError.new("geometry is not closed", self)) unless closed?
-        segments.map { _1.to_xml }.join
-      end
-
-      # @return [Boolean] Single point geometry?
+      # Whether a single point geometry
+      #
+      # @return [Boolean]
       def point?
         segments.size == 1 &&
           segments.first.is_a?(AIXM::Component::Geometry::Point)
       end
 
-      # @return [Boolean] Circle shaped geometry?
+      # Whether a circle shaped geometry
+      #
+      # @return [Boolean]
       def circle?
         segments.size == 1 &&
           segments.first.is_a?(AIXM::Component::Geometry::Circle)
       end
 
-      # @return [Boolean] Polygon shaped geometry?
+      # Whether a polygon shaped geometry
+      #
+      # @return [Boolean]
       def polygon?
         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
+
+      # @return [String] AIXM or OFMX markup
+      def to_xml
+        fail(GeometryError.new("geometry is not closed", self)) unless closed?
+        segments.map { _1.to_xml }.join
+      end
     end
 
   end

data/lib/aixm/component/helipad.rb

@@ -25,6 +25,8 @@ module AIXM
     class Helipad < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Marking
+      include AIXM::Concerns::Remarks
 
       PERFORMANCE_CLASSES = {
         '1': :'1',
@@ -68,30 +70,57 @@ module AIXM
       #   @return [AIXM::Feature::Airport] airport this helipad belongs to
       belongs_to :airport
 
-      # @return [String] full name (e.g. "H1")
+      # Full name (e.g. "H1")
+      #
+      # @overload name
+      #   @return [String]
+      # @overload name=(value)
+      #   @param value [String]
       attr_reader :name
 
-      # @return [AIXM::XY] center point
+      # Center point
+      #
+      # @overload center_xy
+      #   @return [AIXM::XY]
+      # @overload center_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::R, nil] dimensions
+      # Dimensions
+      #
+      # @overload dimensions
+      #   @return [AIXM::R, nil]
+      # @overload dimensions=(value)
+      #   @param value [AIXM::R, nil]
       attr_reader :dimensions
 
-      # @return [String, nil] markings
-      attr_reader :marking
-
-      # @return [Integer, Symbol, nil] suitable performance class
+      # Suitable performance class
+      #
+      # @overload performance_class
+      #   @return [Integer, Symbol, nil]
+      # @overload performance_class=(value)
+      #   @param value [Integer, Symbol, nil]
       attr_reader :performance_class
 
-      # @return [Symbol, nil] status of the helipad (see {STATUSES}) or +nil+ for normal operation
+      # Status of the helipad
+      #
+      # @overload status
+      #   @return [Symbol, nil] any of {STATUSES} or +nil+ for normal operation
+      # @overload status=(value)
+      #   @param value [Symbol, nil] any of {STATUSES} or +nil+ for normal
+      #     operation
       attr_reader :status
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Helipad] for examples on how to
+      # create instances of this class.
       def initialize(name:, xy:)
         self.name, self.xy = name, xy
         self.surface = AIXM.surface
@@ -122,10 +151,6 @@ module AIXM
         @dimensions = value
       end
 
-      def marking=(value)
-        @marking = value&.to_s
-      end
-
       def performance_class=(value)
         @performance_class = value.nil? ? nil : (PERFORMANCE_CLASSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid performance class"))
       end
@@ -134,10 +159,6 @@ module AIXM
         @status = value.nil? ? nil : (STATUSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid status"))
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)

data/lib/aixm/component/layer.rb

@@ -21,6 +21,8 @@ module AIXM
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace
     class Layer < Component
       include AIXM::Association
+      include AIXM::Concerns::Timetable
+      include AIXM::Concerns::Remarks
 
       CLASSES = (:A..:G).freeze
 
@@ -106,18 +108,24 @@ module AIXM
       #   @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
+      # Four letter location identifier as published in the ICAO DOC 7910
+      #
+      # @overload location_indicator
+      #   @return [String, nil]
+      # @overload location_indicator=(value)
+      #   @param value [String, nil]
       attr_reader :location_indicator
 
-      # @return [String, nil] primary activity (e.g. "GLIDER")
+      # Primary activity
+      #
+      # @overload activity
+      #   @return [Symbol, nil] any of {ACTIVITIES}
+      # @overload activity=(value)
+      #   @param value [Symbol, nil] any of {ACTIVITIES}
       attr_reader :activity
 
-      # @return [AIXM::Component::Timetable, nil] activation hours
-      attr_reader :timetable
-
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Layer] for examples on how to
+      # create instances of this class.
       def initialize(class: nil, location_indicator: nil, vertical_limit:)
         self.class = binding.local_variable_get(:class)
         self.location_indicator, self.vertical_limit = location_indicator, vertical_limit
@@ -129,8 +137,15 @@ module AIXM
         %Q(#<#{__class__} class=#{@klass.inspect}>)
       end
 
+      # Class of layer.
+      #
+      # @note Use +Object#__class__+ alias to query the Ruby object class.
+      #
       # @!attribute class
-      # @return [Symbol] class of layer (see {CLASSES})
+      # @overload class
+      #   @return [Symbol] any of {CLASSES}
+      # @overload class=(value)
+      #   @param value [Symbol] any of {CLASSES}
       def class
         @klass
       end
@@ -149,13 +164,13 @@ module AIXM
         @activity = value.nil? ? nil : ACTIVITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid activity")
       end
 
-      def timetable=(value)
-        fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
-        @timetable = value
-      end
-
-      # @!attribute [w] selective
-      # @return [Boolean] whether the layer may be activated selectively
+      # Whether the layer may be activated selectively.
+      #
+      # @!attribute selective
+      # @overload selective?
+      #   @return [Boolean]
+      # @overload selective=(value)
+      #   @param value [Boolean]
       def selective?
         @selective
       end
@@ -165,10 +180,6 @@ module AIXM
         @selective = 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)

data/lib/aixm/component/lighting.rb

@@ -20,6 +20,8 @@ module AIXM
     class Lighting < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Intensity
+      include AIXM::Concerns::Remarks
 
       POSITIONS = {
         TDZ: :touch_down_zone,
@@ -40,13 +42,6 @@ module AIXM
         OTHER: :other   # specify in remarks
       }.freeze
 
-      INTENSITIES = {
-        LIL: :low,
-        LIM: :medium,
-        LIH: :high,
-        OTHER: :other   # specify in remarks
-      }.freeze
-
       COLORS = {
         YEL: :yellow,
         RED: :red,
@@ -61,21 +56,32 @@ module AIXM
       #   @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})
+      # Position of the lighting system
+      #
+      # @overload position
+      #   @return [Symbol, nil] any of {POSITIONS}
+      # @overload position=(value)
+      #   @param value [Symbol, nil] any of {POSITIONS}
       attr_reader :position
 
-      # @return [String, nil] detailed description
+      # Detailed description
+      #
+      # @overload description
+      #   @return [String, nil]
+      # @overload description=(value)
+      #   @param value [String, nil]
       attr_reader :description
 
-      # @return [Symbol, nil] intensity of lights (see {INTENSITIES})
-      attr_reader :intensity
-
-      # @return [Symbol, nil] color of lights (see {COLORS})
+      # Color of lights
+      #
+      # @overload color
+      #   @return [Symbol, nil] any of {COLORS}
+      # @overload color=(value)
+      #   @param value [Symbol, nil] any of {COLORS}
       attr_reader :color
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Lighting] for examples on how to
+      # create instances of this class.
       def initialize(position:)
         self.position = position
       end
@@ -93,18 +99,10 @@ module AIXM
         @description = value&.to_s
       end
 
-      def intensity=(value)
-        @intensity = value.nil? ? nil : INTENSITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid intensity")
-      end
-
       def color=(value)
         @color = value.nil? ? nil : COLORS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid color")
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid(as:)
         builder = Builder::XmlMarkup.new(indent: 2)

data/lib/aixm/component/runway.rb

@@ -51,6 +51,8 @@ module AIXM
     class Runway < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Marking
+      include AIXM::Concerns::Remarks
 
       STATUSES = {
         CLSD: :closed,
@@ -86,21 +88,33 @@ module AIXM
       #   @return [AIXM::Feature::Airport] airport the runway belongs to
       belongs_to :airport
 
-      # @return [String] full name of runway (e.g. "12/30" or "16L/34R")
+      # Full name of runway (e.g. "12/30" or "16L/34R")
+      #
+      # @overload name
+      #   @return [String]
+      # @overload name=(value)
+      #   @param value [String]
       attr_reader :name
 
-      # @return [AIXM::R, nil] dimensions
+      # Dimensions
+      #
+      # @overload dimensions
+      #   @return [AIXM::R, nil]
+      # @overload dimensions=(value)
+      #   @param value [AIXM::R, nil]
       attr_reader :dimensions
 
-      # @return [String, nil] markings
-      attr_reader :marking
-
-      # @return [Symbol, nil] status of the runway (see {STATUSES}) or +nil+ for normal operation
+      # Status of the runway
+      #
+      # @overload status
+      #   @return [Symbol, nil] any of {STATUSES} or +nil+ for normal operation
+      # @overload status=(value)
+      #   @param value [Symbol, nil] any of {STATUSES} or +nil+ for normal
+      #     operation
       attr_reader :status
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Runway] for examples on how to
+      # create instances of this class.
       def initialize(name:)
         self.name = name
         @name.split("/").tap do |forth_name, back_name|
@@ -126,18 +140,10 @@ module AIXM
         @dimensions = value
       end
 
-      def marking=(value)
-        @marking = value&.to_s
-      end
-
       def status=(value)
         @status = value.nil? ? nil : (STATUSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid status"))
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
@@ -180,6 +186,7 @@ module AIXM
       class Direction
         include AIXM::Association
         include AIXM::Memoize
+        include AIXM::Concerns::Remarks
 
         VFR_PATTERNS = {
           L: :left,
@@ -207,7 +214,12 @@ module AIXM
         #   @return [AIXM::Component::Runway] runway the runway direction is further describing
         belongs_to :runway, readonly: true
 
-        # @return [AIXM::A] partial name of runway (e.g. "12" or "16L")
+        # Partial name of runway (e.g. "12" or "16L")
+        #
+        # @overload name
+        #   @return [AIXM::A]
+        # @overload name=(value)
+        #   @param value [AIXM::A]
         attr_reader :name
 
         # @return [AIXM::A, nil] (true) geographic bearing in degrees
@@ -231,9 +243,8 @@ module AIXM
         # @return [Symbol, nil] direction of the VFR flight pattern (see {VFR_PATTERNS})
         attr_reader :vfr_pattern
 
-        # @return [String, nil] free text remarks
-        attr_reader :remarks
-
+        # See the {cheat sheet}[AIXM::Component::Runway] for examples on how to
+        #   create instances of this class.
         def initialize(name:)
           self.name = name
           self.vasis = AIXM.vasis
@@ -288,10 +299,6 @@ module AIXM
           @vfr_pattern = value.nil? ? nil : (VFR_PATTERNS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid VFR pattern"))
         end
 
-        def remarks=(value)
-          @remarks = value&.to_s
-        end
-
         # @return [AIXM::A] magnetic bearing in degrees
         def magnetic_bearing
           if geographic_bearing && runway.airport.declination

data/lib/aixm/component/service.rb

@@ -17,6 +17,8 @@ module AIXM
     class Service < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Timetable
+      include AIXM::Concerns::Remarks
 
       TYPES = {
         ACS: :area_control_service,
@@ -122,7 +124,7 @@ module AIXM
         :transcribed_weather_broadcast_service => :meteorological_office,
         :uhf_direction_finding_service => :uhf_direction_finding_station,
         :upper_area_control_service => :upper_area_control_centre,
-        :vhf_direction_finding_service => :vdf_direction_finding_station,
+        :vdf_direction_finding_service => :vdf_direction_finding_station,
         :volmet_service => :meteorological_office,
         :other => :other
       }.freeze
@@ -150,15 +152,16 @@ module AIXM
       #   @return [AIXM::Component::Layer] airspace layer this service is provided within
       belongs_to :layer
 
-      # @return [Symbol] type of service (see {TYPES})
+      # Type of service
+      #
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       attr_reader :type
 
-      # @return [AIXM::Component::Timetable, nil] operating hours
-      attr_reader :timetable
-
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Service] for examples on how to
+      # create instances of this class.
       def initialize(type:)
         self.type = type
         @sequence = 1
@@ -173,15 +176,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
-
       # Guess the unit type for this service
       #
       # @return [Symbol, nil] guessed unit type or +nil+ if unmappable

data/lib/aixm/component/surface.rb

@@ -23,6 +23,8 @@ module AIXM
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#tla-helipad-tlof
     # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airport#fto-fato
     class Surface < Component
+      include AIXM::Concerns::Remarks
+
       COMPOSITIONS = {
         ASPH: :asphalt,
         BITUM: :bitumen,        # dug up, bound and rolled ground
@@ -59,27 +61,56 @@ module AIXM
         OTHER: :other
       }.freeze
 
-      # @return [Symbol, nil] composition of the surface (see {COMPOSITIONS})
+      # Composition of the surface.
+      #
+      # @overload composition
+      #   @return [Symbol, nil] any of {COMPOSITIONS}
+      # @overload composition=(value)
+      #   @param value [Symbol, nil] any of {COMPOSITIONS}
       attr_reader :composition
 
-      # @return [Symbol, nil] preparation of the surface (see {PREPARATIONS})
+      # Preparation of the surface.
+      #
+      # @overload preparation
+      #   @return [Symbol, nil] any of {PREPARATIONS}
+      # @overload preparation=(value)
+      #   @param value [Symbol, nil] any of {PREPARATIONS}
       attr_reader :preparation
 
-      # @return [Symbol, nil] condition of the surface (see {CONDITIONS})
+      # Condition of the surface.
+      #
+      # @overload condition
+      #   @return [Symbol, nil] any of {CONDITIONS}
+      # @overload condition=(value)
+      #   @param value [Symbol, nil] any of {CONDITIONS}
       attr_reader :condition
 
-      # @return [AIXM::W, nil] single isolated wheel load weight
+      # Single isolated wheel load weight
+      #
+      # @overload siwl_weight
+      #   @return [AIXM::W, nil]
+      # @overload siwl_weight=(value)
+      #   @param value [AIXM::W, nil]
       attr_reader :siwl_weight
 
-      # @return [AIXM::P, nil] single isolated wheel load tire pressure
+      # Single isolated wheel load tire pressure
+      #
+      # @overload siwl_tire_pressure
+      #   @return [AIXM::P, nil]
+      # @overload siwl_tire_pressure=(value)
+      #   @param value [AIXM::P, nil]
       attr_reader :siwl_tire_pressure
 
-      # @return [AIXM::W, nil] all-up wheel weight
+      # All-up wheel weight
+      #
+      # @overload auw_weight
+      #   @return [AIXM::W, nil]
+      # @overload auw_weight=(value)
+      #   @param value [AIXM::W, nil]
       attr_reader :auw_weight
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Surface] for examples on how to
+      # create instances of this class.
       def initialize
         @pcn = {}
       end
@@ -101,7 +132,13 @@ module AIXM
         @condition = value.nil? ? nil : CONDITIONS.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid condition")
       end
 
-      # @return [String, nil] pavement classification number (e.g. "59/F/A/W/T")
+      # Pavement classification number (e.g. "59/F/A/W/T")
+      #
+      # @!attribute pcn
+      # @overload pcn
+      #   @return [String, nil]
+      # @overload pcn=(value)
+      #   @param value [String, nil]
       def pcn
         @pcn.none? ? nil : @pcn.values.join("/".freeze)
       end
@@ -127,10 +164,6 @@ module AIXM
         @auw_weight = value
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] AIXM or OFMX markup
       def to_xml
         builder = Builder::XmlMarkup.new(indent: true)