2016-12-09 20:28:21 +00:00
|
|
|
/*****************************************************************************
|
2018-05-14 22:46:17 +00:00
|
|
|
* Open MCT, Copyright (c) 2014-2018, United States Government
|
2016-12-09 20:28:21 +00:00
|
|
|
* as represented by the Administrator of the National Aeronautics and Space
|
|
|
|
* Administration. All rights reserved.
|
|
|
|
*
|
|
|
|
* Open MCT is licensed under the Apache License, Version 2.0 (the
|
|
|
|
* "License"); you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0.
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
|
|
|
*
|
|
|
|
* Open MCT includes source code licensed under additional open source
|
|
|
|
* licenses. See the Open Source Licenses file (LICENSES.md) included with
|
|
|
|
* this source code distribution or the Licensing information page available
|
|
|
|
* at runtime from the About dialog for additional information.
|
|
|
|
*****************************************************************************/
|
2017-05-10 02:15:15 +00:00
|
|
|
/*global console*/
|
2016-12-09 20:28:21 +00:00
|
|
|
|
|
|
|
define([
|
|
|
|
'lodash'
|
|
|
|
], function (
|
|
|
|
_
|
|
|
|
) {
|
|
|
|
|
|
|
|
function applyReasonableDefaults(valueMetadata, index) {
|
|
|
|
valueMetadata.source = valueMetadata.source || valueMetadata.key;
|
|
|
|
valueMetadata.hints = valueMetadata.hints || {};
|
|
|
|
|
2017-05-10 02:15:15 +00:00
|
|
|
if (valueMetadata.hints.hasOwnProperty('x')) {
|
|
|
|
console.warn(
|
2017-05-10 21:48:55 +00:00
|
|
|
'DEPRECATION WARNING: `x` hints should be replaced with ' +
|
2017-05-10 02:15:15 +00:00
|
|
|
'`domain` hints moving forward. ' +
|
|
|
|
'https://github.com/nasa/openmct/issues/1546'
|
|
|
|
);
|
|
|
|
if (!valueMetadata.hints.hasOwnProperty('domain')) {
|
|
|
|
valueMetadata.hints.domain = valueMetadata.hints.x;
|
|
|
|
}
|
|
|
|
delete valueMetadata.hints.x;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (valueMetadata.hints.hasOwnProperty('y')) {
|
|
|
|
console.warn(
|
2017-05-10 21:48:55 +00:00
|
|
|
'DEPRECATION WARNING: `y` hints should be replaced with ' +
|
2017-05-10 02:15:15 +00:00
|
|
|
'`range` hints moving forward. ' +
|
|
|
|
'https://github.com/nasa/openmct/issues/1546'
|
|
|
|
);
|
|
|
|
if (!valueMetadata.hints.hasOwnProperty('range')) {
|
|
|
|
valueMetadata.hints.range = valueMetadata.hints.y;
|
|
|
|
}
|
|
|
|
delete valueMetadata.hints.y;
|
|
|
|
}
|
|
|
|
|
2018-03-02 22:29:34 +00:00
|
|
|
if (valueMetadata.format === 'enum') {
|
|
|
|
if (!valueMetadata.values) {
|
2020-04-24 18:53:31 +00:00
|
|
|
valueMetadata.values = _.pluck(valueMetadata.enumerations, 'value');
|
2018-03-02 22:29:34 +00:00
|
|
|
}
|
|
|
|
if (!valueMetadata.hasOwnProperty('max')) {
|
2020-04-24 18:53:31 +00:00
|
|
|
valueMetadata.max = _.max(valueMetadata.values) + 1;
|
2018-03-02 22:29:34 +00:00
|
|
|
}
|
|
|
|
if (!valueMetadata.hasOwnProperty('min')) {
|
2020-04-24 18:53:31 +00:00
|
|
|
valueMetadata.min = _.min(valueMetadata.values) - 1;
|
2018-03-02 22:29:34 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-09 20:28:21 +00:00
|
|
|
if (!valueMetadata.hints.hasOwnProperty('priority')) {
|
|
|
|
valueMetadata.hints.priority = index;
|
|
|
|
}
|
|
|
|
return valueMetadata;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-03-21 21:18:08 +00:00
|
|
|
* Utility class for handling and inspecting telemetry metadata. Applies
|
|
|
|
* reasonable defaults to simplify the task of providing metadata, while
|
|
|
|
* also providing methods for interrogating telemetry metadata.
|
2016-12-09 20:28:21 +00:00
|
|
|
*/
|
2018-03-21 21:18:08 +00:00
|
|
|
function TelemetryMetadataManager(metadata) {
|
|
|
|
this.metadata = metadata;
|
2016-12-09 20:28:21 +00:00
|
|
|
|
2020-03-26 17:25:04 +00:00
|
|
|
this.valueMetadatas = this.metadata.values ? this.metadata.values.map(applyReasonableDefaults) : [];
|
2016-12-09 20:28:21 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get value metadata for a single key.
|
|
|
|
*/
|
|
|
|
TelemetryMetadataManager.prototype.value = function (key) {
|
|
|
|
return this.valueMetadatas.filter(function (metadata) {
|
2016-12-19 23:57:07 +00:00
|
|
|
return metadata.key === key;
|
2016-12-09 20:28:21 +00:00
|
|
|
})[0];
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns all value metadatas, sorted by priority.
|
|
|
|
*/
|
|
|
|
TelemetryMetadataManager.prototype.values = function () {
|
|
|
|
return this.valuesForHints(['priority']);
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get an array of valueMetadatas that posess all hints requested.
|
|
|
|
* Array is sorted based on hint priority.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
TelemetryMetadataManager.prototype.valuesForHints = function (
|
|
|
|
hints
|
|
|
|
) {
|
|
|
|
function hasHint(hint) {
|
2016-12-19 23:57:07 +00:00
|
|
|
/*jshint validthis: true */
|
2016-12-09 20:28:21 +00:00
|
|
|
return this.hints.hasOwnProperty(hint);
|
|
|
|
}
|
|
|
|
function hasHints(metadata) {
|
|
|
|
return hints.every(hasHint, metadata);
|
|
|
|
}
|
|
|
|
var matchingMetadata = this.valueMetadatas.filter(hasHints);
|
2019-03-14 20:49:37 +00:00
|
|
|
let iteratees = hints.map(hint => {
|
|
|
|
return (metadata) => {
|
2016-12-09 20:28:21 +00:00
|
|
|
return metadata.hints[hint];
|
2019-03-14 20:49:37 +00:00
|
|
|
}
|
2016-12-09 20:28:21 +00:00
|
|
|
});
|
2020-04-24 18:53:31 +00:00
|
|
|
return _.sortByAll(matchingMetadata, ...iteratees);
|
2016-12-09 20:28:21 +00:00
|
|
|
};
|
|
|
|
|
2019-03-12 19:20:03 +00:00
|
|
|
TelemetryMetadataManager.prototype.getFilterableValues = function () {
|
|
|
|
return this.valueMetadatas.filter(metadatum => metadatum.filters && metadatum.filters.length > 0);
|
|
|
|
}
|
|
|
|
|
2018-12-11 19:28:16 +00:00
|
|
|
TelemetryMetadataManager.prototype.getDefaultDisplayValue = function () {
|
|
|
|
let valueMetadata = this.valuesForHints(['range'])[0];
|
|
|
|
|
|
|
|
if (valueMetadata === undefined) {
|
|
|
|
valueMetadata = this.values().filter(values => {
|
|
|
|
return !(values.hints.domain);
|
|
|
|
})[0];
|
|
|
|
}
|
|
|
|
|
|
|
|
if (valueMetadata === undefined) {
|
|
|
|
valueMetadata = this.values()[0];
|
|
|
|
}
|
|
|
|
|
|
|
|
return valueMetadata.key;
|
|
|
|
};
|
|
|
|
|
2016-12-09 20:28:21 +00:00
|
|
|
|
|
|
|
return TelemetryMetadataManager;
|
|
|
|
|
|
|
|
});
|