mirror of
https://github.com/nasa/openmct.git
synced 2025-01-11 23:42:41 +00:00
[Telemetry] Document TelemetryRequest
Document TelemetryRequest to record new parameters in support of the time conductor, WTD-1515
This commit is contained in:
parent
29c460556a
commit
47b97a504e
@ -31,6 +31,30 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
"use strict";
|
"use strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a request for telemetry data. Note that responses
|
||||||
|
* may contain either a sub- or superset of the requested data.
|
||||||
|
* @typedef TelemetryRequest
|
||||||
|
* @property {string} source an identifier for the relevant
|
||||||
|
* source of telemetry data
|
||||||
|
* @property {string} key an identifier for the specific
|
||||||
|
* series of telemetry data provided by that source
|
||||||
|
* @property {number} [start] the earliest domain value of
|
||||||
|
* interest for that telemetry data; for time-based
|
||||||
|
* domains, this is in milliseconds since the start
|
||||||
|
* of 1970
|
||||||
|
* @property {number} [end] the latest domain value of interest
|
||||||
|
* for that telemetry data; for time-based domains,
|
||||||
|
* this is in milliseconds since 1970
|
||||||
|
* @property {string} [domain] the domain for the query; if
|
||||||
|
* omitted, this will be whatever the "normal"
|
||||||
|
* domain is for a given telemetry series (the
|
||||||
|
* first domain from its metadata)
|
||||||
|
* @property {number} [size] if set, indicates the maximum number
|
||||||
|
* of data points of interest for this request (more
|
||||||
|
* recent domain values will be preferred)
|
||||||
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Request telemetry data.
|
* Request telemetry data.
|
||||||
* @param {TelemetryRequest[]} requests and array of
|
* @param {TelemetryRequest[]} requests and array of
|
||||||
|
Loading…
Reference in New Issue
Block a user