ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-16 06:08:11 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[Telemetry] Add JSDoc

Browse Source 
Add JSDoc and in-line comments to scripts in the
platform/telemetry bundle, for WTD-575.
This commit is contained in:
Victor Woeltjen
2014-11-28 20:59:41 -08:00
parent f8a0544435
commit 55c2d15cdc
4 changed files with 190 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
platform/telemetry/src/TelemetryAggregator.js
View File

@ -9,17 +9,20 @@ define(
"use strict";
/**
* A telemetry aggregator makes many telemetry providers
* appear as one.
*
* @constructor
*/
function TelemetryAggregator($q, telemetryProviders) {
// Merge the results from many providers into one
// result object.
function mergeResults(results) {
var merged = {};
results.forEach(function (result) {
Object.keys(result).forEach(function (k) {
// Otherwise, just take the result
merged[k] = result[k];
});
});
@ -27,6 +30,8 @@ define(
return merged;
}
// Request telemetry from all providers; once they've
// responded, merge the results into one result object.
function requestTelemetry(requests) {
return $q.all(telemetryProviders.map(function (provider) {
return provider.requestTelemetry(requests);
@ -34,6 +39,14 @@ define(
}
return {
/**
* Request telemetry data.
* @param {TelemetryRequest[]} requests and array of
* requests to be handled
* @returns {Promise} a promise for telemetry data
* which may (or may not, depending on
* availability) satisfy the requests
*/
requestTelemetry: requestTelemetry
};
}