HamRadio v0.1.0 HamRadio.Grid View Source

Converts between coordinates and Maidenhead grid locators.

Link to this section Summary

Types

coord()

coord_bounds()

grid_length()

Functions

decode(grid)

Converts a grid square into a coordinate pair.

decode!(grid)

Converts a grid square into a coordinate pair.

decode_bounds(grid)

Converts a grid square into the boundaries of its enclosing rectangle.

decode_bounds!(grid)

Converts a grid square into the boundaries of its enclosing rectangle.

encode(coord, length \\ 4)

Converts a coordinate pair into a grid square.

encode!(coord, length \\ 4)

Converts a coordinate pair into a grid square.

format(grid)

Normalizes the string casing of a grid square.

valid?(grid)

Determines if a grid square is legit.

Link to this section Types

coord()

coord() :: {lat :: float(), lon :: float()}

coord_bounds()

coord_bounds() ::
  {{lat_min :: float(), lat_max :: float()},
   {lon_min :: float(), lon_max :: float()}}

grid_length()

grid_length() :: 4 | 6

Link to this section Functions

decode(grid)

decode(String.t()) :: {:ok, coord()} | :error

Converts a grid square into a coordinate pair.

The coordinate is located at the center of the grid square.

Returns :error if the grid is invalid.

decode!(grid)

decode!(String.t()) :: coord() | no_return()

Converts a grid square into a coordinate pair.

Raises ArgumentError if the grid is invalid.

decode_bounds(grid)

decode_bounds(String.t()) :: {:ok, coord_bounds()} | :error

Converts a grid square into the boundaries of its enclosing rectangle.

Returns :error if the grid is invalid.

decode_bounds!(grid)

decode_bounds!(String.t()) :: coord_bounds() | no_return()

Converts a grid square into the boundaries of its enclosing rectangle.

Raises ArgumentError if the grid is invalid.

encode(coord, length \\ 4)

encode(coord(), grid_length()) :: {:ok, String.t()} | :error

Converts a coordinate pair into a grid square.

The length can be 4 (default) or 6, returning grids like "FN32" or "FN32ab", respectively.

encode!(coord, length \\ 4)

encode!(coord(), grid_length()) :: String.t() | no_return()

Converts a coordinate pair into a grid square.

Raises ArgumentError if the coordinates are invalid.

format(grid)

format(String.t()) :: String.t()

Normalizes the string casing of a grid square.

iex> HamRadio.Grid.format("fn32ab")
"FN32ab"

valid?(grid)

valid?(String.t()) :: boolean()

Determines if a grid square is legit.