CitraClient.Schemas.ElsetOutput (citra_client v0.3.0)

View Source

Struct generated from the Elset-Output schema.

Fields

  • :argument_of_perigeenumber() (API key: argumentOfPerigee)
  • :b_starnumber() (API key: bStar)
  • :ballistic_coefficientnumber() (API key: ballisticCoefficient)
  • :creation_epochString.t() (API key: creationEpoch)
  • :eccentricitynumber()
  • :epochString.t()
  • :idString.t()
  • :inclinationnumber()
  • :mean_anomalynumber() (API key: meanAnomaly)
  • :mean_motionnumber() (API key: meanMotion) — Calculate mean motion from semi-major axis.

Uses keplime's mean_motion_from_semi_major_axis() to convert semi-major axis to mean motion.

Returns:

Mean motion in revolutions per day
  • :mean_motion_dotnumber() (API key: meanMotionDot)
  • :mean_motion_dot_dotnumber() (API key: meanMotionDotDot)
  • :migration_id — UUID String.t() (API key: migrationId)
  • :raannumber()
  • :review_statusReviewStatus (see OpenAPI spec) (API key: reviewStatus)
  • :rmsnumber()
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :satellite_nameString.t() (API key: satelliteName)
  • :satellite_review_statusReviewStatus (see OpenAPI spec) (API key: satelliteReviewStatus)
  • :semi_major_axisnumber() (API key: semiMajorAxis)
  • :srp_coefficientnumber() (API key: srpCoefficient)
  • :tle — list of any()
  • :typeCitraElsetType (see OpenAPI spec)
  • :user_group_id — UUID String.t() (API key: userGroupId)
  • :user_group_nameString.t() (API key: userGroupName)
  • :user_id — UUID String.t() (API key: userId)
  • :user_tierUserTier (see OpenAPI spec) (API key: userTier)
  • :usernameString.t()

Summary

Functions

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

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.ElsetOutput{
  argument_of_perigee: number() | nil,
  b_star: number() | nil,
  ballistic_coefficient: number() | nil,
  creation_epoch: String.t() | nil,
  eccentricity: number() | nil,
  epoch: String.t() | nil,
  id: String.t() | nil,
  inclination: number() | nil,
  mean_anomaly: number() | nil,
  mean_motion: number() | nil,
  mean_motion_dot: number() | nil,
  mean_motion_dot_dot: number() | nil,
  migration_id: String.t() | nil,
  raan: number() | nil,
  review_status: map() | String.t() | nil,
  rms: number() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  satellite_review_status: map() | String.t() | nil,
  semi_major_axis: number() | nil,
  srp_coefficient: number() | nil,
  tle: [any()],
  type: map() | String.t() | nil,
  user_group_id: String.t() | nil,
  user_group_name: String.t() | nil,
  user_id: String.t() | nil,
  user_tier: map() | 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.