Class GARS

Global Area Reference System Coordinate

Hierarchy

GARS

Index

Constructors

Methods

coordinate equals getKeypad getLatitude getLongitude getQuadrant toPoint toString create from fromPoint isGARS parse precision

Constructors

constructor

new GARS(longitude: number, latitude: string, quadrant?: number, keypad?: number): GARS
Constructor
Parameters
- longitude: number
  
  longitudinal band number
- latitude: string
  
  latitudinal band letters
- quadrant: number = GARSConstants.DEFAULT_QUADRANT
  
  15 minute quadrant or GARSConstants.DEFAULT_QUADRANT if undefined
- keypad: number = GARSConstants.DEFAULT_KEYPAD
  
  5 minute keypad or GARSConstants.DEFAULT_KEYPAD if undefined
Returns GARS
- Defined in lib/GARS.ts:65

Methods

coordinate

coordinate(type?: GridType): string
Get the GARS coordinate with specified grid precision

Returns
GARS coordinate
Parameters
- type: GridType = GridType.FIVE_MINUTE
  
  grid type precision
Returns string
- Defined in lib/GARS.ts:120

equals

equals(obj: any): boolean
{@inheritDoc}
Parameters
- obj: any
Returns boolean
- Defined in lib/GARS.ts:163

getKeypad

getKeypad(): number
Get the 5 minute keypad

Returns
keypad

Returns number
- Defined in lib/GARS.ts:109

getLatitude

getLatitude(): string
Get the latitudinal band letters

Returns
latitude band letters

Returns string
- Defined in lib/GARS.ts:91

getLongitude

getLongitude(): number
Get the longitudinal band number

Returns
longitude band number

Returns number
- Defined in lib/GARS.ts:82

getQuadrant

getQuadrant(): number
Get the 15 minute quadrant

Returns
quadrant

Returns number
- Defined in lib/GARS.ts:100

toPoint

toPoint(): Point
Convert to a point

Returns
point

Returns Point
- Defined in lib/GARS.ts:140

toString

toString(): string
{@inheritDoc}

Returns string
- Defined in lib/GARS.ts:156

`Static` create

create(longitude: number, latitude: string, quadrant?: number, keypad?: number): GARS
Create

Returns
GARS
Parameters
- longitude: number
  
  longitudinal band number
- latitude: string
  
  latitudinal band letters
- Optional quadrant: number
  
  15 minute quadrant
- Optional keypad: number
  
  5 minute keypad
Returns GARS
- Defined in lib/GARS.ts:49

`Static` from

from(longitude: number, latitude: number): GARS
Convert the coordinate to GARS

Returns
GARS
Parameters
- longitude: number
  
  longitude
- latitude: number
  
  latitude
Returns GARS
- Defined in lib/GARS.ts:237

`Static` fromPoint

fromPoint(point: Point): GARS
Encodes a point as a GARS string

Returns
GARS
Parameters
- point: Point
  
  point
Returns GARS
- Defined in lib/GARS.ts:223

`Static` isGARS

isGARS(gars: string): boolean
Return whether the given string is valid GARS string

Returns
true if GARS string is valid, false otherwise
Parameters
- gars: string
  
  potential GARS string
Returns boolean
- Defined in lib/GARS.ts:182

`Static` parse

parse(gars: string): GARS
Parse a GARS string

Returns
GARS
Parameters
- gars: string
  
  GARS string
Returns GARS
- Defined in lib/GARS.ts:275

`Static` precision

precision(gars: string): GridType
Parse the GARS string for the precision

Returns
grid type precision
Parameters
- gars: string
  
  GARS string
Returns GridType
- Defined in lib/GARS.ts:320

Generated using TypeDoc