Class: RGeo::CoordSys::CS::VerticalCoordinateSystem

Inherits:

CoordinateSystem

• Object
• Base
• Info
• CoordinateSystem
• RGeo::CoordSys::CS::VerticalCoordinateSystem

Defined in:

lib/rgeo/coord_sys/cs/entities.rb

Overview

OGC spec description

A one-dimensional coordinate system suitable for vertical measurements.

Instance Attribute Summary

• #vertical_datum ⇒ Object readonly

  Gets the vertical datum, which indicates the measurement method.

• #vertical_unit ⇒ Object readonly

  Gets the units used along the vertical axis.

Attributes inherited from CoordinateSystem

#dimension

Attributes inherited from Info

#abbreviation, #alias, #authority, #authority_code, #name, #remarks

Class Method Summary

• .create(name, vertical_datum, vertical_unit, axis, *optional) ⇒ Object

  Create a VerticalCoordinateSystem given a name, a VerticalDatum, a LinearUnit, and an AxisInfo.

Instance Method Summary

• #get_axis(index) ⇒ Object

  Implements CoordinateSystem#get_axis.

• #get_units(index) ⇒ Object

  Implements CoordinateSystem#get_units.

• #initialize(name, vertical_datum, vertical_unit, axis, *optional) ⇒ VerticalCoordinateSystem constructor

  :nodoc:.

• #wkt_typename ⇒ Object

Methods inherited from Info

#extension

Methods inherited from Base

#encode_with, #eql?, #hash, #init_with, #inspect, #marshal_dump, #marshal_load, #to_s, #to_wkt

Constructor Details

#initialize(name, vertical_datum, vertical_unit, axis, *optional) ⇒ VerticalCoordinateSystem

:nodoc:

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1140

def initialize(name, vertical_datum, vertical_unit, axis, *optional) # :nodoc:
  super(name, 1, *optional)
  @vertical_datum = vertical_datum
  @vertical_unit = vertical_unit
  @axis = axis
end

Instance Attribute Details

#vertical_datum ⇒ Object (readonly)

Gets the vertical datum, which indicates the measurement method.

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1148

def vertical_datum
  @vertical_datum
end

#vertical_unit ⇒ Object (readonly)

Gets the units used along the vertical axis. The vertical units must be the same as the CS_CoordinateSystem units.

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1152

def vertical_unit
  @vertical_unit
end

Class Method Details

.create(name, vertical_datum, vertical_unit, axis, *optional) ⇒ Object

Create a VerticalCoordinateSystem given a name, a VerticalDatum, a LinearUnit, and an AxisInfo. The AxisInfo is optional and may be nil. You may also provide the optional parameters specified by the Info interface.

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1176

def create(name, vertical_datum, vertical_unit, axis, *optional)
  new(name, vertical_datum, vertical_unit, axis, *optional)
end

Instance Method Details

#get_axis(index) ⇒ Object

Implements CoordinateSystem#get_axis

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1162

def get_axis(index)
  @axis
end

#get_units(index) ⇒ Object

Implements CoordinateSystem#get_units

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1156

def get_units(index)
  @vertical_unit
end

#wkt_typename ⇒ Object

# File 'lib/rgeo/coord_sys/cs/entities.rb', line 1166

def wkt_typename
  "VERT_CS"
end