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

[JSDoc] Add annotations

Browse Source 
Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
Victor Woeltjen
2015-08-07 11:44:54 -07:00
parent 14f97eae9c
commit c08a460d30
239 changed files with 939 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -33,6 +33,7 @@ define(
* A telemetry aggregator makes many telemetry providers
* appear as one.
*
* @memberof platform/telemetry
* @constructor
*/
function TelemetryAggregator($q, telemetryProviders) {
@ -84,6 +85,7 @@ define(
* @returns {Promise} a promise for telemetry data
* which may (or may not, depending on
* availability) satisfy the requests
* @memberof platform/telemetry.TelemetryAggregator#
*/
requestTelemetry: requestTelemetry,
/**
@ -100,6 +102,7 @@ define(
* requests to be subscribed upon
* @returns {Function} a function which can be called
* to unsubscribe
* @memberof platform/telemetry.TelemetryAggregator#
*/
subscribe: subscribe
};
@ -107,4 +110,4 @@ define(
return TelemetryAggregator;
}
);
);

5
platform/telemetry/src/TelemetryCapability.js
View File

@ -41,6 +41,7 @@ define(
* for a specific object, and for unwrapping the response (to get
* at the specific data which is appropriate to the domain object.)
*
* @memberof platform/telemetry
* @constructor
*/
function TelemetryCapability($injector, $q, $log, domainObject) {
@ -151,12 +152,14 @@ define(
* specific request
* @returns {Promise} a promise for the resulting telemetry
* object
* @memberof platform/telemetry.TelemetryCapability#
*/
requestData: requestTelemetry,
/**
* Get metadata about this domain object's associated
* telemetry.
* @memberof platform/telemetry.TelemetryCapability#
*/
getMetadata: function () {
// metadata just looks like a request,
@ -174,6 +177,7 @@ define(
* containing the data will be given as an argument.
* @param {TelemetryRequest} [request] parameters for the
* subscription request
* @memberof platform/telemetry.TelemetryCapability#
*/
subscribe: subscribe
};
@ -191,3 +195,4 @@ define(
return TelemetryCapability;
}
);

9
platform/telemetry/src/TelemetryController.js
View File

@ -34,6 +34,7 @@ define(
* which need to issue requests for telemetry data and use the
* results
*
* @memberof platform/telemetry
* @constructor
*/
function TelemetryController($scope, $q, $timeout, $log) {
@ -314,6 +315,7 @@ define(
* given index will correspond to the telemetry-providing
* domain object at the same index.
* @returns {Array} an array of metadata objects
* @memberof platform/telemetry.TelemetryController#
*/
getMetadata: function () {
return self.metadatas;
@ -328,6 +330,7 @@ define(
* given index will correspond to the telemetry-providing
* domain object at the same index.
* @returns {DomainObject[]} an array of metadata objects
* @memberof platform/telemetry.TelemetryController#
*/
getTelemetryObjects: function () {
return self.telemetryObjects;
@ -345,6 +348,7 @@ define(
* response at a given index will correspond to the
* telemetry-providing domain object at the same index.
* @returns {Array} an array of responses
* @memberof platform/telemetry.TelemetryController#
*/
getResponse: function getResponse(arg) {
var id = arg && (typeof arg === 'string' ?
@ -364,6 +368,7 @@ define(
* show user feedback, such as a wait spinner.
*
* @returns {boolean} true if the request is still outstanding
* @memberof platform/telemetry.TelemetryController#
*/
isRequestPending: function () {
return self.pending > 0;
@ -372,6 +377,7 @@ define(
* Issue a new data request. This will change the
* request parameters that are passed along to all
* telemetry capabilities managed by this controller.
* @memberof platform/telemetry.TelemetryController#
*/
requestData: function (request) {
self.request = request || {};
@ -382,6 +388,7 @@ define(
* perform its polling activity.
* @param {number} durationMillis the interval at
* which to poll, in milliseconds
* @memberof platform/telemetry.TelemetryController#
*/
setRefreshInterval: function (durationMillis) {
self.interval = durationMillis;
@ -392,4 +399,4 @@ define(
return TelemetryController;
}
);
);

5
platform/telemetry/src/TelemetryDelegator.js
View File

@ -29,6 +29,8 @@ define(
/**
* Used to handle telemetry delegation associated with a
* given domain object.
* @constructor
* @memberof platform/telemetry
*/
function TelemetryDelegator($q) {
return {
@ -38,6 +40,7 @@ define(
* or the objects it delegates)
* @returns {Promise.<DomainObject[]>} domain objects with
* a telemetry capability
* @memberof platform/telemetry.TelemetryDelegator#
*/
promiseTelemetryObjects: function (domainObject) {
// If object has been cleared, there are no relevant
@ -63,4 +66,4 @@ define(
return TelemetryDelegator;
}
);
);

5
platform/telemetry/src/TelemetryFormatter.js
View File

@ -35,6 +35,7 @@ define(
* The TelemetryFormatter is responsible for formatting (as text
* for display) values along either the domain (usually time) or
* the range (usually value) of a data series.
* @memberof platform/telemetry
* @constructor
*/
function TelemetryFormatter() {
@ -56,6 +57,7 @@ define(
* be treated as a standard timestamp.
* @returns {string} a textual representation of the
* data and time, suitable for display.
* @memberof platform/telemetry.TelemetryFormatter#
*/
formatDomainValue: formatDomainValue,
/**
@ -66,6 +68,7 @@ define(
* be treated as a numeric value.
* @returns {string} a textual representation of the
* value, suitable for display.
* @memberof platform/telemetry.TelemetryFormatter#
*/
formatRangeValue: formatRangeValue
};
@ -73,4 +76,4 @@ define(
return TelemetryFormatter;
}
);
);

6
platform/telemetry/src/TelemetryHandle.js
View File

@ -34,6 +34,8 @@ define(
* @param $q Angular's $q, for promises
* @param {TelemetrySubscription} subscription a subscription
* to supplied telemetry
* @constructor
* @memberof platform/telemetry
*/
function TelemetryHandle($q, subscription) {
var seriesMap = {},
@ -67,6 +69,7 @@ define(
* data associated with it
* @return {TelemetrySeries} the most recent telemetry series
* (or undefined if there is not one)
* @memberof platform/telemetry.TelemetryHandle#
*/
self.getSeries = function (domainObject) {
var id = domainObject.getId();
@ -81,6 +84,7 @@ define(
* @param {Function} [callback] a callback that will be
* invoked as new data becomes available, with the
* domain object for which new data is available.
* @memberof platform/telemetry.TelemetryHandle#
*/
self.request = function (request, callback) {
// Issue (and handle) the new request from this object
@ -109,4 +113,4 @@ define(
return TelemetryHandle;
}
);
);

3
platform/telemetry/src/TelemetryHandler.js
View File

@ -31,6 +31,7 @@ define(
* A TelemetryRequester provides an easy interface to request
* telemetry associated with a set of domain objects.
*
* @memberof platform/telemetry
* @constructor
* @param $q Angular's $q
*/
@ -51,4 +52,4 @@ define(
return TelemetryHandler;
}
);
);

6
platform/telemetry/src/TelemetryQueue.js
View File

@ -32,6 +32,7 @@ define(
* a queued series of large objects, ensuring that no value is
* overwritten (but consolidated non-overlapping keys into single
* objects.)
* @memberof platform/telemetry
* @constructor
*/
function TelemetryQueue() {
@ -102,6 +103,7 @@ define(
/**
* Check if any value groups remain in this pool.
* @return {boolean} true if value groups remain
* @memberof platform/telemetry.TelemetryQueue#
*/
isEmpty: function () {
return queue.length < 1;
@ -112,6 +114,7 @@ define(
* where keys and values correspond to the arguments
* given to previous put functions.
* @return {object} key-value pairs
* @memberof platform/telemetry.TelemetryQueue#
*/
poll: function () {
// Decrement counts for the object that will be popped
@ -122,6 +125,7 @@ define(
* Put a key-value pair into the pool.
* @param {string} key the key to store the value under
* @param {*} value the value to store
* @memberof platform/telemetry.TelemetryQueue#
*/
put: function (key, value) {
getFreeObject(key)[key] = value;
@ -131,4 +135,4 @@ define(
return TelemetryQueue;
}
);
);

4
platform/telemetry/src/TelemetrySubscriber.js
View File

@ -38,6 +38,7 @@ define(
* (e.g. for telemetry panels) as well as latest-value
* extraction.
*
* @memberof platform/telemetry
* @constructor
* @param $q Angular's $q
* @param $timeout Angular's $timeout
@ -62,6 +63,7 @@ define(
*
* @method
* @memberof TelemetrySubscriber
* @memberof platform/telemetry.TelemetrySubscriber#
*/
subscribe: function (domainObject, callback, lossless) {
return new TelemetrySubscription(
@ -77,4 +79,4 @@ define(
return TelemetrySubscriber;
}
);
);

9
platform/telemetry/src/TelemetrySubscription.js
View File

@ -38,6 +38,7 @@ define(
* (e.g. for telemetry panels) as well as latest-value
* extraction.
*
* @memberof platform/telemetry
* @constructor
* @param $q Angular's $q
* @param $timeout Angular's $timeout
@ -227,6 +228,7 @@ define(
* with this object.
* @method
* @memberof TelemetrySubscription
* @memberof platform/telemetry.TelemetrySubscription#
*/
unsubscribe: function () {
if (unlistenToMutation) {
@ -247,6 +249,7 @@ define(
* @returns the most recent domain value observed
* @method
* @memberof TelemetrySubscription
* @memberof platform/telemetry.TelemetrySubscription#
*/
getDomainValue: function (domainObject) {
var id = domainObject.getId();
@ -265,6 +268,7 @@ define(
* @returns the most recent range value observed
* @method
* @memberof TelemetrySubscription
* @memberof platform/telemetry.TelemetrySubscription#
*/
getRangeValue: function (domainObject) {
var id = domainObject.getId();
@ -275,6 +279,7 @@ define(
*
* @param {DomainObject} domainObject the object of interest
* @returns {TelemetryDatum} the most recent datum
* @memberof platform/telemetry.TelemetrySubscription#
*/
getDatum: function (domainObject) {
var id = domainObject.getId();
@ -294,6 +299,7 @@ define(
* @returns {DomainObject[]} all subscribed-to domain objects
* @method
* @memberof TelemetrySubscription
* @memberof platform/telemetry.TelemetrySubscription#
*/
getTelemetryObjects: function () {
return telemetryObjects;
@ -309,6 +315,7 @@ define(
* given index will correspond to the telemetry-providing
* domain object at the same index.
* @returns {Array} an array of metadata objects
* @memberof platform/telemetry.TelemetrySubscription#
*/
getMetadata: function () {
return metadatas;
@ -318,6 +325,7 @@ define(
* associated with this subscription.
* @returns {Promise.<DomainObject[]>} a promise for
* telemetry-providing objects
* @memberof platform/telemetry.TelemetrySubscription#
*/
promiseTelemetryObjects: function () {
// Unsubscribe promise is available after objects
@ -331,3 +339,4 @@ define(
}
);

6
platform/telemetry/src/TelemetryTable.js
View File

@ -32,6 +32,7 @@ define(
* one large object, overwriting new values as necessary. Stands
* in contrast to the TelemetryQueue, which will avoid overwriting
* values.
* @memberof platform/telemetry
* @constructor
*/
function TelemetryTable() {
@ -41,6 +42,7 @@ define(
/**
* Check if any value groups remain in this pool.
* @return {boolean} true if value groups remain
* @memberof platform/telemetry.TelemetryTable#
*/
isEmpty: function () {
return !table;
@ -51,6 +53,7 @@ define(
* where keys and values correspond to the arguments
* given to previous put functions.
* @return {object} key-value pairs
* @memberof platform/telemetry.TelemetryTable#
*/
poll: function () {
var t = table;
@ -61,6 +64,7 @@ define(
* Put a key-value pair into the pool.
* @param {string} key the key to store the value under
* @param {*} value the value to store
* @memberof platform/telemetry.TelemetryTable#
*/
put: function (key, value) {
table = table || {};
@ -71,4 +75,4 @@ define(
return TelemetryTable;
}
);
);