CitraClient.Schemas.GroundTrackResponse (citra_client v0.3.0)

View Source

Ground track data for a satellite over a time period.

Fields

  • :current_index — integer() (API key: currentIndex) — Index of the point closest to current time (for highlighting current position)
  • :elset_epoch — String.t() (API key: elsetEpoch) — Epoch of the elset used for ground track calculation
  • :elset_review_status — ReviewStatus (see OpenAPI spec) (API key: elsetReviewStatus) — Review status of the elset (only included if not approved)
  • :elset_type — String.t() (API key: elsetType) — Type of the elset (e.g., SGP4, SGP4-XP)
  • :orbit_regime — String.t() (API key: orbitRegime) — Orbit regime (LEO, MEO, GEO, HEO)
  • :points — list of CitraClient.Schemas.GroundTrackPoint.t() — List of ground track points
  • :satellite_id — String.t() (API key: satelliteId) — Unique identifier of the satellite
  • :satellite_name — String.t() (API key: satelliteName) — Name of the satellite
  • :user_group_name — String.t() (API key: userGroupName) — Group name if elset from a group
  • :username — String.t() — Username of elset creator

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.GroundTrackResponse{
  current_index: integer() | nil,
  elset_epoch: String.t() | nil,
  elset_review_status: map() | String.t() | nil,
  elset_type: String.t() | nil,
  orbit_regime: String.t() | nil,
  points: [CitraClient.Schemas.GroundTrackPoint.t() | map() | nil],
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  user_group_name: String.t() | nil,
  username: 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.