CitraClient.Schemas.OrbitalElementPoint (citra_client v0.3.0)

View Source

A single point in orbital elements history.

Fields

  • :apogee_altitude — number() (API key: apogeeAltitude) — Apogee altitude in km
  • :b_star — number() (API key: bStar) — B* drag term (1/Earth radii)
  • :ballistic_coefficient — number() (API key: ballisticCoefficient) — Ballistic coefficient (m^2/kg)
  • :eccentricity — number() — Eccentricity (dimensionless)
  • :elset_id — UUID String.t() (API key: elsetId) — Elset ID for selection
  • :elset_type — String.t() (API key: elsetType) — Elset type (e.g., SGP4, SGP4-XP)
  • :epoch — DateTime.t() — Elset epoch time
  • :inclination — number() — Inclination in degrees
  • :orbital_period — number() (API key: orbitalPeriod) — Orbital period in minutes
  • :perigee_altitude — number() (API key: perigeeAltitude) — Perigee altitude in km
  • :raan — number() — Right ascension of ascending node in degrees
  • :review_status — ReviewStatus (see OpenAPI spec) (API key: reviewStatus) — Review status of the elset
  • :semi_major_axis — number() (API key: semiMajorAxis) — Semi-major axis in km
  • :srp_coefficient — number() (API key: srpCoefficient) — Solar radiation pressure coefficient (m^2/kg)
  • :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.OrbitalElementPoint{
  apogee_altitude: number() | nil,
  b_star: number() | nil,
  ballistic_coefficient: number() | nil,
  eccentricity: number() | nil,
  elset_id: String.t() | nil,
  elset_type: String.t() | nil,
  epoch: DateTime.t() | nil,
  inclination: number() | nil,
  orbital_period: number() | nil,
  perigee_altitude: number() | nil,
  raan: number() | nil,
  review_status: map() | String.t() | nil,
  semi_major_axis: number() | nil,
  srp_coefficient: number() | 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.