Brasilapi.Cptec.HourlyWaves (BrasilAPI v1.0.2)

Copy Markdown View Source

Struct representing hourly wave conditions for ocean forecast.

Summary

Types

t()

Functions

from_map(map)

Creates a HourlyWaves struct from a map.

Types

t()

@type t() :: %Brasilapi.Cptec.HourlyWaves{
  agitacao: String.t(),
  altura_onda: number(),
  direcao_onda: String.t(),
  direcao_onda_desc: String.t(),
  direcao_vento: String.t(),
  direcao_vento_desc: String.t(),
  hora: String.t(),
  vento: number()
}

Functions

from_map(map)

@spec from_map(map()) :: t()

Creates a HourlyWaves struct from a map.

Examples

iex> Brasilapi.Cptec.HourlyWaves.from_map(%{
...>   "vento" => 15.5,
...>   "direcao_vento" => "S",
...>   "altura_onda" => 1.2,
...>   "hora" => "00h Z"
...> })
%Brasilapi.Cptec.HourlyWaves{vento: 15.5, direcao_vento: "S", altura_onda: 1.2, hora: "00h Z"}