CitraClient.Schemas.CoordinatedAccessWindow (citra_client v0.3.0)

View Source

A coordinated observation window where multiple ground stations can observe a satellite.

For single-station access, the accesses list contains exactly one HorizonAccess. For multi-station/TDOA access, it contains one HorizonAccess per participating ground station, each with its own correct viewing geometry (azimuth, elevation, range).

The overlap_start and overlap_end represent when ALL stations can see the satellite simultaneously (the intersection of their individual access windows).

Fields

  • :accesses — list of CitraClient.Schemas.HorizonAccess.t()
  • :duration — number() — Duration of the overlapping window in minutes.
  • :overlap_end — String.t() (API key: overlapEnd)
  • :overlap_start — String.t() (API key: overlapStart)
  • :satellite_id — String.t() (API key: satelliteId)
  • :satellite_name — String.t() (API key: satelliteName)

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.CoordinatedAccessWindow{
  accesses: [CitraClient.Schemas.HorizonAccess.t() | map() | nil],
  duration: number() | nil,
  overlap_end: String.t() | nil,
  overlap_start: String.t() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | 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.