Class: AIXM::Feature::NavigationalAid Abstract

Inherits:

AIXM::Feature

• Object
• AIXM::Feature
• AIXM::Feature::NavigationalAid

Includes:

Association

Defined in:

lib/aixm/feature/navigational_aid.rb,
lib/aixm/feature/navigational_aid/dme.rb,
lib/aixm/feature/navigational_aid/ndb.rb,
lib/aixm/feature/navigational_aid/vor.rb,
lib/aixm/feature/navigational_aid/tacan.rb,
lib/aixm/feature/navigational_aid/marker.rb,
lib/aixm/feature/navigational_aid/designated_point.rb

Overview

This class is abstract.

Direct Known Subclasses

DME, DesignatedPoint, Marker, NDB, VOR

Defined Under Namespace

Classes: DME, DesignatedPoint, Marker, NDB, TACAN, VOR

Constant Summary

Constants inherited from AIXM::Feature

REGION_RE

Instance Attribute Summary

• #id ⇒ String

  Published identifier.

• #name ⇒ String^?

  Name of the navigational aid.

• #remarks ⇒ String^?

  Free text remarks.

• #timetable ⇒ AIXM::Component::Timetable^?

  Operating hours.

• #xy ⇒ AIXM::XY

  Geographic position.

• #z ⇒ AIXM::Z^?

  Elevation in :qnh.

Attributes inherited from AIXM::Feature

#region, #source

Instance Method Summary

• #initialize(source: nil, region: nil, organisation:, id:, name: nil, xy:, z: nil) ⇒ NavigationalAid constructor

  A new instance of NavigationalAid.

• #inspect ⇒ String
• #kind ⇒ String

  Fully descriptive combination of #class and #type key.

• #organisation ⇒ AIXM::Feature::Organisation

  Superior organisation.

Methods included from Association

included

Methods inherited from AIXM::Feature

#==

Constructor Details

#initialize(source: nil, region: nil, organisation:, id:, name: nil, xy:, z: nil) ⇒ NavigationalAid

Returns a new instance of NavigationalAid.

# File 'lib/aixm/feature/navigational_aid.rb', line 34

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

Instance Attribute Details

#id ⇒ String

Returns published identifier.

Returns:

• (String) —

  published identifier

# File 'lib/aixm/feature/navigational_aid.rb', line 17

def id
  @id
end

#name ⇒ String^?

Returns name of the navigational aid.

Returns:

• (String, nil) —

  name of the navigational aid

# File 'lib/aixm/feature/navigational_aid.rb', line 20

def name
  @name
end

#remarks ⇒ String^?

Returns free text remarks.

Returns:

• (String, nil) —

  free text remarks

# File 'lib/aixm/feature/navigational_aid.rb', line 32

def remarks
  @remarks
end

#timetable ⇒ AIXM::Component::Timetable^?

Returns operating hours.

Returns:

• (AIXM::Component::Timetable, nil) —

  operating hours

# File 'lib/aixm/feature/navigational_aid.rb', line 29

def timetable
  @timetable
end

#xy ⇒ AIXM::XY

Returns geographic position.

Returns:

• (AIXM::XY) —

  geographic position

# File 'lib/aixm/feature/navigational_aid.rb', line 23

def xy
  @xy
end

#z ⇒ AIXM::Z^?

Returns elevation in :qnh.

Returns:

• (AIXM::Z, nil) —

  elevation in :qnh

# File 'lib/aixm/feature/navigational_aid.rb', line 26

def z
  @z
end

Instance Method Details

#inspect ⇒ String

Returns:

• (String)

# File 'lib/aixm/feature/navigational_aid.rb', line 40

def inspect
  %Q(#<#{self.class} id=#{id.inspect} name=#{name.inspect}>)
end

#kind ⇒ String

Returns fully descriptive combination of #class and #type key.

Returns:

• (String) —

  fully descriptive combination of #class and #type key

# File 'lib/aixm/feature/navigational_aid.rb', line 74

def kind
  [self.class.name.split('::').last, type_key].compact.join(':')
end

#organisation ⇒ AIXM::Feature::Organisation

Returns superior organisation.

Returns:

• (AIXM::Feature::Organisation) —

  superior organisation

# File 'lib/aixm/feature/navigational_aid.rb', line 14

belongs_to :organisation, as: :member