CitraClient.Schemas.FOVAccessPost (citra_client v0.3.0)

View Source

Struct generated from the FOVAccessPost schema.

Fields

  • :declinationnumber() — Topocentric declination in degrees
  • :epochDateTime.t() — Epoch of observation in UTC
  • :field_of_viewnumber() (API key: fieldOfView) — Sensor field of view in degrees
  • :right_ascensionnumber() (API key: rightAscension) — Topocentric right ascension in degrees
  • :sensor_altitudenumber() (API key: sensorAltitude) — Sensor altitude in kilometers
  • :sensor_frameReferenceFrame (see OpenAPI spec) (API key: sensorFrame) — Reference frame of topocentric elements provided
  • :sensor_latitudenumber() (API key: sensorLatitude) — Sensor latitude in degrees
  • :sensor_longitudenumber() (API key: sensorLongitude) — Sensor longitude in degrees

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.FOVAccessPost{
  declination: number() | nil,
  epoch: DateTime.t() | nil,
  field_of_view: number() | nil,
  right_ascension: number() | nil,
  sensor_altitude: number() | nil,
  sensor_frame: map() | String.t() | nil,
  sensor_latitude: number() | nil,
  sensor_longitude: number() | 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.