class RGeo::CoordSys::CS::Info

OGC spec description

A base interface for metadata applicable to coordinate system objects.

The metadata items “Abbreviation”’, “Alias”, “Authority”, “AuthorityCode”, “Name” and “Remarks” were specified in the Simple Features interfaces, so they have been kept here.

This specification does not dictate what the contents of these items should be. However, the following guidelines are suggested:

When CS_CoordinateSystemAuthorityFactory is used to create an object, the “Authority” and “AuthorityCode” values should be set to the authority name of the factory object, and the authority code supplied by the client, respectively. The other values may or may not be set. (If the authority is EPSG, the implementer may consider using the corresponding metadata values in the EPSG tables.)

When CS_CoordinateSystemFactory creates an object, the “Name” should be set to the value supplied by the client. All of the other metadata items should be left empty.

Notes

This is a non-instantiable abstract class.

Most subclasses will have a set of optional parameters in their “create” method to set the metadata fields. These parameters are, in order:

Attributes

abbreviation[R]

Gets the abbreviation.

alias[R]

Gets the alias.

authority[R]

Gets the authority name. An Authority is an organization that maintains definitions of Authority Codes. For example the European Petroleum Survey Group (EPSG) maintains a database of coordinate systems, and other spatial referencing objects, where each object has a code number ID. For example, the EPSG code for a WGS84 Lat/Lon coordinate system is “4326”.

authority_code[R]

Gets the authority-specific identification code. The AuthorityCode is a compact string defined by an Authority to reference a particular spatial reference object. For example, the European Survey Group (EPSG) authority uses 32 bit integers to reference coordinate systems, so all their code strings will consist of a few digits. The EPSG code for WGS84 Lat/Lon is “4326”.

name[R]

Gets the name.

remarks[R]

Gets the provider-supplied remarks.

Public Instance Methods

extension(key_) click to toggle source

Gets the value of a keyed extension. This is not part of the OGC spec, but it is supported because some coordinate system databases (such as the spatial_ref_sys table for PostGIS 2.0) include it.

# File lib/rgeo/coord_sys/cs/entities.rb, line 550
def extension(key_)
  @extensions[key_.to_s]
end