CitraClient.Schemas.HorizonAccess (citra_client v0.3.0)

View Source

A single ground station's access window to a satellite.

Represents when a specific ground station can observe a satellite, including the viewing geometry (azimuth, elevation) at the start and end.

Fields

  • :duration — number()
  • :end — CitraClient.Schemas.HorizonState.t()
  • :ground_station_id — String.t() (API key: groundStationId)
  • :ground_station_name — String.t() (API key: groundStationName)
  • :satellite_id — String.t() (API key: satelliteId)
  • :satellite_name — String.t() (API key: satelliteName)
  • :start — CitraClient.Schemas.HorizonState.t()

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.HorizonAccess{
  duration: number() | nil,
  end: CitraClient.Schemas.HorizonState.t() | map() | nil,
  ground_station_id: String.t() | nil,
  ground_station_name: String.t() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  start: CitraClient.Schemas.HorizonState.t() | map() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.