Skip to content

Class astrea::snapshot::EthzClient

ClassList > astrea > snapshot > EthzClient

EthzClient class for interacting with the ETHZ satellite database API.More...

  • #include <EthzClient.hpp>

Public Functions

Type Name
EthzClient ()
Default constructor for EthzClient .
nlohmann::json query (const astro::Date & startDate, const astro::Date & endDate, const std::string & name, const bool & includeFrequencyData=false)
Queries the ETHZ satellite database for satellite data.
nlohmann::json query (const astro::Date & startDate, const astro::Date & endDate, const unsigned & noradId, const bool & includeFrequencyData=false)
Queries the ETHZ satellite database for satellite data by NORAD ID.
~EthzClient () = default
Default destructor for EthzClient .

Detailed Description

This class provides methods to query satellite data from the ETHZ satellite database. It supports querying by date range and satellite name or NORAD ID, and can include frequency data if requested.

Public Functions Documentation

function EthzClient

Default constructor for EthzClient . 

inline astrea::snapshot::EthzClient::EthzClient ()

Initializes the EthzClient with a minimum start date of 2023-03-10 00:00:00.0.

function query [1/2]

Queries the ETHZ satellite database for satellite data. 

nlohmann::json astrea::snapshot::EthzClient::query (
    const astro::Date & startDate,
    const astro::Date & endDate,
    const std::string & name,
    const bool & includeFrequencyData=false
)

This function sends a request to the ETHZ satellite database API to retrieve satellite data within the specified date range and optionally includes frequency data.

Parameters:

  • startDate The start date for the query.
  • endDate The end date for the query.
  • name Optional name of the satellite to filter results.
  • noradId Optional NORAD ID of the satellite to filter results.
  • includeFrequencyData Whether to include frequency data in the results (default is false).

Returns:

A JSON object containing the query results.

function query [2/2]

Queries the ETHZ satellite database for satellite data by NORAD ID. 

nlohmann::json astrea::snapshot::EthzClient::query (
    const astro::Date & startDate,
    const astro::Date & endDate,
    const unsigned & noradId,
    const bool & includeFrequencyData=false
)

This function sends a request to the ETHZ satellite database API to retrieve satellite data for a specific NORAD ID within the specified date range and optionally includes frequency data.

Parameters:

  • startDate The start date for the query.
  • endDate The end date for the query.
  • noradId The NORAD ID of the satellite to filter results.
  • includeFrequencyData Whether to include frequency data in the results (default is false).

Returns:

A JSON object containing the query results.

function ~EthzClient

Default destructor for EthzClient . 

astrea::snapshot::EthzClient::~EthzClient () = default

The documentation for this class was generated from the following file astrea/snapshot/snapshot/http-queries/ethz/EthzClient.hpp