CitraClient.Schemas.SolveAccessSatellitesToLocation (citra_client v0.3.0)

View Source

Fields used when making a request for access window calculations from satellites to geographic locations (waypoints)

Fields

  • :min_duration — number() (API key: minDuration) — Minimum duration in minutes for a valid access
  • :min_elevation — number() (API key: minElevation) — Minimum elevation angle in degrees for a valid access
  • :satellite_group_ids — list of UUID String.t() (API key: satelliteGroupIds) — Optional list of satellite group IDs to filter satellites. If provided, only satellites in these groups will be considered (deduplicated). If not provided, all satellites are used.
  • :waypoints — list of CitraClient.Schemas.Waypoint.t() — List of waypoints with locations and time ranges

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.SolveAccessSatellitesToLocation{
  min_duration: number() | nil,
  min_elevation: number() | nil,
  satellite_group_ids: [String.t() | nil],
  waypoints: [CitraClient.Schemas.Waypoint.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.