mirror of
https://github.com/nasa/openmct.git
synced 2025-06-27 11:32:13 +00:00
Compare commits
59 Commits
plot-perfo
...
unload-ope
Author | SHA1 | Date | |
---|---|---|---|
b062615c25 | |||
4ba8f893a6 | |||
c4b9be18f1 | |||
eabdf6cd04 | |||
e56c673005 | |||
dad9f12a5c | |||
aa5edb0b83 | |||
b315803180 | |||
b27317631b | |||
953a9daafb | |||
63f9cd449f | |||
54220f547b | |||
93d967c2b3 | |||
1226459c6f | |||
d7c9c9cb98 | |||
e784242379 | |||
da8dbf25bf | |||
a5571eec05 | |||
19802ce2cc | |||
e83735a927 | |||
c9a47a411a | |||
a6e55fd493 | |||
76f35a0bcd | |||
b6930ef7cd | |||
57b9cbd42f | |||
17901147ef | |||
58b8f90682 | |||
d06cbc8975 | |||
2131ef2397 | |||
553b18587c | |||
590dc74e45 | |||
3557ed4b4c | |||
41cc52d50a | |||
48c22369a1 | |||
6506077f4d | |||
b1b4266ff3 | |||
42b0148f93 | |||
9461ad8edd | |||
40055ba955 | |||
9cb85ad176 | |||
f2b2953a5d | |||
62de310686 | |||
4b9ff67e49 | |||
d5e32ec494 | |||
38880ba3d1 | |||
a99ce7733c | |||
9f48764210 | |||
a1aaa0dd41 | |||
bee15e98c8 | |||
092bbe547d | |||
6cbe05317c | |||
3b92fcdf6c | |||
6dde54bd25 | |||
359e7377ac | |||
9f4190f781 | |||
f3fc991a74 | |||
2564e75fc9 | |||
f42fe78acf | |||
fe928a1386 |
@ -56,14 +56,38 @@ workflows:
|
|||||||
browser: ChromeHeadless
|
browser: ChromeHeadless
|
||||||
always-pass: false
|
always-pass: false
|
||||||
- test:
|
- test:
|
||||||
name: node12-firefoxESR
|
name: node12-firefoxESR-build-only
|
||||||
node-version: lts/erbium
|
node-version: lts/erbium
|
||||||
browser: FirefoxESR
|
browser: FirefoxESR
|
||||||
always-pass: true
|
always-pass: true
|
||||||
- test:
|
- test:
|
||||||
name: node14-chrome
|
name: node14-chrome-build-only
|
||||||
node-version: lts/fermium
|
node-version: lts/fermium
|
||||||
browser: ChromeHeadless
|
browser: ChromeHeadless
|
||||||
always-pass: true
|
always-pass: true
|
||||||
|
nightly:
|
||||||
|
jobs:
|
||||||
|
- test:
|
||||||
|
name: node10-chrome-nightly
|
||||||
|
node-version: lts/dubnium
|
||||||
|
browser: ChromeHeadless
|
||||||
|
always-pass: false
|
||||||
|
- test:
|
||||||
|
name: node12-firefoxESR-nightly
|
||||||
|
node-version: lts/erbium
|
||||||
|
browser: FirefoxESR
|
||||||
|
always-pass: false
|
||||||
|
- test:
|
||||||
|
name: node14-chrome-nightly
|
||||||
|
node-version: lts/fermium
|
||||||
|
browser: ChromeHeadless
|
||||||
|
always-pass: false
|
||||||
|
triggers:
|
||||||
|
- schedule:
|
||||||
|
cron: "0 0 * * *"
|
||||||
|
filters:
|
||||||
|
branches:
|
||||||
|
only:
|
||||||
|
- master
|
||||||
|
|
||||||
|
|
||||||
|
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
* [ ] Have you followed the guidelines in our [Contributing document](https://github.com/nasa/openmct/blob/master/CONTRIBUTING.md)?
|
* [ ] Have you followed the guidelines in our [Contributing document](https://github.com/nasa/openmct/blob/master/CONTRIBUTING.md)?
|
||||||
* [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/nasa/openmct/pulls) for the same update/change?
|
* [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/nasa/openmct/pulls) for the same update/change?
|
||||||
|
* [ ] Is this change backwards compatible? Will users need to change how they are calling the API, or how they've extended core plugins such as Tables or Plots?
|
||||||
|
|
||||||
### Author Checklist
|
### Author Checklist
|
||||||
|
|
||||||
|
33
.github/workflows/codeql-analysis.yml
vendored
Normal file
33
.github/workflows/codeql-analysis.yml
vendored
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
|
||||||
|
name: "CodeQL"
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ master ]
|
||||||
|
schedule:
|
||||||
|
- cron: '28 21 * * 3'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
analyze:
|
||||||
|
name: Analyze
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
actions: read
|
||||||
|
contents: read
|
||||||
|
security-events: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
# Initializes the CodeQL tools for scanning.
|
||||||
|
- name: Initialize CodeQL
|
||||||
|
uses: github/codeql-action/init@v1
|
||||||
|
with:
|
||||||
|
languages: javascript
|
||||||
|
|
||||||
|
- name: Autobuild
|
||||||
|
uses: github/codeql-action/autobuild@v1
|
||||||
|
|
||||||
|
- name: Perform CodeQL Analysis
|
||||||
|
uses: github/codeql-action/analyze@v1
|
2
API.md
2
API.md
@ -996,7 +996,7 @@ reveal additional information when the mouse cursor is hovered over it.
|
|||||||
A common use case for indicators is to convey the state of some external system such as a
|
A common use case for indicators is to convey the state of some external system such as a
|
||||||
persistence backend or HTTP server. So long as this system is accessible via HTTP request,
|
persistence backend or HTTP server. So long as this system is accessible via HTTP request,
|
||||||
Open MCT provides a general purpose indicator to show whether the server is available and
|
Open MCT provides a general purpose indicator to show whether the server is available and
|
||||||
returing a 2xx status code. The URL Status Indicator is made available as a default plugin. See
|
returning a 2xx status code. The URL Status Indicator is made available as a default plugin. See
|
||||||
the [documentation](./src/plugins/URLIndicatorPlugin) for details on how to install and configure the
|
the [documentation](./src/plugins/URLIndicatorPlugin) for details on how to install and configure the
|
||||||
URL Status Indicator.
|
URL Status Indicator.
|
||||||
|
|
||||||
|
@ -317,6 +317,7 @@ checklist).
|
|||||||
### Reviewer Checklist
|
### Reviewer Checklist
|
||||||
|
|
||||||
* [ ] Changes appear to address issue?
|
* [ ] Changes appear to address issue?
|
||||||
|
* [ ] Changes appear not to be breaking changes?
|
||||||
* [ ] Appropriate unit tests included?
|
* [ ] Appropriate unit tests included?
|
||||||
* [ ] Code style and in-line documentation are appropriate?
|
* [ ] Code style and in-line documentation are appropriate?
|
||||||
* [ ] Commit messages meet standards?
|
* [ ] Commit messages meet standards?
|
||||||
|
@ -423,7 +423,7 @@ which can help with this, however.
|
|||||||
instead of separate approaches for static and substitutable
|
instead of separate approaches for static and substitutable
|
||||||
dependencies.
|
dependencies.
|
||||||
* Removes need to understand Angular's DI mechanism.
|
* Removes need to understand Angular's DI mechanism.
|
||||||
* Improves useability of documentation (`typeService` is an
|
* Improves usability of documentation (`typeService` is an
|
||||||
instance of `CompositeService` and implements `TypeService`
|
instance of `CompositeService` and implements `TypeService`
|
||||||
so you can easily traverse links in the JSDoc.)
|
so you can easily traverse links in the JSDoc.)
|
||||||
* Can be used more easily from Web Workers, allowing services
|
* Can be used more easily from Web Workers, allowing services
|
||||||
|
@ -25,7 +25,7 @@
|
|||||||
## Legacy Documentation
|
## Legacy Documentation
|
||||||
|
|
||||||
As we transition to a new API, the following documentation for the old API
|
As we transition to a new API, the following documentation for the old API
|
||||||
(which is supported during the transtion) may be useful as well:
|
(which is supported during the transition) may be useful as well:
|
||||||
|
|
||||||
* The [Architecture Overview](architecture/) describes the concepts used
|
* The [Architecture Overview](architecture/) describes the concepts used
|
||||||
throughout Open MCT, and gives a high level overview of the platform's design.
|
throughout Open MCT, and gives a high level overview of the platform's design.
|
||||||
|
@ -41,11 +41,6 @@ define([
|
|||||||
"$scope"
|
"$scope"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"routes": [
|
|
||||||
{
|
|
||||||
"templateUrl": "templates/exampleForm.html"
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -28,6 +28,15 @@ define([
|
|||||||
domain: 2
|
domain: 2
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
key: "cos",
|
||||||
|
name: "Cosine",
|
||||||
|
unit: "deg",
|
||||||
|
formatString: '%0.2f',
|
||||||
|
hints: {
|
||||||
|
domain: 3
|
||||||
|
}
|
||||||
|
},
|
||||||
// Need to enable "LocalTimeSystem" plugin to make use of this
|
// Need to enable "LocalTimeSystem" plugin to make use of this
|
||||||
// {
|
// {
|
||||||
// key: "local",
|
// key: "local",
|
||||||
@ -109,6 +118,100 @@ define([
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
'example.spectral-generator': {
|
||||||
|
values: [
|
||||||
|
{
|
||||||
|
key: "name",
|
||||||
|
name: "Name",
|
||||||
|
format: "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "utc",
|
||||||
|
name: "Time",
|
||||||
|
format: "utc",
|
||||||
|
hints: {
|
||||||
|
domain: 1
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "wavelength",
|
||||||
|
name: "Wavelength",
|
||||||
|
unit: "Hz",
|
||||||
|
formatString: '%0.2f',
|
||||||
|
hints: {
|
||||||
|
domain: 2,
|
||||||
|
spectralAttribute: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "cos",
|
||||||
|
name: "Cosine",
|
||||||
|
unit: "deg",
|
||||||
|
formatString: '%0.2f',
|
||||||
|
hints: {
|
||||||
|
range: 2,
|
||||||
|
spectralAttribute: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
'example.spectral-aggregate-generator': {
|
||||||
|
values: [
|
||||||
|
{
|
||||||
|
key: "name",
|
||||||
|
name: "Name",
|
||||||
|
format: "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "utc",
|
||||||
|
name: "Time",
|
||||||
|
format: "utc",
|
||||||
|
hints: {
|
||||||
|
domain: 1
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "ch1",
|
||||||
|
name: "Channel 1",
|
||||||
|
format: "string",
|
||||||
|
hints: {
|
||||||
|
range: 1
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "ch2",
|
||||||
|
name: "Channel 2",
|
||||||
|
format: "string",
|
||||||
|
hints: {
|
||||||
|
range: 2
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "ch3",
|
||||||
|
name: "Channel 3",
|
||||||
|
format: "string",
|
||||||
|
hints: {
|
||||||
|
range: 3
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "ch4",
|
||||||
|
name: "Channel 4",
|
||||||
|
format: "string",
|
||||||
|
hints: {
|
||||||
|
range: 4
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "ch5",
|
||||||
|
name: "Channel 5",
|
||||||
|
format: "string",
|
||||||
|
hints: {
|
||||||
|
range: 5
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -96,5 +96,9 @@ define([
|
|||||||
return this.workerInterface.subscribe(workerRequest, callback);
|
return this.workerInterface.subscribe(workerRequest, callback);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
GeneratorProvider.prototype.destroy = function () {
|
||||||
|
this.workerInterface.destroy();
|
||||||
|
};
|
||||||
|
|
||||||
return GeneratorProvider;
|
return GeneratorProvider;
|
||||||
});
|
});
|
||||||
|
86
example/generator/SpectralAggregateGeneratorProvider.js
Normal file
86
example/generator/SpectralAggregateGeneratorProvider.js
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
define([
|
||||||
|
|
||||||
|
], function (
|
||||||
|
|
||||||
|
) {
|
||||||
|
|
||||||
|
function SpectralAggregateGeneratorProvider() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function pointForTimestamp(timestamp, count, name) {
|
||||||
|
return {
|
||||||
|
name: name,
|
||||||
|
utc: String(Math.floor(timestamp / count) * count),
|
||||||
|
ch1: String(Math.floor(timestamp / count) % 1),
|
||||||
|
ch2: String(Math.floor(timestamp / count) % 2),
|
||||||
|
ch3: String(Math.floor(timestamp / count) % 3),
|
||||||
|
ch4: String(Math.floor(timestamp / count) % 4),
|
||||||
|
ch5: String(Math.floor(timestamp / count) % 5)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
SpectralAggregateGeneratorProvider.prototype.supportsSubscribe = function (domainObject) {
|
||||||
|
return domainObject.type === 'example.spectral-aggregate-generator';
|
||||||
|
};
|
||||||
|
|
||||||
|
SpectralAggregateGeneratorProvider.prototype.subscribe = function (domainObject, callback) {
|
||||||
|
var count = 5000;
|
||||||
|
|
||||||
|
var interval = setInterval(function () {
|
||||||
|
var now = Date.now();
|
||||||
|
var datum = pointForTimestamp(now, count, domainObject.name);
|
||||||
|
callback(datum);
|
||||||
|
}, count);
|
||||||
|
|
||||||
|
return function () {
|
||||||
|
clearInterval(interval);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
SpectralAggregateGeneratorProvider.prototype.supportsRequest = function (domainObject, options) {
|
||||||
|
return domainObject.type === 'example.spectral-aggregate-generator';
|
||||||
|
};
|
||||||
|
|
||||||
|
SpectralAggregateGeneratorProvider.prototype.request = function (domainObject, options) {
|
||||||
|
var start = options.start;
|
||||||
|
var end = Math.min(Date.now(), options.end); // no future values
|
||||||
|
var count = 5000;
|
||||||
|
if (options.strategy === 'latest' || options.size === 1) {
|
||||||
|
start = end;
|
||||||
|
}
|
||||||
|
|
||||||
|
var data = [];
|
||||||
|
while (start <= end && data.length < 5000) {
|
||||||
|
data.push(pointForTimestamp(start, count, domainObject.name));
|
||||||
|
start += count;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Promise.resolve(data);
|
||||||
|
};
|
||||||
|
|
||||||
|
return SpectralAggregateGeneratorProvider;
|
||||||
|
|
||||||
|
});
|
102
example/generator/SpectralGeneratorProvider.js
Normal file
102
example/generator/SpectralGeneratorProvider.js
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
define([
|
||||||
|
'./WorkerInterface'
|
||||||
|
], function (
|
||||||
|
WorkerInterface
|
||||||
|
) {
|
||||||
|
|
||||||
|
var REQUEST_DEFAULTS = {
|
||||||
|
amplitude: 1,
|
||||||
|
wavelength: 1,
|
||||||
|
period: 10,
|
||||||
|
offset: 0,
|
||||||
|
dataRateInHz: 1,
|
||||||
|
randomness: 0,
|
||||||
|
phase: 0
|
||||||
|
};
|
||||||
|
|
||||||
|
function SpectralGeneratorProvider() {
|
||||||
|
this.workerInterface = new WorkerInterface();
|
||||||
|
}
|
||||||
|
|
||||||
|
SpectralGeneratorProvider.prototype.canProvideTelemetry = function (domainObject) {
|
||||||
|
return domainObject.type === 'example.spectral-generator';
|
||||||
|
};
|
||||||
|
|
||||||
|
SpectralGeneratorProvider.prototype.supportsRequest =
|
||||||
|
SpectralGeneratorProvider.prototype.supportsSubscribe =
|
||||||
|
SpectralGeneratorProvider.prototype.canProvideTelemetry;
|
||||||
|
|
||||||
|
SpectralGeneratorProvider.prototype.makeWorkerRequest = function (domainObject, request = {}) {
|
||||||
|
var props = [
|
||||||
|
'amplitude',
|
||||||
|
'wavelength',
|
||||||
|
'period',
|
||||||
|
'offset',
|
||||||
|
'dataRateInHz',
|
||||||
|
'phase',
|
||||||
|
'randomness'
|
||||||
|
];
|
||||||
|
|
||||||
|
var workerRequest = {};
|
||||||
|
|
||||||
|
props.forEach(function (prop) {
|
||||||
|
if (domainObject.telemetry && Object.prototype.hasOwnProperty.call(domainObject.telemetry, prop)) {
|
||||||
|
workerRequest[prop] = domainObject.telemetry[prop];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (request && Object.prototype.hasOwnProperty.call(request, prop)) {
|
||||||
|
workerRequest[prop] = request[prop];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!Object.prototype.hasOwnProperty.call(workerRequest, prop)) {
|
||||||
|
workerRequest[prop] = REQUEST_DEFAULTS[prop];
|
||||||
|
}
|
||||||
|
|
||||||
|
workerRequest[prop] = Number(workerRequest[prop]);
|
||||||
|
});
|
||||||
|
|
||||||
|
workerRequest.name = domainObject.name;
|
||||||
|
|
||||||
|
return workerRequest;
|
||||||
|
};
|
||||||
|
|
||||||
|
SpectralGeneratorProvider.prototype.request = function (domainObject, request) {
|
||||||
|
var workerRequest = this.makeWorkerRequest(domainObject, request);
|
||||||
|
workerRequest.start = request.start;
|
||||||
|
workerRequest.end = request.end;
|
||||||
|
workerRequest.spectra = true;
|
||||||
|
|
||||||
|
return this.workerInterface.request(workerRequest);
|
||||||
|
};
|
||||||
|
|
||||||
|
SpectralGeneratorProvider.prototype.subscribe = function (domainObject, callback) {
|
||||||
|
var workerRequest = this.makeWorkerRequest(domainObject, {});
|
||||||
|
workerRequest.spectra = true;
|
||||||
|
|
||||||
|
return this.workerInterface.subscribe(workerRequest, callback);
|
||||||
|
};
|
||||||
|
|
||||||
|
return SpectralGeneratorProvider;
|
||||||
|
});
|
@ -63,7 +63,7 @@ define([
|
|||||||
|
|
||||||
StateGeneratorProvider.prototype.request = function (domainObject, options) {
|
StateGeneratorProvider.prototype.request = function (domainObject, options) {
|
||||||
var start = options.start;
|
var start = options.start;
|
||||||
var end = options.end;
|
var end = Math.min(Date.now(), options.end); // no future values
|
||||||
var duration = domainObject.telemetry.duration * 1000;
|
var duration = domainObject.telemetry.duration * 1000;
|
||||||
if (options.strategy === 'latest' || options.size === 1) {
|
if (options.strategy === 'latest' || options.size === 1) {
|
||||||
start = end;
|
start = end;
|
||||||
|
@ -40,6 +40,11 @@ define([
|
|||||||
this.callbacks = {};
|
this.callbacks = {};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
WorkerInterface.prototype.destroy = function () {
|
||||||
|
delete this.worker.onmessage;
|
||||||
|
this.worker.terminate();
|
||||||
|
};
|
||||||
|
|
||||||
WorkerInterface.prototype.onMessage = function (message) {
|
WorkerInterface.prototype.onMessage = function (message) {
|
||||||
message = message.data;
|
message = message.data;
|
||||||
var callback = this.callbacks[message.id];
|
var callback = this.callbacks[message.id];
|
||||||
|
@ -54,23 +54,38 @@
|
|||||||
var start = Date.now();
|
var start = Date.now();
|
||||||
var step = 1000 / data.dataRateInHz;
|
var step = 1000 / data.dataRateInHz;
|
||||||
var nextStep = start - (start % step) + step;
|
var nextStep = start - (start % step) + step;
|
||||||
|
let work;
|
||||||
|
if (data.spectra) {
|
||||||
|
work = function (now) {
|
||||||
|
while (nextStep < now) {
|
||||||
|
const messageCopy = Object.create(message);
|
||||||
|
message.data.start = nextStep - (60 * 1000);
|
||||||
|
message.data.end = nextStep;
|
||||||
|
onRequest(messageCopy);
|
||||||
|
nextStep += step;
|
||||||
|
}
|
||||||
|
|
||||||
function work(now) {
|
return nextStep;
|
||||||
while (nextStep < now) {
|
};
|
||||||
self.postMessage({
|
} else {
|
||||||
id: message.id,
|
work = function (now) {
|
||||||
data: {
|
while (nextStep < now) {
|
||||||
name: data.name,
|
self.postMessage({
|
||||||
utc: nextStep,
|
id: message.id,
|
||||||
yesterday: nextStep - 60 * 60 * 24 * 1000,
|
data: {
|
||||||
sin: sin(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness),
|
name: data.name,
|
||||||
cos: cos(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness)
|
utc: nextStep,
|
||||||
}
|
yesterday: nextStep - 60 * 60 * 24 * 1000,
|
||||||
});
|
sin: sin(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness),
|
||||||
nextStep += step;
|
wavelength: wavelength(start, nextStep),
|
||||||
}
|
cos: cos(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness)
|
||||||
|
}
|
||||||
|
});
|
||||||
|
nextStep += step;
|
||||||
|
}
|
||||||
|
|
||||||
return nextStep;
|
return nextStep;
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
subscriptions[message.id] = work;
|
subscriptions[message.id] = work;
|
||||||
@ -111,13 +126,21 @@
|
|||||||
utc: nextStep,
|
utc: nextStep,
|
||||||
yesterday: nextStep - 60 * 60 * 24 * 1000,
|
yesterday: nextStep - 60 * 60 * 24 * 1000,
|
||||||
sin: sin(nextStep, period, amplitude, offset, phase, randomness),
|
sin: sin(nextStep, period, amplitude, offset, phase, randomness),
|
||||||
|
wavelength: wavelength(start, nextStep),
|
||||||
cos: cos(nextStep, period, amplitude, offset, phase, randomness)
|
cos: cos(nextStep, period, amplitude, offset, phase, randomness)
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
self.postMessage({
|
self.postMessage({
|
||||||
id: message.id,
|
id: message.id,
|
||||||
data: data
|
data: request.spectra ? {
|
||||||
|
wavelength: data.map((item) => {
|
||||||
|
return item.wavelength;
|
||||||
|
}),
|
||||||
|
cos: data.map((item) => {
|
||||||
|
return item.cos;
|
||||||
|
})
|
||||||
|
} : data
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -131,6 +154,10 @@
|
|||||||
* Math.sin(phase + (timestamp / period / 1000 * Math.PI * 2)) + (amplitude * Math.random() * randomness) + offset;
|
* Math.sin(phase + (timestamp / period / 1000 * Math.PI * 2)) + (amplitude * Math.random() * randomness) + offset;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function wavelength(start, nextStep) {
|
||||||
|
return (nextStep - start) / 10;
|
||||||
|
}
|
||||||
|
|
||||||
function sendError(error, message) {
|
function sendError(error, message) {
|
||||||
self.postMessage({
|
self.postMessage({
|
||||||
error: error.name + ': ' + error.message,
|
error: error.name + ': ' + error.message,
|
||||||
|
@ -24,11 +24,15 @@ define([
|
|||||||
"./GeneratorProvider",
|
"./GeneratorProvider",
|
||||||
"./SinewaveLimitProvider",
|
"./SinewaveLimitProvider",
|
||||||
"./StateGeneratorProvider",
|
"./StateGeneratorProvider",
|
||||||
|
"./SpectralGeneratorProvider",
|
||||||
|
"./SpectralAggregateGeneratorProvider",
|
||||||
"./GeneratorMetadataProvider"
|
"./GeneratorMetadataProvider"
|
||||||
], function (
|
], function (
|
||||||
GeneratorProvider,
|
GeneratorProvider,
|
||||||
SinewaveLimitProvider,
|
SinewaveLimitProvider,
|
||||||
StateGeneratorProvider,
|
StateGeneratorProvider,
|
||||||
|
SpectralGeneratorProvider,
|
||||||
|
SpectralAggregateGeneratorProvider,
|
||||||
GeneratorMetadataProvider
|
GeneratorMetadataProvider
|
||||||
) {
|
) {
|
||||||
|
|
||||||
@ -61,6 +65,37 @@ define([
|
|||||||
|
|
||||||
openmct.telemetry.addProvider(new StateGeneratorProvider());
|
openmct.telemetry.addProvider(new StateGeneratorProvider());
|
||||||
|
|
||||||
|
openmct.types.addType("example.spectral-generator", {
|
||||||
|
name: "Spectral Generator",
|
||||||
|
description: "For development use. Generates example streaming telemetry data using a simple sine wave algorithm.",
|
||||||
|
cssClass: "icon-generator-telemetry",
|
||||||
|
creatable: true,
|
||||||
|
initialize: function (object) {
|
||||||
|
object.telemetry = {
|
||||||
|
period: 10,
|
||||||
|
amplitude: 1,
|
||||||
|
wavelength: 1,
|
||||||
|
frequency: 1,
|
||||||
|
offset: 0,
|
||||||
|
dataRateInHz: 1,
|
||||||
|
phase: 0,
|
||||||
|
randomness: 0
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
openmct.telemetry.addProvider(new SpectralGeneratorProvider());
|
||||||
|
|
||||||
|
openmct.types.addType("example.spectral-aggregate-generator", {
|
||||||
|
name: "Spectral Aggregate Generator",
|
||||||
|
description: "For development use. Generates example streaming telemetry data using a simple state algorithm.",
|
||||||
|
cssClass: "icon-generator-telemetry",
|
||||||
|
creatable: true,
|
||||||
|
initialize: function (object) {
|
||||||
|
object.telemetry = {};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
openmct.telemetry.addProvider(new SpectralAggregateGeneratorProvider());
|
||||||
|
|
||||||
openmct.types.addType("generator", {
|
openmct.types.addType("generator", {
|
||||||
name: "Sine Wave Generator",
|
name: "Sine Wave Generator",
|
||||||
description: "For development use. Generates example streaming telemetry data using a simple sine wave algorithm.",
|
description: "For development use. Generates example streaming telemetry data using a simple sine wave algorithm.",
|
||||||
@ -146,7 +181,11 @@ define([
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
openmct.telemetry.addProvider(new GeneratorProvider());
|
const generatorProvider = new GeneratorProvider();
|
||||||
|
openmct.once('destroy', () => {
|
||||||
|
generatorProvider.destroy();
|
||||||
|
});
|
||||||
|
openmct.telemetry.addProvider(generatorProvider);
|
||||||
openmct.telemetry.addProvider(new GeneratorMetadataProvider());
|
openmct.telemetry.addProvider(new GeneratorMetadataProvider());
|
||||||
openmct.telemetry.addProvider(new SinewaveLimitProvider());
|
openmct.telemetry.addProvider(new SinewaveLimitProvider());
|
||||||
};
|
};
|
||||||
|
@ -152,7 +152,7 @@
|
|||||||
<h2>How to Use Glyphs</h2>
|
<h2>How to Use Glyphs</h2>
|
||||||
<div class="cols cols1-1">
|
<div class="cols cols1-1">
|
||||||
<div class="col">
|
<div class="col">
|
||||||
<p>The easiest way to use a glyph is to include its CSS class in an element. The CSS adds a psuedo <code>:before</code> HTML element to whatever element it's attached to that makes proper use of the symbols font.</p>
|
<p>The easiest way to use a glyph is to include its CSS class in an element. The CSS adds a pseudo <code>:before</code> HTML element to whatever element it's attached to that makes proper use of the symbols font.</p>
|
||||||
<p>Alternately, you can use the <code>.ui-symbol</code> class in an object that contains encoded HTML entities. This method is only recommended if you cannot use the aforementioned CSS class approach.</p>
|
<p>Alternately, you can use the <code>.ui-symbol</code> class in an object that contains encoded HTML entities. This method is only recommended if you cannot use the aforementioned CSS class approach.</p>
|
||||||
</div>
|
</div>
|
||||||
<mct-example><a class="s-button icon-gear" title="Settings"></a>
|
<mct-example><a class="s-button icon-gear" title="Settings"></a>
|
||||||
|
@ -195,6 +195,7 @@
|
|||||||
['table', 'telemetry.plot.overlay', 'telemetry.plot.stacked'],
|
['table', 'telemetry.plot.overlay', 'telemetry.plot.stacked'],
|
||||||
{indicator: true}
|
{indicator: true}
|
||||||
));
|
));
|
||||||
|
openmct.install(openmct.plugins.Clock({ enableClockIndicator: true }));
|
||||||
openmct.start();
|
openmct.start();
|
||||||
</script>
|
</script>
|
||||||
</html>
|
</html>
|
||||||
|
16
package.json
16
package.json
@ -1,8 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "openmct",
|
"name": "openmct",
|
||||||
"version": "1.7.6-SNAPSHOT",
|
"version": "1.7.8-SNAPSHOT",
|
||||||
"description": "The Open MCT core platform",
|
"description": "The Open MCT core platform",
|
||||||
"dependencies": {},
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"angular": ">=1.8.0",
|
"angular": ">=1.8.0",
|
||||||
"angular-route": "1.4.14",
|
"angular-route": "1.4.14",
|
||||||
@ -12,16 +11,9 @@
|
|||||||
"copy-webpack-plugin": "^4.5.2",
|
"copy-webpack-plugin": "^4.5.2",
|
||||||
"cross-env": "^6.0.3",
|
"cross-env": "^6.0.3",
|
||||||
"css-loader": "^1.0.0",
|
"css-loader": "^1.0.0",
|
||||||
"d3-array": "1.2.x",
|
|
||||||
"d3-axis": "1.0.x",
|
"d3-axis": "1.0.x",
|
||||||
"d3-collection": "1.0.x",
|
|
||||||
"d3-color": "1.0.x",
|
|
||||||
"d3-format": "1.2.x",
|
|
||||||
"d3-interpolate": "1.1.x",
|
|
||||||
"d3-scale": "1.0.x",
|
"d3-scale": "1.0.x",
|
||||||
"d3-selection": "1.3.x",
|
"d3-selection": "1.3.x",
|
||||||
"d3-time": "1.0.x",
|
|
||||||
"d3-time-format": "2.1.x",
|
|
||||||
"eslint": "7.0.0",
|
"eslint": "7.0.0",
|
||||||
"eslint-plugin-vue": "^7.5.0",
|
"eslint-plugin-vue": "^7.5.0",
|
||||||
"eslint-plugin-you-dont-need-lodash-underscore": "^6.10.0",
|
"eslint-plugin-you-dont-need-lodash-underscore": "^6.10.0",
|
||||||
@ -41,13 +33,13 @@
|
|||||||
"jsdoc": "^3.3.2",
|
"jsdoc": "^3.3.2",
|
||||||
"karma": "6.3.4",
|
"karma": "6.3.4",
|
||||||
"karma-chrome-launcher": "3.1.0",
|
"karma-chrome-launcher": "3.1.0",
|
||||||
"karma-firefox-launcher": "2.1.1",
|
|
||||||
"karma-cli": "2.0.0",
|
"karma-cli": "2.0.0",
|
||||||
"karma-coverage": "2.0.3",
|
"karma-coverage": "2.0.3",
|
||||||
"karma-coverage-istanbul-reporter": "3.0.3",
|
"karma-coverage-istanbul-reporter": "3.0.3",
|
||||||
"karma-junit-reporter": "2.0.1",
|
"karma-firefox-launcher": "2.1.1",
|
||||||
"karma-html-reporter": "0.2.7",
|
"karma-html-reporter": "0.2.7",
|
||||||
"karma-jasmine": "4.0.1",
|
"karma-jasmine": "4.0.1",
|
||||||
|
"karma-junit-reporter": "2.0.1",
|
||||||
"karma-sourcemap-loader": "0.3.8",
|
"karma-sourcemap-loader": "0.3.8",
|
||||||
"karma-webpack": "4.0.2",
|
"karma-webpack": "4.0.2",
|
||||||
"location-bar": "^3.0.1",
|
"location-bar": "^3.0.1",
|
||||||
@ -62,6 +54,8 @@
|
|||||||
"node-bourbon": "^4.2.3",
|
"node-bourbon": "^4.2.3",
|
||||||
"node-sass": "^4.14.1",
|
"node-sass": "^4.14.1",
|
||||||
"painterro": "^1.2.56",
|
"painterro": "^1.2.56",
|
||||||
|
"plotly.js-basic-dist": "^2.5.0",
|
||||||
|
"plotly.js-gl2d-dist": "^2.5.0",
|
||||||
"printj": "^1.2.1",
|
"printj": "^1.2.1",
|
||||||
"raw-loader": "^0.5.1",
|
"raw-loader": "^0.5.1",
|
||||||
"request": "^2.69.0",
|
"request": "^2.69.0",
|
||||||
|
@ -164,16 +164,6 @@ define([
|
|||||||
"license": "license-apache",
|
"license": "license-apache",
|
||||||
"link": "http://logging.apache.org/log4net/license.html"
|
"link": "http://logging.apache.org/log4net/license.html"
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"routes": [
|
|
||||||
{
|
|
||||||
"when": "/licenses",
|
|
||||||
"template": licensesTemplate
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"when": "/licenses-md",
|
|
||||||
"template": licensesExportMdTemplate
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -50,8 +50,6 @@ define([
|
|||||||
name: "platform/commonUI/browse",
|
name: "platform/commonUI/browse",
|
||||||
definition: {
|
definition: {
|
||||||
"extensions": {
|
"extensions": {
|
||||||
"routes": [
|
|
||||||
],
|
|
||||||
"constants": [
|
"constants": [
|
||||||
{
|
{
|
||||||
"key": "DEFAULT_PATH",
|
"key": "DEFAULT_PATH",
|
||||||
|
@ -39,9 +39,6 @@ define(
|
|||||||
this.callbacks = [];
|
this.callbacks = [];
|
||||||
this.checks = [];
|
this.checks = [];
|
||||||
this.$window = $window;
|
this.$window = $window;
|
||||||
|
|
||||||
this.oldUnload = $window.onbeforeunload;
|
|
||||||
$window.onbeforeunload = this.onBeforeUnload.bind(this);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -64,7 +61,7 @@ define(
|
|||||||
*
|
*
|
||||||
* @param {DomainObject} domainObject the domain object to navigate to
|
* @param {DomainObject} domainObject the domain object to navigate to
|
||||||
* @param {Boolean} force if true, force navigation to occur.
|
* @param {Boolean} force if true, force navigation to occur.
|
||||||
* @returns {Boolean} true if navigation occured, otherwise false.
|
* @returns {Boolean} true if navigation occurred, otherwise false.
|
||||||
*/
|
*/
|
||||||
NavigationService.prototype.setNavigation = function (domainObject, force) {
|
NavigationService.prototype.setNavigation = function (domainObject, force) {
|
||||||
if (force) {
|
if (force) {
|
||||||
|
@ -21,28 +21,14 @@
|
|||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
|
|
||||||
define([
|
define([
|
||||||
"./src/MCTDevice",
|
"./src/AgentService"
|
||||||
"./src/AgentService",
|
|
||||||
"./src/DeviceClassifier"
|
|
||||||
], function (
|
], function (
|
||||||
MCTDevice,
|
AgentService
|
||||||
AgentService,
|
|
||||||
DeviceClassifier
|
|
||||||
) {
|
) {
|
||||||
|
|
||||||
return {
|
return {
|
||||||
name: "platform/commonUI/mobile",
|
name: "platform/commonUI/mobile",
|
||||||
definition: {
|
definition: {
|
||||||
"extensions": {
|
"extensions": {
|
||||||
"directives": [
|
|
||||||
{
|
|
||||||
"key": "mctDevice",
|
|
||||||
"implementation": MCTDevice,
|
|
||||||
"depends": [
|
|
||||||
"agentService"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"key": "agentService",
|
"key": "agentService",
|
||||||
@ -51,15 +37,6 @@ define([
|
|||||||
"$window"
|
"$window"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"runs": [
|
|
||||||
{
|
|
||||||
"implementation": DeviceClassifier,
|
|
||||||
"depends": [
|
|
||||||
"agentService",
|
|
||||||
"$document"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -20,122 +20,12 @@
|
|||||||
* at runtime from the About dialog for additional information.
|
* at runtime from the About dialog for additional information.
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
|
|
||||||
/**
|
define(["../../../../src/utils/agent/Agent.js"], function (Agent) {
|
||||||
* Provides features which support variant behavior on mobile devices.
|
function AngularAgentServiceWrapper(window) {
|
||||||
*
|
const AS = Agent.default;
|
||||||
* @namespace platform/commonUI/mobile
|
|
||||||
*/
|
|
||||||
define(
|
|
||||||
[],
|
|
||||||
function () {
|
|
||||||
|
|
||||||
/**
|
return new AS(window);
|
||||||
* The query service handles calls for browser and userAgent
|
|
||||||
* info using a comparison between the userAgent and key
|
|
||||||
* device names
|
|
||||||
* @constructor
|
|
||||||
* @param $window Angular-injected instance of the window
|
|
||||||
* @memberof platform/commonUI/mobile
|
|
||||||
*/
|
|
||||||
function AgentService($window) {
|
|
||||||
var userAgent = $window.navigator.userAgent,
|
|
||||||
matches = userAgent.match(/iPad|iPhone|Android/i) || [];
|
|
||||||
|
|
||||||
this.userAgent = userAgent;
|
|
||||||
this.mobileName = matches[0];
|
|
||||||
this.$window = $window;
|
|
||||||
this.touchEnabled = ($window.ontouchstart !== undefined);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user is on a mobile device.
|
|
||||||
* @returns {boolean} true on mobile
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isMobile = function () {
|
|
||||||
return Boolean(this.mobileName);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user is on a phone-sized mobile device.
|
|
||||||
* @returns {boolean} true on a phone
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isPhone = function () {
|
|
||||||
if (this.isMobile()) {
|
|
||||||
if (this.isAndroidTablet()) {
|
|
||||||
return false;
|
|
||||||
} else if (this.mobileName === 'iPad') {
|
|
||||||
return false;
|
|
||||||
} else {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user is on a tablet sized android device
|
|
||||||
* @returns {boolean} true on an android tablet
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isAndroidTablet = function () {
|
|
||||||
if (this.mobileName === 'Android') {
|
|
||||||
if (this.isPortrait() && window.innerWidth >= 768) {
|
|
||||||
return true;
|
|
||||||
} else if (this.isLandscape() && window.innerHeight >= 768) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user is on a tablet-sized mobile device.
|
|
||||||
* @returns {boolean} true on a tablet
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isTablet = function () {
|
|
||||||
return (this.isMobile() && !this.isPhone() && this.mobileName !== 'Android') || (this.isMobile() && this.isAndroidTablet());
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user's device is in a portrait-style
|
|
||||||
* orientation (display width is narrower than display height.)
|
|
||||||
* @returns {boolean} true in portrait mode
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isPortrait = function () {
|
|
||||||
return this.$window.innerWidth < this.$window.innerHeight;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user's device is in a landscape-style
|
|
||||||
* orientation (display width is greater than display height.)
|
|
||||||
* @returns {boolean} true in landscape mode
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isLandscape = function () {
|
|
||||||
return !this.isPortrait();
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user's device supports a touch interface.
|
|
||||||
* @returns {boolean} true if touch is supported
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isTouch = function () {
|
|
||||||
return this.touchEnabled;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the user agent matches a certain named device,
|
|
||||||
* as indicated by checking for a case-insensitive substring
|
|
||||||
* match.
|
|
||||||
* @param {string} name the name to check for
|
|
||||||
* @returns {boolean} true if the user agent includes that name
|
|
||||||
*/
|
|
||||||
AgentService.prototype.isBrowser = function (name) {
|
|
||||||
name = name.toLowerCase();
|
|
||||||
|
|
||||||
return this.userAgent.toLowerCase().indexOf(name) !== -1;
|
|
||||||
};
|
|
||||||
|
|
||||||
return AgentService;
|
|
||||||
}
|
}
|
||||||
);
|
|
||||||
|
return AngularAgentServiceWrapper;
|
||||||
|
});
|
||||||
|
96
platform/commonUI/mobile/src/AgentServiceSpec.js
Normal file
96
platform/commonUI/mobile/src/AgentServiceSpec.js
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
import AgentService from "./AgentService";
|
||||||
|
|
||||||
|
const TEST_USER_AGENTS = {
|
||||||
|
DESKTOP:
|
||||||
|
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.89 Safari/537.36",
|
||||||
|
IPAD:
|
||||||
|
"Mozilla/5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A465 Safari/9537.53",
|
||||||
|
IPHONE:
|
||||||
|
"Mozilla/5.0 (iPhone; CPU iPhone OS 7_0 like Mac OS X; en-us) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A465 Safari/9537.53"
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("The AgentService", function () {
|
||||||
|
let testWindow;
|
||||||
|
let agentService;
|
||||||
|
|
||||||
|
beforeEach(function () {
|
||||||
|
testWindow = {
|
||||||
|
innerWidth: 640,
|
||||||
|
innerHeight: 480,
|
||||||
|
navigator: {
|
||||||
|
userAgent: TEST_USER_AGENTS.DESKTOP
|
||||||
|
}
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
it("recognizes desktop devices as non-mobile", function () {
|
||||||
|
testWindow.navigator.userAgent = TEST_USER_AGENTS.DESKTOP;
|
||||||
|
agentService = new AgentService(testWindow);
|
||||||
|
expect(agentService.isMobile()).toBeFalsy();
|
||||||
|
expect(agentService.isPhone()).toBeFalsy();
|
||||||
|
expect(agentService.isTablet()).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("detects iPhones", function () {
|
||||||
|
testWindow.navigator.userAgent = TEST_USER_AGENTS.IPHONE;
|
||||||
|
agentService = new AgentService(testWindow);
|
||||||
|
expect(agentService.isMobile()).toBeTruthy();
|
||||||
|
expect(agentService.isPhone()).toBeTruthy();
|
||||||
|
expect(agentService.isTablet()).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("detects iPads", function () {
|
||||||
|
testWindow.navigator.userAgent = TEST_USER_AGENTS.IPAD;
|
||||||
|
agentService = new AgentService(testWindow);
|
||||||
|
expect(agentService.isMobile()).toBeTruthy();
|
||||||
|
expect(agentService.isPhone()).toBeFalsy();
|
||||||
|
expect(agentService.isTablet()).toBeTruthy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("detects display orientation", function () {
|
||||||
|
agentService = new AgentService(testWindow);
|
||||||
|
testWindow.innerWidth = 1024;
|
||||||
|
testWindow.innerHeight = 400;
|
||||||
|
expect(agentService.isPortrait()).toBeFalsy();
|
||||||
|
expect(agentService.isLandscape()).toBeTruthy();
|
||||||
|
testWindow.innerWidth = 400;
|
||||||
|
testWindow.innerHeight = 1024;
|
||||||
|
expect(agentService.isPortrait()).toBeTruthy();
|
||||||
|
expect(agentService.isLandscape()).toBeFalsy();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("detects touch support", function () {
|
||||||
|
testWindow.ontouchstart = null;
|
||||||
|
expect(new AgentService(testWindow).isTouch()).toBe(true);
|
||||||
|
delete testWindow.ontouchstart;
|
||||||
|
expect(new AgentService(testWindow).isTouch()).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("allows for checking browser type", function () {
|
||||||
|
testWindow.navigator.userAgent = "Chromezilla Safarifox";
|
||||||
|
agentService = new AgentService(testWindow);
|
||||||
|
expect(agentService.isBrowser("Chrome")).toBe(true);
|
||||||
|
expect(agentService.isBrowser("Firefox")).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
@ -1,72 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
['./DeviceMatchers'],
|
|
||||||
function (DeviceMatchers) {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Runs at application startup and adds a subset of the following
|
|
||||||
* CSS classes to the body of the document, depending on device
|
|
||||||
* attributes:
|
|
||||||
*
|
|
||||||
* * `mobile`: Phones or tablets.
|
|
||||||
* * `phone`: Phones specifically.
|
|
||||||
* * `tablet`: Tablets specifically.
|
|
||||||
* * `desktop`: Non-mobile devices.
|
|
||||||
* * `portrait`: Devices in a portrait-style orientation.
|
|
||||||
* * `landscape`: Devices in a landscape-style orientation.
|
|
||||||
* * `touch`: Device supports touch events.
|
|
||||||
*
|
|
||||||
* @param {platform/commonUI/mobile.AgentService} agentService
|
|
||||||
* the service used to examine the user agent
|
|
||||||
* @param $document Angular's jqLite-wrapped document element
|
|
||||||
* @constructor
|
|
||||||
*/
|
|
||||||
function MobileClassifier(agentService, $document) {
|
|
||||||
var body = $document.find('body');
|
|
||||||
|
|
||||||
Object.keys(DeviceMatchers).forEach(function (key, index, array) {
|
|
||||||
if (DeviceMatchers[key](agentService)) {
|
|
||||||
body.addClass(key);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
if (agentService.isMobile()) {
|
|
||||||
var mediaQuery = window.matchMedia('(orientation: landscape)');
|
|
||||||
|
|
||||||
mediaQuery.addListener(function (event) {
|
|
||||||
if (event.matches) {
|
|
||||||
body.removeClass('portrait');
|
|
||||||
body.addClass('landscape');
|
|
||||||
} else {
|
|
||||||
body.removeClass('landscape');
|
|
||||||
body.addClass('portrait');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return MobileClassifier;
|
|
||||||
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,88 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
['./DeviceMatchers'],
|
|
||||||
function (DeviceMatchers) {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The `mct-device` directive, when applied as an attribute,
|
|
||||||
* only includes the element when the device being used matches
|
|
||||||
* a set of characteristics required.
|
|
||||||
*
|
|
||||||
* Required characteristics are given as space-separated strings
|
|
||||||
* as the value to this attribute, e.g.:
|
|
||||||
*
|
|
||||||
* <span mct-device="mobile portrait">Hello world!</span>
|
|
||||||
*
|
|
||||||
* ...will only show Hello world! when viewed on a mobile device
|
|
||||||
* in the portrait orientation.
|
|
||||||
*
|
|
||||||
* Valid device characteristics to detect are:
|
|
||||||
*
|
|
||||||
* * `mobile`: Phones or tablets.
|
|
||||||
* * `phone`: Phones specifically.
|
|
||||||
* * `tablet`: Tablets specifically.
|
|
||||||
* * `desktop`: Non-mobile devices.
|
|
||||||
* * `portrait`: Devices in a portrait-style orientation.
|
|
||||||
* * `landscape`: Devices in a landscape-style orientation.
|
|
||||||
* * `touch`: Device supports touch events.
|
|
||||||
*
|
|
||||||
* @param {AgentService} agentService used to detect device type
|
|
||||||
* based on information about the user agent
|
|
||||||
*/
|
|
||||||
function MCTDevice(agentService) {
|
|
||||||
|
|
||||||
function deviceMatches(tokens) {
|
|
||||||
tokens = tokens || "";
|
|
||||||
|
|
||||||
return tokens.split(" ").every(function (token) {
|
|
||||||
var fn = DeviceMatchers[token];
|
|
||||||
|
|
||||||
return fn && fn(agentService);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function link(scope, element, attrs, ctrl, transclude) {
|
|
||||||
if (deviceMatches(attrs.mctDevice)) {
|
|
||||||
transclude(function (clone) {
|
|
||||||
element.replaceWith(clone);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
link: link,
|
|
||||||
// We are transcluding the whole element (like ng-if)
|
|
||||||
transclude: 'element',
|
|
||||||
// 1 more than ng-if
|
|
||||||
priority: 601,
|
|
||||||
// Also terminal, since element will be transcluded
|
|
||||||
terminal: true,
|
|
||||||
// Only apply as an attribute
|
|
||||||
restrict: "A"
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
return MCTDevice;
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,99 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
["../src/AgentService"],
|
|
||||||
function (AgentService) {
|
|
||||||
|
|
||||||
var TEST_USER_AGENTS = {
|
|
||||||
DESKTOP: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.89 Safari/537.36",
|
|
||||||
IPAD: "Mozilla/5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A465 Safari/9537.53",
|
|
||||||
IPHONE: "Mozilla/5.0 (iPhone; CPU iPhone OS 7_0 like Mac OS X; en-us) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A465 Safari/9537.53"
|
|
||||||
};
|
|
||||||
|
|
||||||
describe("The AgentService", function () {
|
|
||||||
var testWindow, agentService;
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
testWindow = {
|
|
||||||
innerWidth: 640,
|
|
||||||
innerHeight: 480,
|
|
||||||
navigator: {
|
|
||||||
userAgent: TEST_USER_AGENTS.DESKTOP
|
|
||||||
}
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
it("recognizes desktop devices as non-mobile", function () {
|
|
||||||
testWindow.navigator.userAgent = TEST_USER_AGENTS.DESKTOP;
|
|
||||||
agentService = new AgentService(testWindow);
|
|
||||||
expect(agentService.isMobile()).toBeFalsy();
|
|
||||||
expect(agentService.isPhone()).toBeFalsy();
|
|
||||||
expect(agentService.isTablet()).toBeFalsy();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("detects iPhones", function () {
|
|
||||||
testWindow.navigator.userAgent = TEST_USER_AGENTS.IPHONE;
|
|
||||||
agentService = new AgentService(testWindow);
|
|
||||||
expect(agentService.isMobile()).toBeTruthy();
|
|
||||||
expect(agentService.isPhone()).toBeTruthy();
|
|
||||||
expect(agentService.isTablet()).toBeFalsy();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("detects iPads", function () {
|
|
||||||
testWindow.navigator.userAgent = TEST_USER_AGENTS.IPAD;
|
|
||||||
agentService = new AgentService(testWindow);
|
|
||||||
expect(agentService.isMobile()).toBeTruthy();
|
|
||||||
expect(agentService.isPhone()).toBeFalsy();
|
|
||||||
expect(agentService.isTablet()).toBeTruthy();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("detects display orientation", function () {
|
|
||||||
agentService = new AgentService(testWindow);
|
|
||||||
testWindow.innerWidth = 1024;
|
|
||||||
testWindow.innerHeight = 400;
|
|
||||||
expect(agentService.isPortrait()).toBeFalsy();
|
|
||||||
expect(agentService.isLandscape()).toBeTruthy();
|
|
||||||
testWindow.innerWidth = 400;
|
|
||||||
testWindow.innerHeight = 1024;
|
|
||||||
expect(agentService.isPortrait()).toBeTruthy();
|
|
||||||
expect(agentService.isLandscape()).toBeFalsy();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("detects touch support", function () {
|
|
||||||
testWindow.ontouchstart = null;
|
|
||||||
expect(new AgentService(testWindow).isTouch())
|
|
||||||
.toBe(true);
|
|
||||||
delete testWindow.ontouchstart;
|
|
||||||
expect(new AgentService(testWindow).isTouch())
|
|
||||||
.toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows for checking browser type", function () {
|
|
||||||
testWindow.navigator.userAgent = "Chromezilla Safarifox";
|
|
||||||
agentService = new AgentService(testWindow);
|
|
||||||
expect(agentService.isBrowser("Chrome")).toBe(true);
|
|
||||||
expect(agentService.isBrowser("Firefox")).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,109 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
["../src/DeviceClassifier", "../src/DeviceMatchers"],
|
|
||||||
function (DeviceClassifier, DeviceMatchers) {
|
|
||||||
|
|
||||||
var AGENT_SERVICE_METHODS = [
|
|
||||||
'isMobile',
|
|
||||||
'isPhone',
|
|
||||||
'isTablet',
|
|
||||||
'isPortrait',
|
|
||||||
'isLandscape',
|
|
||||||
'isTouch'
|
|
||||||
],
|
|
||||||
TEST_PERMUTATIONS = [
|
|
||||||
['isMobile', 'isPhone', 'isTouch', 'isPortrait'],
|
|
||||||
['isMobile', 'isPhone', 'isTouch', 'isLandscape'],
|
|
||||||
['isMobile', 'isTablet', 'isTouch', 'isPortrait'],
|
|
||||||
['isMobile', 'isTablet', 'isTouch', 'isLandscape'],
|
|
||||||
['isTouch'],
|
|
||||||
[]
|
|
||||||
];
|
|
||||||
|
|
||||||
describe("DeviceClassifier", function () {
|
|
||||||
var mockAgentService,
|
|
||||||
mockDocument,
|
|
||||||
mockBody;
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
mockAgentService = jasmine.createSpyObj(
|
|
||||||
'agentService',
|
|
||||||
AGENT_SERVICE_METHODS
|
|
||||||
);
|
|
||||||
mockDocument = jasmine.createSpyObj(
|
|
||||||
'$document',
|
|
||||||
['find']
|
|
||||||
);
|
|
||||||
mockBody = jasmine.createSpyObj(
|
|
||||||
'body',
|
|
||||||
['addClass']
|
|
||||||
);
|
|
||||||
mockDocument.find.and.callFake(function (sel) {
|
|
||||||
return sel === 'body' && mockBody;
|
|
||||||
});
|
|
||||||
AGENT_SERVICE_METHODS.forEach(function (m) {
|
|
||||||
mockAgentService[m].and.returnValue(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
TEST_PERMUTATIONS.forEach(function (trueMethods) {
|
|
||||||
var summary = trueMethods.length === 0
|
|
||||||
? "device has no detected characteristics"
|
|
||||||
: "device " + (trueMethods.join(", "));
|
|
||||||
|
|
||||||
describe("when " + summary, function () {
|
|
||||||
var classifier; // eslint-disable-line
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
trueMethods.forEach(function (m) {
|
|
||||||
mockAgentService[m].and.returnValue(true);
|
|
||||||
});
|
|
||||||
classifier = new DeviceClassifier(
|
|
||||||
mockAgentService,
|
|
||||||
mockDocument
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("adds classes for matching, detected characteristics", function () {
|
|
||||||
Object.keys(DeviceMatchers).filter(function (m) {
|
|
||||||
return DeviceMatchers[m](mockAgentService);
|
|
||||||
}).forEach(function (key) {
|
|
||||||
expect(mockBody.addClass)
|
|
||||||
.toHaveBeenCalledWith(key);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not add classes for non-matching characteristics", function () {
|
|
||||||
Object.keys(DeviceMatchers).filter(function (m) {
|
|
||||||
return !DeviceMatchers[m](mockAgentService);
|
|
||||||
}).forEach(function (key) {
|
|
||||||
expect(mockBody.addClass)
|
|
||||||
.not.toHaveBeenCalledWith(key);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,78 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
["../src/DeviceMatchers"],
|
|
||||||
function (DeviceMatchers) {
|
|
||||||
|
|
||||||
describe("DeviceMatchers", function () {
|
|
||||||
var mockAgentService;
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
mockAgentService = jasmine.createSpyObj(
|
|
||||||
'agentService',
|
|
||||||
[
|
|
||||||
'isMobile',
|
|
||||||
'isPhone',
|
|
||||||
'isTablet',
|
|
||||||
'isPortrait',
|
|
||||||
'isLandscape',
|
|
||||||
'isTouch'
|
|
||||||
]
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("detects when a device is a desktop device", function () {
|
|
||||||
mockAgentService.isMobile.and.returnValue(false);
|
|
||||||
expect(DeviceMatchers.desktop(mockAgentService))
|
|
||||||
.toBe(true);
|
|
||||||
mockAgentService.isMobile.and.returnValue(true);
|
|
||||||
expect(DeviceMatchers.desktop(mockAgentService))
|
|
||||||
.toBe(false);
|
|
||||||
});
|
|
||||||
|
|
||||||
function method(deviceType) {
|
|
||||||
return "is" + deviceType[0].toUpperCase() + deviceType.slice(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
[
|
|
||||||
"mobile",
|
|
||||||
"phone",
|
|
||||||
"tablet",
|
|
||||||
"landscape",
|
|
||||||
"portrait",
|
|
||||||
"landscape",
|
|
||||||
"touch"
|
|
||||||
].forEach(function (deviceType) {
|
|
||||||
it("detects when a device is a " + deviceType + " device", function () {
|
|
||||||
mockAgentService[method(deviceType)].and.returnValue(true);
|
|
||||||
expect(DeviceMatchers[deviceType](mockAgentService))
|
|
||||||
.toBe(true);
|
|
||||||
mockAgentService[method(deviceType)].and.returnValue(false);
|
|
||||||
expect(DeviceMatchers[deviceType](mockAgentService))
|
|
||||||
.toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,168 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
['../src/MCTDevice'],
|
|
||||||
function (MCTDevice) {
|
|
||||||
|
|
||||||
var JQLITE_METHODS = ['replaceWith'];
|
|
||||||
|
|
||||||
describe("The mct-device directive", function () {
|
|
||||||
var mockAgentService,
|
|
||||||
mockTransclude,
|
|
||||||
mockElement,
|
|
||||||
mockClone,
|
|
||||||
testAttrs,
|
|
||||||
directive;
|
|
||||||
|
|
||||||
function link() {
|
|
||||||
directive.link(null, mockElement, testAttrs, null, mockTransclude);
|
|
||||||
}
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
mockAgentService = jasmine.createSpyObj(
|
|
||||||
"agentService",
|
|
||||||
["isMobile", "isPhone", "isTablet", "isPortrait", "isLandscape"]
|
|
||||||
);
|
|
||||||
mockTransclude = jasmine.createSpy("$transclude");
|
|
||||||
mockElement = jasmine.createSpyObj(name, JQLITE_METHODS);
|
|
||||||
mockClone = jasmine.createSpyObj(name, JQLITE_METHODS);
|
|
||||||
|
|
||||||
mockTransclude.and.callFake(function (fn) {
|
|
||||||
fn(mockClone);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Look desktop-like by default
|
|
||||||
mockAgentService.isLandscape.and.returnValue(true);
|
|
||||||
|
|
||||||
testAttrs = {};
|
|
||||||
|
|
||||||
directive = new MCTDevice(mockAgentService);
|
|
||||||
});
|
|
||||||
|
|
||||||
function expectInclusion() {
|
|
||||||
expect(mockElement.replaceWith)
|
|
||||||
.toHaveBeenCalledWith(mockClone);
|
|
||||||
}
|
|
||||||
|
|
||||||
function expectExclusion() {
|
|
||||||
expect(mockElement.replaceWith).not.toHaveBeenCalled();
|
|
||||||
}
|
|
||||||
|
|
||||||
it("is applicable at the attribute level", function () {
|
|
||||||
expect(directive.restrict).toEqual("A");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("transcludes at the element level", function () {
|
|
||||||
expect(directive.transclude).toEqual('element');
|
|
||||||
});
|
|
||||||
|
|
||||||
it("has a greater priority number than ng-if", function () {
|
|
||||||
expect(directive.priority > 600).toBeTruthy();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("restricts element inclusion for mobile devices", function () {
|
|
||||||
testAttrs.mctDevice = "mobile";
|
|
||||||
link();
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isMobile.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("restricts element inclusion for tablet devices", function () {
|
|
||||||
testAttrs.mctDevice = "tablet";
|
|
||||||
mockAgentService.isMobile.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isTablet.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("restricts element inclusion for phone devices", function () {
|
|
||||||
testAttrs.mctDevice = "phone";
|
|
||||||
mockAgentService.isMobile.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isPhone.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("restricts element inclusion for desktop devices", function () {
|
|
||||||
testAttrs.mctDevice = "desktop";
|
|
||||||
mockAgentService.isMobile.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isMobile.and.returnValue(false);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("restricts element inclusion for portrait orientation", function () {
|
|
||||||
testAttrs.mctDevice = "portrait";
|
|
||||||
link();
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isPortrait.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("restricts element inclusion for landscape orientation", function () {
|
|
||||||
testAttrs.mctDevice = "landscape";
|
|
||||||
mockAgentService.isLandscape.and.returnValue(false);
|
|
||||||
mockAgentService.isPortrait.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isLandscape.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows multiple device characteristics to be requested", function () {
|
|
||||||
// Won't try to test every permutation here, just
|
|
||||||
// make sure the multi-characteristic feature has support.
|
|
||||||
testAttrs.mctDevice = "portrait mobile";
|
|
||||||
link();
|
|
||||||
// Neither portrait nor mobile, not called
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isPortrait.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
|
|
||||||
// Was portrait, but not mobile, so no
|
|
||||||
expectExclusion();
|
|
||||||
|
|
||||||
mockAgentService.isMobile.and.returnValue(true);
|
|
||||||
link();
|
|
||||||
expectInclusion();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
@ -379,7 +379,7 @@ define([
|
|||||||
{
|
{
|
||||||
"name": "Math.uuid.js",
|
"name": "Math.uuid.js",
|
||||||
"version": "1.4.7",
|
"version": "1.4.7",
|
||||||
"description": "Unique identifer generation (code adapted.)",
|
"description": "Unique identifier generation (code adapted.)",
|
||||||
"author": "Robert Kieffer",
|
"author": "Robert Kieffer",
|
||||||
"website": "https://github.com/broofa/node-uuid",
|
"website": "https://github.com/broofa/node-uuid",
|
||||||
"copyright": "Copyright (c) 2010-2012 Robert Kieffer",
|
"copyright": "Copyright (c) 2010-2012 Robert Kieffer",
|
||||||
|
@ -21,32 +21,24 @@
|
|||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
|
|
||||||
define([
|
define([
|
||||||
"moment-timezone",
|
|
||||||
"./src/indicators/ClockIndicator",
|
|
||||||
"./src/services/TickerService",
|
"./src/services/TickerService",
|
||||||
"./src/services/TimerService",
|
"./src/services/TimerService",
|
||||||
"./src/controllers/ClockController",
|
|
||||||
"./src/controllers/TimerController",
|
"./src/controllers/TimerController",
|
||||||
"./src/controllers/RefreshingController",
|
"./src/controllers/RefreshingController",
|
||||||
"./src/actions/StartTimerAction",
|
"./src/actions/StartTimerAction",
|
||||||
"./src/actions/RestartTimerAction",
|
"./src/actions/RestartTimerAction",
|
||||||
"./src/actions/StopTimerAction",
|
"./src/actions/StopTimerAction",
|
||||||
"./src/actions/PauseTimerAction",
|
"./src/actions/PauseTimerAction",
|
||||||
"./res/templates/clock.html",
|
|
||||||
"./res/templates/timer.html"
|
"./res/templates/timer.html"
|
||||||
], function (
|
], function (
|
||||||
MomentTimezone,
|
|
||||||
ClockIndicator,
|
|
||||||
TickerService,
|
TickerService,
|
||||||
TimerService,
|
TimerService,
|
||||||
ClockController,
|
|
||||||
TimerController,
|
TimerController,
|
||||||
RefreshingController,
|
RefreshingController,
|
||||||
StartTimerAction,
|
StartTimerAction,
|
||||||
RestartTimerAction,
|
RestartTimerAction,
|
||||||
StopTimerAction,
|
StopTimerAction,
|
||||||
PauseTimerAction,
|
PauseTimerAction,
|
||||||
clockTemplate,
|
|
||||||
timerTemplate
|
timerTemplate
|
||||||
) {
|
) {
|
||||||
return {
|
return {
|
||||||
@ -73,23 +65,14 @@ define([
|
|||||||
"value": "YYYY/MM/DD HH:mm:ss"
|
"value": "YYYY/MM/DD HH:mm:ss"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"indicators": [
|
|
||||||
{
|
|
||||||
"implementation": ClockIndicator,
|
|
||||||
"depends": [
|
|
||||||
"tickerService",
|
|
||||||
"CLOCK_INDICATOR_FORMAT"
|
|
||||||
],
|
|
||||||
"priority": "preferred"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"key": "tickerService",
|
"key": "tickerService",
|
||||||
"implementation": TickerService,
|
"implementation": TickerService,
|
||||||
"depends": [
|
"depends": [
|
||||||
"$timeout",
|
"$timeout",
|
||||||
"now"
|
"now",
|
||||||
|
"$rootScope"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@ -99,14 +82,6 @@ define([
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"controllers": [
|
"controllers": [
|
||||||
{
|
|
||||||
"key": "ClockController",
|
|
||||||
"implementation": ClockController,
|
|
||||||
"depends": [
|
|
||||||
"$scope",
|
|
||||||
"tickerService"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"key": "TimerController",
|
"key": "TimerController",
|
||||||
"implementation": TimerController,
|
"implementation": TimerController,
|
||||||
@ -126,12 +101,6 @@ define([
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"views": [
|
"views": [
|
||||||
{
|
|
||||||
"key": "clock",
|
|
||||||
"type": "clock",
|
|
||||||
"editable": false,
|
|
||||||
"template": clockTemplate
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"key": "timer",
|
"key": "timer",
|
||||||
"type": "timer",
|
"type": "timer",
|
||||||
@ -186,70 +155,6 @@ define([
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"types": [
|
"types": [
|
||||||
{
|
|
||||||
"key": "clock",
|
|
||||||
"name": "Clock",
|
|
||||||
"cssClass": "icon-clock",
|
|
||||||
"description": "A UTC-based clock that supports a variety of display formats. Clocks can be added to Display Layouts.",
|
|
||||||
"priority": 101,
|
|
||||||
"features": [
|
|
||||||
"creation"
|
|
||||||
],
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"key": "clockFormat",
|
|
||||||
"name": "Display Format",
|
|
||||||
"control": "composite",
|
|
||||||
"items": [
|
|
||||||
{
|
|
||||||
"control": "select",
|
|
||||||
"options": [
|
|
||||||
{
|
|
||||||
"value": "YYYY/MM/DD hh:mm:ss",
|
|
||||||
"name": "YYYY/MM/DD hh:mm:ss"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"value": "YYYY/DDD hh:mm:ss",
|
|
||||||
"name": "YYYY/DDD hh:mm:ss"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"value": "hh:mm:ss",
|
|
||||||
"name": "hh:mm:ss"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"cssClass": "l-inline"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"control": "select",
|
|
||||||
"options": [
|
|
||||||
{
|
|
||||||
"value": "clock12",
|
|
||||||
"name": "12hr"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"value": "clock24",
|
|
||||||
"name": "24hr"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"cssClass": "l-inline"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"key": "timezone",
|
|
||||||
"name": "Timezone",
|
|
||||||
"control": "autocomplete",
|
|
||||||
"options": MomentTimezone.tz.names()
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"model": {
|
|
||||||
"clockFormat": [
|
|
||||||
"YYYY/MM/DD hh:mm:ss",
|
|
||||||
"clock12"
|
|
||||||
],
|
|
||||||
"timezone": "UTC"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"key": "timer",
|
"key": "timer",
|
||||||
"name": "Timer",
|
"name": "Timer",
|
||||||
|
@ -1,32 +0,0 @@
|
|||||||
<!--
|
|
||||||
Open MCT, Copyright (c) 2009-2016, United States Government
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
<div class="c-clock l-time-display u-style-receiver js-style-receiver" ng-controller="ClockController as clock">
|
|
||||||
<div class="c-clock__timezone">
|
|
||||||
{{clock.zone()}}
|
|
||||||
</div>
|
|
||||||
<div class="c-clock__value">
|
|
||||||
{{clock.text()}}
|
|
||||||
</div>
|
|
||||||
<div class="c-clock__ampm">
|
|
||||||
{{clock.ampm()}}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
@ -1,110 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2009-2016, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define([
|
|
||||||
'moment',
|
|
||||||
'moment-timezone'
|
|
||||||
],
|
|
||||||
function (
|
|
||||||
moment,
|
|
||||||
momentTimezone
|
|
||||||
) {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Controller for views of a Clock domain object.
|
|
||||||
*
|
|
||||||
* @constructor
|
|
||||||
* @memberof platform/features/clock
|
|
||||||
* @param {angular.Scope} $scope the Angular scope
|
|
||||||
* @param {platform/features/clock.TickerService} tickerService
|
|
||||||
* a service used to align behavior with clock ticks
|
|
||||||
*/
|
|
||||||
function ClockController($scope, tickerService) {
|
|
||||||
var lastTimestamp,
|
|
||||||
unlisten,
|
|
||||||
timeFormat,
|
|
||||||
zoneName,
|
|
||||||
self = this;
|
|
||||||
|
|
||||||
function update() {
|
|
||||||
var m = zoneName
|
|
||||||
? moment.utc(lastTimestamp).tz(zoneName) : moment.utc(lastTimestamp);
|
|
||||||
self.zoneAbbr = m.zoneAbbr();
|
|
||||||
self.textValue = timeFormat && m.format(timeFormat);
|
|
||||||
self.ampmValue = m.format("A"); // Just the AM or PM part
|
|
||||||
}
|
|
||||||
|
|
||||||
function tick(timestamp) {
|
|
||||||
lastTimestamp = timestamp;
|
|
||||||
update();
|
|
||||||
}
|
|
||||||
|
|
||||||
function updateModel(model) {
|
|
||||||
var baseFormat;
|
|
||||||
if (model !== undefined) {
|
|
||||||
baseFormat = model.clockFormat[0];
|
|
||||||
|
|
||||||
self.use24 = model.clockFormat[1] === 'clock24';
|
|
||||||
timeFormat = self.use24
|
|
||||||
? baseFormat.replace('hh', "HH") : baseFormat;
|
|
||||||
// If wrong timezone is provided, the UTC will be used
|
|
||||||
zoneName = momentTimezone.tz.names().includes(model.timezone)
|
|
||||||
? model.timezone : "UTC";
|
|
||||||
update();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pull in the model (clockFormat and timezone) from the domain object model
|
|
||||||
$scope.$watch('model', updateModel);
|
|
||||||
|
|
||||||
// Listen for clock ticks ... and stop listening on destroy
|
|
||||||
unlisten = tickerService.listen(tick);
|
|
||||||
$scope.$on('$destroy', unlisten);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the clock's time zone, as displayable text.
|
|
||||||
* @returns {string}
|
|
||||||
*/
|
|
||||||
ClockController.prototype.zone = function () {
|
|
||||||
return this.zoneAbbr;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the current time, as displayable text.
|
|
||||||
* @returns {string}
|
|
||||||
*/
|
|
||||||
ClockController.prototype.text = function () {
|
|
||||||
return this.textValue;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the text to display to qualify a time as AM or PM.
|
|
||||||
* @returns {string}
|
|
||||||
*/
|
|
||||||
ClockController.prototype.ampm = function () {
|
|
||||||
return this.use24 ? '' : this.ampmValue;
|
|
||||||
};
|
|
||||||
|
|
||||||
return ClockController;
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,65 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2009-2016, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
['moment'],
|
|
||||||
function (moment) {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Indicator that displays the current UTC time in the status area.
|
|
||||||
* @implements {Indicator}
|
|
||||||
* @memberof platform/features/clock
|
|
||||||
* @param {platform/features/clock.TickerService} tickerService
|
|
||||||
* a service used to align behavior with clock ticks
|
|
||||||
* @param {string} indicatorFormat format string for timestamps
|
|
||||||
* shown in this indicator
|
|
||||||
*/
|
|
||||||
function ClockIndicator(tickerService, indicatorFormat) {
|
|
||||||
var self = this;
|
|
||||||
|
|
||||||
this.text = "";
|
|
||||||
|
|
||||||
tickerService.listen(function (timestamp) {
|
|
||||||
self.text = moment.utc(timestamp)
|
|
||||||
.format(indicatorFormat) + " UTC";
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
ClockIndicator.prototype.getGlyphClass = function () {
|
|
||||||
return "";
|
|
||||||
};
|
|
||||||
|
|
||||||
ClockIndicator.prototype.getCssClass = function () {
|
|
||||||
return "t-indicator-clock icon-clock no-minify c-indicator--not-clickable";
|
|
||||||
};
|
|
||||||
|
|
||||||
ClockIndicator.prototype.getText = function () {
|
|
||||||
return this.text;
|
|
||||||
};
|
|
||||||
|
|
||||||
ClockIndicator.prototype.getDescription = function () {
|
|
||||||
return "";
|
|
||||||
};
|
|
||||||
|
|
||||||
return ClockIndicator;
|
|
||||||
}
|
|
||||||
);
|
|
@ -32,8 +32,13 @@ define(
|
|||||||
* @param $timeout Angular's $timeout
|
* @param $timeout Angular's $timeout
|
||||||
* @param {Function} now function to provide the current time in ms
|
* @param {Function} now function to provide the current time in ms
|
||||||
*/
|
*/
|
||||||
function TickerService($timeout, now) {
|
function TickerService($timeout, now, $rootScope) {
|
||||||
var self = this;
|
var self = this;
|
||||||
|
var timeoutId;
|
||||||
|
|
||||||
|
$rootScope.$on('$destroy', function () {
|
||||||
|
$timeout.cancel(timeoutId);
|
||||||
|
});
|
||||||
|
|
||||||
function tick() {
|
function tick() {
|
||||||
var timestamp = now(),
|
var timestamp = now(),
|
||||||
@ -48,7 +53,7 @@ define(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Try to update at exactly the next second
|
// Try to update at exactly the next second
|
||||||
$timeout(tick, 1000 - millis, true);
|
timeoutId = $timeout(tick, 1000 - millis, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
tick();
|
tick();
|
||||||
|
@ -1,107 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2009-2017, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
["../../src/controllers/ClockController"],
|
|
||||||
function (ClockController) {
|
|
||||||
|
|
||||||
// Wed, 03 Jun 2015 17:56:14 GMT
|
|
||||||
var TEST_TIMESTAMP = 1433354174000;
|
|
||||||
|
|
||||||
describe("A clock view's controller", function () {
|
|
||||||
var mockScope,
|
|
||||||
mockTicker,
|
|
||||||
mockUnticker,
|
|
||||||
controller;
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
mockScope = jasmine.createSpyObj('$scope', ['$watch', '$on']);
|
|
||||||
mockTicker = jasmine.createSpyObj('ticker', ['listen']);
|
|
||||||
mockUnticker = jasmine.createSpy('unticker');
|
|
||||||
|
|
||||||
mockTicker.listen.and.returnValue(mockUnticker);
|
|
||||||
|
|
||||||
controller = new ClockController(mockScope, mockTicker);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("watches for model (clockFormat and timezone) from the domain object model", function () {
|
|
||||||
expect(mockScope.$watch).toHaveBeenCalledWith(
|
|
||||||
"model",
|
|
||||||
jasmine.any(Function)
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("subscribes to clock ticks", function () {
|
|
||||||
expect(mockTicker.listen)
|
|
||||||
.toHaveBeenCalledWith(jasmine.any(Function));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("unsubscribes to ticks when destroyed", function () {
|
|
||||||
// Make sure $destroy is being listened for...
|
|
||||||
expect(mockScope.$on.calls.mostRecent().args[0]).toEqual('$destroy');
|
|
||||||
expect(mockUnticker).not.toHaveBeenCalled();
|
|
||||||
|
|
||||||
// ...and makes sure that its listener unsubscribes from ticker
|
|
||||||
mockScope.$on.calls.mostRecent().args[1]();
|
|
||||||
expect(mockUnticker).toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("formats using the format string from the model", function () {
|
|
||||||
mockTicker.listen.calls.mostRecent().args[0](TEST_TIMESTAMP);
|
|
||||||
mockScope.$watch.calls.mostRecent().args[1]({
|
|
||||||
"clockFormat": [
|
|
||||||
"YYYY-DDD hh:mm:ss",
|
|
||||||
"clock24"
|
|
||||||
],
|
|
||||||
"timezone": "Canada/Eastern"
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(controller.zone()).toEqual("EDT");
|
|
||||||
expect(controller.text()).toEqual("2015-154 13:56:14");
|
|
||||||
expect(controller.ampm()).toEqual("");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("formats 12-hour time", function () {
|
|
||||||
mockTicker.listen.calls.mostRecent().args[0](TEST_TIMESTAMP);
|
|
||||||
mockScope.$watch.calls.mostRecent().args[1]({
|
|
||||||
"clockFormat": [
|
|
||||||
"YYYY-DDD hh:mm:ss",
|
|
||||||
"clock12"
|
|
||||||
],
|
|
||||||
"timezone": ""
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(controller.zone()).toEqual("UTC");
|
|
||||||
expect(controller.text()).toEqual("2015-154 05:56:14");
|
|
||||||
expect(controller.ampm()).toEqual("PM");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("does not throw exceptions when model is undefined", function () {
|
|
||||||
mockTicker.listen.calls.mostRecent().args[0](TEST_TIMESTAMP);
|
|
||||||
expect(function () {
|
|
||||||
mockScope.$watch.calls.mostRecent().args[1](undefined);
|
|
||||||
}).not.toThrow();
|
|
||||||
});
|
|
||||||
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
@ -1,58 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2009-2016, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
define(
|
|
||||||
["../../src/indicators/ClockIndicator"],
|
|
||||||
function (ClockIndicator) {
|
|
||||||
|
|
||||||
// Wed, 03 Jun 2015 17:56:14 GMT
|
|
||||||
var TEST_TIMESTAMP = 1433354174000,
|
|
||||||
TEST_FORMAT = "YYYY-DDD HH:mm:ss";
|
|
||||||
|
|
||||||
describe("The clock indicator", function () {
|
|
||||||
var mockTicker,
|
|
||||||
mockUnticker,
|
|
||||||
indicator;
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
mockTicker = jasmine.createSpyObj('ticker', ['listen']);
|
|
||||||
mockUnticker = jasmine.createSpy('unticker');
|
|
||||||
|
|
||||||
mockTicker.listen.and.returnValue(mockUnticker);
|
|
||||||
|
|
||||||
indicator = new ClockIndicator(mockTicker, TEST_FORMAT);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("displays the current time", function () {
|
|
||||||
mockTicker.listen.calls.mostRecent().args[0](TEST_TIMESTAMP);
|
|
||||||
expect(indicator.getText()).toEqual("2015-154 17:56:14 UTC");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("implements the Indicator interface", function () {
|
|
||||||
expect(indicator.getCssClass()).toEqual(jasmine.any(String));
|
|
||||||
expect(indicator.getText()).toEqual(jasmine.any(String));
|
|
||||||
expect(indicator.getDescription()).toEqual(jasmine.any(String));
|
|
||||||
});
|
|
||||||
|
|
||||||
});
|
|
||||||
}
|
|
||||||
);
|
|
@ -30,16 +30,18 @@ define(
|
|||||||
var mockTimeout,
|
var mockTimeout,
|
||||||
mockNow,
|
mockNow,
|
||||||
mockCallback,
|
mockCallback,
|
||||||
tickerService;
|
tickerService,
|
||||||
|
mockRootScope;
|
||||||
|
|
||||||
beforeEach(function () {
|
beforeEach(function () {
|
||||||
mockTimeout = jasmine.createSpy('$timeout');
|
mockTimeout = jasmine.createSpy('$timeout');
|
||||||
mockNow = jasmine.createSpy('now');
|
mockNow = jasmine.createSpy('now');
|
||||||
mockCallback = jasmine.createSpy('callback');
|
mockCallback = jasmine.createSpy('callback');
|
||||||
|
mockRootScope = jasmine.createSpyObj('rootScope', ['$on']);
|
||||||
|
|
||||||
mockNow.and.returnValue(TEST_TIMESTAMP);
|
mockNow.and.returnValue(TEST_TIMESTAMP);
|
||||||
|
|
||||||
tickerService = new TickerService(mockTimeout, mockNow);
|
tickerService = new TickerService(mockTimeout, mockNow, mockRootScope);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("notifies listeners of clock ticks", function () {
|
it("notifies listeners of clock ticks", function () {
|
||||||
|
@ -58,7 +58,7 @@ define([
|
|||||||
) {
|
) {
|
||||||
var $http = this.$http,
|
var $http = this.$http,
|
||||||
$log = this.$log,
|
$log = this.$log,
|
||||||
app = angular.module(Constants.MODULE_NAME, ["ngRoute"]),
|
app = angular.module(Constants.MODULE_NAME, []),
|
||||||
loader = new BundleLoader($http, $log, openmct.legacyRegistry),
|
loader = new BundleLoader($http, $log, openmct.legacyRegistry),
|
||||||
resolver = new BundleResolver(
|
resolver = new BundleResolver(
|
||||||
new ExtensionResolver(
|
new ExtensionResolver(
|
||||||
|
@ -28,8 +28,7 @@
|
|||||||
define(
|
define(
|
||||||
[
|
[
|
||||||
'./FrameworkLayer',
|
'./FrameworkLayer',
|
||||||
'angular',
|
'angular'
|
||||||
'angular-route'
|
|
||||||
],
|
],
|
||||||
function (
|
function (
|
||||||
FrameworkLayer,
|
FrameworkLayer,
|
||||||
|
@ -138,34 +138,6 @@ define(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Custom registration function for extensions of category "route"
|
|
||||||
function registerRoute(extension) {
|
|
||||||
var app = this.app,
|
|
||||||
$log = this.$log,
|
|
||||||
route = Object.create(extension);
|
|
||||||
|
|
||||||
// Adjust path for bundle
|
|
||||||
if (route.templateUrl) {
|
|
||||||
route.templateUrl = [
|
|
||||||
route.bundle.path,
|
|
||||||
route.bundle.resources,
|
|
||||||
route.templateUrl
|
|
||||||
].join(Constants.SEPARATOR);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Log the registration
|
|
||||||
$log.info("Registering route: " + (route.key || route.when));
|
|
||||||
|
|
||||||
// Register the route with Angular
|
|
||||||
app.config(['$routeProvider', function ($routeProvider) {
|
|
||||||
if (route.when) {
|
|
||||||
$routeProvider.when(route.when, route);
|
|
||||||
} else {
|
|
||||||
$routeProvider.otherwise(route);
|
|
||||||
}
|
|
||||||
}]);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle service compositing
|
// Handle service compositing
|
||||||
function registerComponents(components) {
|
function registerComponents(components) {
|
||||||
var app = this.app,
|
var app = this.app,
|
||||||
@ -194,13 +166,6 @@ define(
|
|||||||
CustomRegistrars.prototype.constants =
|
CustomRegistrars.prototype.constants =
|
||||||
mapUpon(registerConstant);
|
mapUpon(registerConstant);
|
||||||
|
|
||||||
/**
|
|
||||||
* Register Angular routes.
|
|
||||||
* @param {Array} extensions the resolved extensions
|
|
||||||
*/
|
|
||||||
CustomRegistrars.prototype.routes =
|
|
||||||
mapUpon(registerRoute);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register Angular directives.
|
* Register Angular directives.
|
||||||
* @param {Array} extensions the resolved extensions
|
* @param {Array} extensions the resolved extensions
|
||||||
|
@ -57,7 +57,6 @@ define(
|
|||||||
expect(customRegistrars.directives).toBeTruthy();
|
expect(customRegistrars.directives).toBeTruthy();
|
||||||
expect(customRegistrars.controllers).toBeTruthy();
|
expect(customRegistrars.controllers).toBeTruthy();
|
||||||
expect(customRegistrars.services).toBeTruthy();
|
expect(customRegistrars.services).toBeTruthy();
|
||||||
expect(customRegistrars.routes).toBeTruthy();
|
|
||||||
expect(customRegistrars.constants).toBeTruthy();
|
expect(customRegistrars.constants).toBeTruthy();
|
||||||
expect(customRegistrars.runs).toBeTruthy();
|
expect(customRegistrars.runs).toBeTruthy();
|
||||||
});
|
});
|
||||||
@ -139,47 +138,6 @@ define(
|
|||||||
expect(mockLog.warn.calls.count()).toEqual(0);
|
expect(mockLog.warn.calls.count()).toEqual(0);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("allows routes to be registered", function () {
|
|
||||||
var mockRouteProvider = jasmine.createSpyObj(
|
|
||||||
"$routeProvider",
|
|
||||||
["when", "otherwise"]
|
|
||||||
),
|
|
||||||
bundle = {
|
|
||||||
path: "test/bundle",
|
|
||||||
resources: "res"
|
|
||||||
},
|
|
||||||
routes = [
|
|
||||||
{
|
|
||||||
when: "foo",
|
|
||||||
templateUrl: "templates/test.html",
|
|
||||||
bundle: bundle
|
|
||||||
},
|
|
||||||
{
|
|
||||||
templateUrl: "templates/default.html",
|
|
||||||
bundle: bundle
|
|
||||||
}
|
|
||||||
];
|
|
||||||
|
|
||||||
customRegistrars.routes(routes);
|
|
||||||
|
|
||||||
// Give it the route provider based on its config call
|
|
||||||
mockApp.config.calls.all().forEach(function (call) {
|
|
||||||
// Invoke the provided callback
|
|
||||||
call.args[0][1](mockRouteProvider);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The "when" clause should have been mapped to the when method...
|
|
||||||
expect(mockRouteProvider.when).toHaveBeenCalled();
|
|
||||||
expect(mockRouteProvider.when.calls.mostRecent().args[0]).toEqual("foo");
|
|
||||||
expect(mockRouteProvider.when.calls.mostRecent().args[1].templateUrl)
|
|
||||||
.toEqual("test/bundle/res/templates/test.html");
|
|
||||||
|
|
||||||
// ...while the other should have been treated as a default route
|
|
||||||
expect(mockRouteProvider.otherwise).toHaveBeenCalled();
|
|
||||||
expect(mockRouteProvider.otherwise.calls.mostRecent().args[0].templateUrl)
|
|
||||||
.toEqual("test/bundle/res/templates/default.html");
|
|
||||||
});
|
|
||||||
|
|
||||||
it("accepts components for service compositing", function () {
|
it("accepts components for service compositing", function () {
|
||||||
// Most relevant code will be exercised in service compositor spec
|
// Most relevant code will be exercised in service compositor spec
|
||||||
expect(customRegistrars.components).toBeTruthy();
|
expect(customRegistrars.components).toBeTruthy();
|
||||||
|
@ -30,8 +30,8 @@ define([
|
|||||||
|
|
||||||
return function ImportExportPlugin() {
|
return function ImportExportPlugin() {
|
||||||
return function (openmct) {
|
return function (openmct) {
|
||||||
ExportAsJSONAction.appliesTo = function (context) {
|
ExportAsJSONAction.prototype.appliesTo = function (context) {
|
||||||
return openmct.$injector.get('policyService')
|
return this.openmct.$injector.get('policyService')
|
||||||
.allow("creation", context.domainObject.getCapability("type")
|
.allow("creation", context.domainObject.getCapability("type")
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
@ -29,7 +29,7 @@ define(
|
|||||||
],
|
],
|
||||||
function (ExportAsJSONAction, domainObjectFactory, MCT, AdapterCapability) {
|
function (ExportAsJSONAction, domainObjectFactory, MCT, AdapterCapability) {
|
||||||
|
|
||||||
xdescribe("The export JSON action", function () {
|
describe("The export JSON action", function () {
|
||||||
|
|
||||||
var context,
|
var context,
|
||||||
action,
|
action,
|
||||||
@ -102,7 +102,7 @@ define(
|
|||||||
expect(action).toBeDefined();
|
expect(action).toBeDefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("doesn't export non-creatable objects in tree", function () {
|
xit("doesn't export non-creatable objects in tree", function () {
|
||||||
var nonCreatableType = {
|
var nonCreatableType = {
|
||||||
hasFeature:
|
hasFeature:
|
||||||
function (feature) {
|
function (feature) {
|
||||||
@ -149,7 +149,7 @@ define(
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it("can export self-containing objects", function () {
|
xit("can export self-containing objects", function () {
|
||||||
var parent = domainObjectFactory({
|
var parent = domainObjectFactory({
|
||||||
name: 'parent',
|
name: 'parent',
|
||||||
model: {
|
model: {
|
||||||
@ -191,7 +191,7 @@ define(
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it("exports links to external objects as new objects", function () {
|
xit("exports links to external objects as new objects", function () {
|
||||||
var parent = domainObjectFactory({
|
var parent = domainObjectFactory({
|
||||||
name: 'parent',
|
name: 'parent',
|
||||||
model: {
|
model: {
|
||||||
|
@ -27,7 +27,7 @@ define(
|
|||||||
],
|
],
|
||||||
function (ImportAsJSONAction, domainObjectFactory) {
|
function (ImportAsJSONAction, domainObjectFactory) {
|
||||||
|
|
||||||
xdescribe("The import JSON action", function () {
|
describe("The import JSON action", function () {
|
||||||
|
|
||||||
var context = {};
|
var context = {};
|
||||||
var action,
|
var action,
|
||||||
@ -146,7 +146,7 @@ define(
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it("can import self-containing objects", function () {
|
xit("can import self-containing objects", function () {
|
||||||
var compDomainObject = domainObjectFactory({
|
var compDomainObject = domainObjectFactory({
|
||||||
name: 'compObject',
|
name: 'compObject',
|
||||||
model: { name: 'compObject'},
|
model: { name: 'compObject'},
|
||||||
@ -198,7 +198,7 @@ define(
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
it("assigns new ids to each imported object", function () {
|
xit("assigns new ids to each imported object", function () {
|
||||||
dialogService.getUserInput.and.returnValue(Promise.resolve(
|
dialogService.getUserInput.and.returnValue(Promise.resolve(
|
||||||
{
|
{
|
||||||
selectFile: {
|
selectFile: {
|
||||||
|
@ -47,7 +47,7 @@ define(
|
|||||||
* @param $interval Angular's $interval service
|
* @param $interval Angular's $interval service
|
||||||
* @param {string} space the name of the persistence space being served
|
* @param {string} space the name of the persistence space being served
|
||||||
* @param {string} root the root of the path to ElasticSearch
|
* @param {string} root the root of the path to ElasticSearch
|
||||||
* @param {stirng} path the path to domain objects within ElasticSearch
|
* @param {string} path the path to domain objects within ElasticSearch
|
||||||
*/
|
*/
|
||||||
function ElasticPersistenceProvider($http, $q, space, root, path) {
|
function ElasticPersistenceProvider($http, $q, space, root, path) {
|
||||||
this.spaces = [space];
|
this.spaces = [space];
|
||||||
|
@ -110,8 +110,15 @@ define([
|
|||||||
worker = workerService.run('bareBonesSearchWorker');
|
worker = workerService.run('bareBonesSearchWorker');
|
||||||
}
|
}
|
||||||
|
|
||||||
worker.addEventListener('message', function (messageEvent) {
|
function handleWorkerMessage(messageEvent) {
|
||||||
provider.onWorkerMessage(messageEvent);
|
provider.onWorkerMessage(messageEvent);
|
||||||
|
}
|
||||||
|
|
||||||
|
worker.addEventListener('message', handleWorkerMessage);
|
||||||
|
|
||||||
|
this.openmct.once('destroy', () => {
|
||||||
|
worker.removeEventListener('message', handleWorkerMessage);
|
||||||
|
worker.terminate();
|
||||||
});
|
});
|
||||||
|
|
||||||
return worker;
|
return worker;
|
||||||
|
45
src/MCT.js
45
src/MCT.js
@ -31,7 +31,6 @@ define([
|
|||||||
'objectUtils',
|
'objectUtils',
|
||||||
'./plugins/plugins',
|
'./plugins/plugins',
|
||||||
'./adapter/indicators/legacy-indicators-plugin',
|
'./adapter/indicators/legacy-indicators-plugin',
|
||||||
'./plugins/buildInfo/plugin',
|
|
||||||
'./ui/registries/ViewRegistry',
|
'./ui/registries/ViewRegistry',
|
||||||
'./plugins/imagery/plugin',
|
'./plugins/imagery/plugin',
|
||||||
'./ui/registries/InspectorViewRegistry',
|
'./ui/registries/InspectorViewRegistry',
|
||||||
@ -40,6 +39,7 @@ define([
|
|||||||
'./ui/router/Browse',
|
'./ui/router/Browse',
|
||||||
'../platform/framework/src/Main',
|
'../platform/framework/src/Main',
|
||||||
'./ui/layout/Layout.vue',
|
'./ui/layout/Layout.vue',
|
||||||
|
'./ui/inspector/styles/StylesManager',
|
||||||
'../platform/core/src/objects/DomainObjectImpl',
|
'../platform/core/src/objects/DomainObjectImpl',
|
||||||
'../platform/core/src/capabilities/ContextualDomainObject',
|
'../platform/core/src/capabilities/ContextualDomainObject',
|
||||||
'./ui/preview/plugin',
|
'./ui/preview/plugin',
|
||||||
@ -60,7 +60,6 @@ define([
|
|||||||
objectUtils,
|
objectUtils,
|
||||||
plugins,
|
plugins,
|
||||||
LegacyIndicatorsPlugin,
|
LegacyIndicatorsPlugin,
|
||||||
buildInfoPlugin,
|
|
||||||
ViewRegistry,
|
ViewRegistry,
|
||||||
ImageryPlugin,
|
ImageryPlugin,
|
||||||
InspectorViewRegistry,
|
InspectorViewRegistry,
|
||||||
@ -69,6 +68,7 @@ define([
|
|||||||
Browse,
|
Browse,
|
||||||
Main,
|
Main,
|
||||||
Layout,
|
Layout,
|
||||||
|
stylesManager,
|
||||||
DomainObjectImpl,
|
DomainObjectImpl,
|
||||||
ContextualDomainObject,
|
ContextualDomainObject,
|
||||||
PreviewPlugin,
|
PreviewPlugin,
|
||||||
@ -123,6 +123,7 @@ define([
|
|||||||
};
|
};
|
||||||
|
|
||||||
this.destroy = this.destroy.bind(this);
|
this.destroy = this.destroy.bind(this);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tracks current selection state of the application.
|
* Tracks current selection state of the application.
|
||||||
* @private
|
* @private
|
||||||
@ -136,7 +137,7 @@ define([
|
|||||||
* @memberof module:openmct.MCT#
|
* @memberof module:openmct.MCT#
|
||||||
* @name conductor
|
* @name conductor
|
||||||
*/
|
*/
|
||||||
this.time = new api.TimeAPI();
|
this.time = new api.TimeAPI(this);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An interface for interacting with the composition of domain objects.
|
* An interface for interacting with the composition of domain objects.
|
||||||
@ -287,6 +288,7 @@ define([
|
|||||||
this.install(this.plugins.ViewLargeAction());
|
this.install(this.plugins.ViewLargeAction());
|
||||||
this.install(this.plugins.ObjectInterceptors());
|
this.install(this.plugins.ObjectInterceptors());
|
||||||
this.install(this.plugins.NonEditableFolder());
|
this.install(this.plugins.NonEditableFolder());
|
||||||
|
this.install(this.plugins.DeviceClassifier());
|
||||||
}
|
}
|
||||||
|
|
||||||
MCT.prototype = Object.create(EventEmitter.prototype);
|
MCT.prototype = Object.create(EventEmitter.prototype);
|
||||||
@ -375,6 +377,7 @@ define([
|
|||||||
* MCT; if undefined, MCT will be run in the body of the document
|
* MCT; if undefined, MCT will be run in the body of the document
|
||||||
*/
|
*/
|
||||||
MCT.prototype.start = function (domElement = document.body, isHeadlessMode = false) {
|
MCT.prototype.start = function (domElement = document.body, isHeadlessMode = false) {
|
||||||
|
|
||||||
if (this.types.get('layout') === undefined) {
|
if (this.types.get('layout') === undefined) {
|
||||||
this.install(this.plugins.DisplayLayout({
|
this.install(this.plugins.DisplayLayout({
|
||||||
showAsView: ['summary-widget']
|
showAsView: ['summary-widget']
|
||||||
@ -433,6 +436,9 @@ define([
|
|||||||
domElement.appendChild(appLayout.$mount().$el);
|
domElement.appendChild(appLayout.$mount().$el);
|
||||||
|
|
||||||
this.layout = appLayout.$refs.layout;
|
this.layout = appLayout.$refs.layout;
|
||||||
|
this.once('destroy', () => {
|
||||||
|
appLayout.$destroy();
|
||||||
|
});
|
||||||
Browse(this);
|
Browse(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -461,9 +467,40 @@ define([
|
|||||||
};
|
};
|
||||||
|
|
||||||
MCT.prototype.destroy = function () {
|
MCT.prototype.destroy = function () {
|
||||||
|
if (this._destroyed === true) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
window.removeEventListener('beforeunload', this.destroy);
|
window.removeEventListener('beforeunload', this.destroy);
|
||||||
|
|
||||||
this.emit('destroy');
|
this.emit('destroy');
|
||||||
this.router.destroy();
|
this.removeAllListeners();
|
||||||
|
|
||||||
|
if (this.$injector) {
|
||||||
|
this.$injector.get('$rootScope').$destroy();
|
||||||
|
this.$injector = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.$angular) {
|
||||||
|
this.$angular.element(this.element).off().removeData();
|
||||||
|
this.$angular.element(this.element).empty();
|
||||||
|
this.$angular = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.overlays.destroy();
|
||||||
|
|
||||||
|
if (this.element) {
|
||||||
|
this.element.remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
stylesManager.default.removeAllListeners();
|
||||||
|
|
||||||
|
window.angular = null;
|
||||||
|
window.openmct = null;
|
||||||
|
|
||||||
|
Object.keys(require.cache).forEach(key => delete require.cache[key]);
|
||||||
|
|
||||||
|
this._destroyed = true;
|
||||||
};
|
};
|
||||||
|
|
||||||
MCT.prototype.plugins = plugins;
|
MCT.prototype.plugins = plugins;
|
||||||
|
@ -32,6 +32,10 @@ define([
|
|||||||
// cannot be injected.
|
// cannot be injected.
|
||||||
function AlternateCompositionInitializer(openmct) {
|
function AlternateCompositionInitializer(openmct) {
|
||||||
AlternateCompositionCapability.appliesTo = function (model, id) {
|
AlternateCompositionCapability.appliesTo = function (model, id) {
|
||||||
|
openmct.once('destroy', () => {
|
||||||
|
delete AlternateCompositionCapability.appliesTo;
|
||||||
|
});
|
||||||
|
|
||||||
model = objectUtils.toNewFormat(model, id || '');
|
model = objectUtils.toNewFormat(model, id || '');
|
||||||
|
|
||||||
return Boolean(openmct.composition.get(model));
|
return Boolean(openmct.composition.get(model));
|
||||||
|
@ -28,6 +28,10 @@ export default class Editor extends EventEmitter {
|
|||||||
super();
|
super();
|
||||||
this.editing = false;
|
this.editing = false;
|
||||||
this.openmct = openmct;
|
this.openmct = openmct;
|
||||||
|
|
||||||
|
openmct.once('destroy', () => {
|
||||||
|
this.removeAllListeners();
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -44,7 +44,15 @@ describe('The ActionCollection', () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
openmct.$injector.get.and.returnValue(mockIdentifierService);
|
openmct.$injector.get.and.callFake((key) => {
|
||||||
|
return {
|
||||||
|
'identifierService': mockIdentifierService,
|
||||||
|
'$rootScope': {
|
||||||
|
'$destroy': () => {}
|
||||||
|
}
|
||||||
|
}[key];
|
||||||
|
});
|
||||||
|
|
||||||
mockObjectPath = [
|
mockObjectPath = [
|
||||||
{
|
{
|
||||||
name: 'mock folder',
|
name: 'mock folder',
|
||||||
|
@ -60,9 +60,7 @@ class ActionsAPI extends EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
_getCachedActionCollection(objectPath, view) {
|
_getCachedActionCollection(objectPath, view) {
|
||||||
let cachedActionCollection = this._actionCollections.get(view);
|
return this._actionCollections.get(view);
|
||||||
|
|
||||||
return cachedActionCollection;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
_newActionCollection(objectPath, view, skipEnvironmentObservers) {
|
_newActionCollection(objectPath, view, skipEnvironmentObservers) {
|
||||||
|
@ -46,7 +46,7 @@ define([
|
|||||||
StatusAPI
|
StatusAPI
|
||||||
) {
|
) {
|
||||||
return {
|
return {
|
||||||
TimeAPI: TimeAPI,
|
TimeAPI: TimeAPI.default,
|
||||||
ObjectAPI: ObjectAPI,
|
ObjectAPI: ObjectAPI,
|
||||||
CompositionAPI: CompositionAPI,
|
CompositionAPI: CompositionAPI,
|
||||||
TypeRegistry: TypeRegistry,
|
TypeRegistry: TypeRegistry,
|
||||||
|
@ -42,7 +42,7 @@ import EventEmitter from 'EventEmitter';
|
|||||||
*
|
*
|
||||||
* @typedef {object} NotificationModel
|
* @typedef {object} NotificationModel
|
||||||
* @property {string} message The message to be displayed by the notification
|
* @property {string} message The message to be displayed by the notification
|
||||||
* @property {number | 'unknown'} [progress] The progres of some ongoing task. Should be a number between 0 and 100, or
|
* @property {number | 'unknown'} [progress] The progress of some ongoing task. Should be a number between 0 and 100, or
|
||||||
* with the string literal 'unknown'.
|
* with the string literal 'unknown'.
|
||||||
* @property {string} [progressText] A message conveying progress of some ongoing task.
|
* @property {string} [progressText] A message conveying progress of some ongoing task.
|
||||||
|
|
||||||
@ -98,7 +98,7 @@ export default class NotificationAPI extends EventEmitter {
|
|||||||
* Present an alert to the user.
|
* Present an alert to the user.
|
||||||
* @param {string} message The message to display to the user.
|
* @param {string} message The message to display to the user.
|
||||||
* @param {Object} [options] object with following properties
|
* @param {Object} [options] object with following properties
|
||||||
* autoDismissTimeout: {number} in miliseconds to automatically dismisses notification
|
* autoDismissTimeout: {number} in milliseconds to automatically dismisses notification
|
||||||
* link: {Object} Add a link to notifications for navigation
|
* link: {Object} Add a link to notifications for navigation
|
||||||
* onClick: callback function
|
* onClick: callback function
|
||||||
* cssClass: css class name to add style on link
|
* cssClass: css class name to add style on link
|
||||||
@ -119,7 +119,7 @@ export default class NotificationAPI extends EventEmitter {
|
|||||||
* Present an error message to the user
|
* Present an error message to the user
|
||||||
* @param {string} message
|
* @param {string} message
|
||||||
* @param {Object} [options] object with following properties
|
* @param {Object} [options] object with following properties
|
||||||
* autoDismissTimeout: {number} in miliseconds to automatically dismisses notification
|
* autoDismissTimeout: {number} in milliseconds to automatically dismisses notification
|
||||||
* link: {Object} Add a link to notifications for navigation
|
* link: {Object} Add a link to notifications for navigation
|
||||||
* onClick: callback function
|
* onClick: callback function
|
||||||
* cssClass: css class name to add style on link
|
* cssClass: css class name to add style on link
|
||||||
|
@ -358,6 +358,20 @@ ObjectAPI.prototype.applyGetInterceptors = function (identifier, domainObject) {
|
|||||||
return domainObject;
|
return domainObject;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return relative url path from a given object path
|
||||||
|
* eg: #/browse/mine/cb56f6bf-c900-43b7-b923-2e3b64b412db/6e89e858-77ce-46e4-a1ad-749240286497/....
|
||||||
|
* @param {Array} objectPath
|
||||||
|
* @returns {string} relative url for object
|
||||||
|
*/
|
||||||
|
ObjectAPI.prototype.getRelativePath = function (objectPath) {
|
||||||
|
return objectPath
|
||||||
|
.map(p => this.makeKeyString(p.identifier))
|
||||||
|
.reverse()
|
||||||
|
.join('/')
|
||||||
|
;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Modify a domain object.
|
* Modify a domain object.
|
||||||
* @param {module:openmct.DomainObject} object the object to mutate
|
* @param {module:openmct.DomainObject} object the object to mutate
|
||||||
|
@ -10,28 +10,37 @@ const cssClasses = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
class Overlay extends EventEmitter {
|
class Overlay extends EventEmitter {
|
||||||
constructor(options) {
|
constructor({
|
||||||
|
buttons,
|
||||||
|
autoHide = true,
|
||||||
|
dismissable = true,
|
||||||
|
element,
|
||||||
|
onDestroy,
|
||||||
|
size
|
||||||
|
} = {}) {
|
||||||
super();
|
super();
|
||||||
|
|
||||||
this.dismissable = options.dismissable !== false;
|
|
||||||
this.container = document.createElement('div');
|
this.container = document.createElement('div');
|
||||||
this.container.classList.add('l-overlay-wrapper', cssClasses[options.size]);
|
this.container.classList.add('l-overlay-wrapper', cssClasses[size]);
|
||||||
|
|
||||||
|
this.autoHide = autoHide;
|
||||||
|
this.dismissable = dismissable !== false;
|
||||||
|
|
||||||
this.component = new Vue({
|
this.component = new Vue({
|
||||||
provide: {
|
|
||||||
dismiss: this.dismiss.bind(this),
|
|
||||||
element: options.element,
|
|
||||||
buttons: options.buttons,
|
|
||||||
dismissable: this.dismissable
|
|
||||||
},
|
|
||||||
components: {
|
components: {
|
||||||
OverlayComponent: OverlayComponent
|
OverlayComponent: OverlayComponent
|
||||||
},
|
},
|
||||||
|
provide: {
|
||||||
|
dismiss: this.dismiss.bind(this),
|
||||||
|
element,
|
||||||
|
buttons,
|
||||||
|
dismissable: this.dismissable
|
||||||
|
},
|
||||||
template: '<overlay-component></overlay-component>'
|
template: '<overlay-component></overlay-component>'
|
||||||
});
|
});
|
||||||
|
|
||||||
if (options.onDestroy) {
|
if (onDestroy) {
|
||||||
this.once('destroy', options.onDestroy);
|
this.once('destroy', onDestroy);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -17,11 +17,7 @@ class OverlayAPI {
|
|||||||
|
|
||||||
this.dismissLastOverlay = this.dismissLastOverlay.bind(this);
|
this.dismissLastOverlay = this.dismissLastOverlay.bind(this);
|
||||||
|
|
||||||
document.addEventListener('keyup', (event) => {
|
document.addEventListener('keyup', this.dismissLastOverlay);
|
||||||
if (event.key === 'Escape') {
|
|
||||||
this.dismissLastOverlay();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -30,7 +26,10 @@ class OverlayAPI {
|
|||||||
*/
|
*/
|
||||||
showOverlay(overlay) {
|
showOverlay(overlay) {
|
||||||
if (this.activeOverlays.length) {
|
if (this.activeOverlays.length) {
|
||||||
this.activeOverlays[this.activeOverlays.length - 1].container.classList.add('invisible');
|
const previousOverlay = this.activeOverlays[this.activeOverlays.length - 1];
|
||||||
|
if (previousOverlay.autoHide) {
|
||||||
|
previousOverlay.container.classList.add('invisible');
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
this.activeOverlays.push(overlay);
|
this.activeOverlays.push(overlay);
|
||||||
@ -49,10 +48,12 @@ class OverlayAPI {
|
|||||||
/**
|
/**
|
||||||
* private
|
* private
|
||||||
*/
|
*/
|
||||||
dismissLastOverlay() {
|
dismissLastOverlay(event) {
|
||||||
let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1];
|
if (event.key === 'Escape') {
|
||||||
if (lastOverlay && lastOverlay.dismissable) {
|
let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1];
|
||||||
lastOverlay.dismiss();
|
if (lastOverlay && lastOverlay.dismissable) {
|
||||||
|
lastOverlay.dismiss();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -129,6 +130,10 @@ class OverlayAPI {
|
|||||||
return progressDialog;
|
return progressDialog;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
destroy() {
|
||||||
|
document.removeEventListener('keyup', this.dismissLastOverlay);
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export default OverlayAPI;
|
export default OverlayAPI;
|
||||||
|
@ -12,7 +12,7 @@
|
|||||||
></button>
|
></button>
|
||||||
<div
|
<div
|
||||||
ref="element"
|
ref="element"
|
||||||
class="c-overlay__contents"
|
class="c-overlay__contents js-notebook-snapshot-item-wrapper"
|
||||||
tabindex="0"
|
tabindex="0"
|
||||||
></div>
|
></div>
|
||||||
<div
|
<div
|
||||||
|
@ -32,6 +32,10 @@ export default class StatusAPI extends EventEmitter {
|
|||||||
this.get = this.get.bind(this);
|
this.get = this.get.bind(this);
|
||||||
this.set = this.set.bind(this);
|
this.set = this.set.bind(this);
|
||||||
this.observe = this.observe.bind(this);
|
this.observe = this.observe.bind(this);
|
||||||
|
|
||||||
|
openmct.once('destroy', () => {
|
||||||
|
this.removeAllListeners();
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
get(identifier) {
|
get(identifier) {
|
||||||
|
@ -20,6 +20,8 @@
|
|||||||
* at runtime from the About dialog for additional information.
|
* at runtime from the About dialog for additional information.
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
|
|
||||||
|
const { TelemetryCollection } = require("./TelemetryCollection");
|
||||||
|
|
||||||
define([
|
define([
|
||||||
'../../plugins/displayLayout/CustomStringFormatter',
|
'../../plugins/displayLayout/CustomStringFormatter',
|
||||||
'./TelemetryMetadataManager',
|
'./TelemetryMetadataManager',
|
||||||
@ -273,6 +275,28 @@ define([
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request telemetry collection for a domain object.
|
||||||
|
* The `options` argument allows you to specify filters
|
||||||
|
* (start, end, etc.), sort order, and strategies for retrieving
|
||||||
|
* telemetry (aggregation, latest available, etc.).
|
||||||
|
*
|
||||||
|
* @method requestCollection
|
||||||
|
* @memberof module:openmct.TelemetryAPI~TelemetryProvider#
|
||||||
|
* @param {module:openmct.DomainObject} domainObject the object
|
||||||
|
* which has associated telemetry
|
||||||
|
* @param {module:openmct.TelemetryAPI~TelemetryRequest} options
|
||||||
|
* options for this telemetry collection request
|
||||||
|
* @returns {TelemetryCollection} a TelemetryCollection instance
|
||||||
|
*/
|
||||||
|
TelemetryAPI.prototype.requestCollection = function (domainObject, options = {}) {
|
||||||
|
return new TelemetryCollection(
|
||||||
|
this.openmct,
|
||||||
|
domainObject,
|
||||||
|
options
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Request historical telemetry for a domain object.
|
* Request historical telemetry for a domain object.
|
||||||
* The `options` argument allows you to specify filters
|
* The `options` argument allows you to specify filters
|
||||||
|
File diff suppressed because it is too large
Load Diff
396
src/api/telemetry/TelemetryCollection.js
Normal file
396
src/api/telemetry/TelemetryCollection.js
Normal file
@ -0,0 +1,396 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2020, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import _ from 'lodash';
|
||||||
|
import EventEmitter from 'EventEmitter';
|
||||||
|
|
||||||
|
const ERRORS = {
|
||||||
|
TIMESYSTEM_KEY: 'All telemetry metadata must have a telemetry value with a key that matches the key of the active time system.',
|
||||||
|
LOADED: 'Telemetry Collection has already been loaded.'
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Class representing a Telemetry Collection. */
|
||||||
|
|
||||||
|
export class TelemetryCollection extends EventEmitter {
|
||||||
|
/**
|
||||||
|
* Creates a Telemetry Collection
|
||||||
|
*
|
||||||
|
* @param {object} openmct - Openm MCT
|
||||||
|
* @param {object} domainObject - Domain Object to user for telemetry collection
|
||||||
|
* @param {object} options - Any options passed in for request/subscribe
|
||||||
|
*/
|
||||||
|
constructor(openmct, domainObject, options) {
|
||||||
|
super();
|
||||||
|
|
||||||
|
this.loaded = false;
|
||||||
|
this.openmct = openmct;
|
||||||
|
this.domainObject = domainObject;
|
||||||
|
this.boundedTelemetry = [];
|
||||||
|
this.futureBuffer = [];
|
||||||
|
this.parseTime = undefined;
|
||||||
|
this.metadata = this.openmct.telemetry.getMetadata(domainObject);
|
||||||
|
this.unsubscribe = undefined;
|
||||||
|
this.historicalProvider = undefined;
|
||||||
|
this.options = options;
|
||||||
|
this.pageState = undefined;
|
||||||
|
this.lastBounds = undefined;
|
||||||
|
this.requestAbort = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This will start the requests for historical and realtime data,
|
||||||
|
* as well as setting up initial values and watchers
|
||||||
|
*/
|
||||||
|
load() {
|
||||||
|
if (this.loaded) {
|
||||||
|
this._error(ERRORS.LOADED);
|
||||||
|
}
|
||||||
|
|
||||||
|
this._timeSystem(this.openmct.time.timeSystem());
|
||||||
|
this.lastBounds = this.openmct.time.bounds();
|
||||||
|
|
||||||
|
this._watchBounds();
|
||||||
|
this._watchTimeSystem();
|
||||||
|
|
||||||
|
this._initiateHistoricalRequests();
|
||||||
|
this._initiateSubscriptionTelemetry();
|
||||||
|
|
||||||
|
this.loaded = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* can/should be called by the requester of the telemetry collection
|
||||||
|
* to remove any listeners
|
||||||
|
*/
|
||||||
|
destroy() {
|
||||||
|
if (this.requestAbort) {
|
||||||
|
this.requestAbort.abort();
|
||||||
|
}
|
||||||
|
|
||||||
|
this._unwatchBounds();
|
||||||
|
this._unwatchTimeSystem();
|
||||||
|
if (this.unsubscribe) {
|
||||||
|
this.unsubscribe();
|
||||||
|
}
|
||||||
|
|
||||||
|
this.removeAllListeners();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This will start the requests for historical and realtime data,
|
||||||
|
* as well as setting up initial values and watchers
|
||||||
|
*/
|
||||||
|
getAll() {
|
||||||
|
return this.boundedTelemetry;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets up the telemetry collection for historical requests,
|
||||||
|
* this uses the "standardizeRequestOptions" from Telemetry API
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_initiateHistoricalRequests() {
|
||||||
|
this.openmct.telemetry.standardizeRequestOptions(this.options);
|
||||||
|
this.historicalProvider = this.openmct.telemetry.
|
||||||
|
findRequestProvider(this.domainObject, this.options);
|
||||||
|
|
||||||
|
this._requestHistoricalTelemetry();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If a historical provider exists, then historical requests will be made
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
async _requestHistoricalTelemetry() {
|
||||||
|
if (!this.historicalProvider) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
let historicalData;
|
||||||
|
|
||||||
|
this.options.onPartialResponse = this._processNewTelemetry.bind(this);
|
||||||
|
|
||||||
|
try {
|
||||||
|
this.requestAbort = new AbortController();
|
||||||
|
this.options.signal = this.requestAbort.signal;
|
||||||
|
historicalData = await this.historicalProvider.request(this.domainObject, this.options);
|
||||||
|
} catch (error) {
|
||||||
|
if (error.name !== 'AbortError') {
|
||||||
|
console.error('Error requesting telemetry data...');
|
||||||
|
this._error(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.requestAbort = undefined;
|
||||||
|
|
||||||
|
this._processNewTelemetry(historicalData);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This uses the built in subscription function from Telemetry API
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_initiateSubscriptionTelemetry() {
|
||||||
|
|
||||||
|
if (this.unsubscribe) {
|
||||||
|
this.unsubscribe();
|
||||||
|
}
|
||||||
|
|
||||||
|
this.unsubscribe = this.openmct.telemetry
|
||||||
|
.subscribe(
|
||||||
|
this.domainObject,
|
||||||
|
datum => this._processNewTelemetry(datum),
|
||||||
|
this.options
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter any new telemetry (add/page, historical, subscription) based on
|
||||||
|
* time bounds and dupes
|
||||||
|
*
|
||||||
|
* @param {(Object|Object[])} telemetryData - telemetry data object or
|
||||||
|
* array of telemetry data objects
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_processNewTelemetry(telemetryData) {
|
||||||
|
let data = Array.isArray(telemetryData) ? telemetryData : [telemetryData];
|
||||||
|
let parsedValue;
|
||||||
|
let beforeStartOfBounds;
|
||||||
|
let afterEndOfBounds;
|
||||||
|
let added = [];
|
||||||
|
|
||||||
|
for (let datum of data) {
|
||||||
|
parsedValue = this.parseTime(datum);
|
||||||
|
beforeStartOfBounds = parsedValue < this.lastBounds.start;
|
||||||
|
afterEndOfBounds = parsedValue > this.lastBounds.end;
|
||||||
|
|
||||||
|
if (!afterEndOfBounds && !beforeStartOfBounds) {
|
||||||
|
let isDuplicate = false;
|
||||||
|
let startIndex = this._sortedIndex(datum);
|
||||||
|
let endIndex = undefined;
|
||||||
|
|
||||||
|
// dupe check
|
||||||
|
if (startIndex !== this.boundedTelemetry.length) {
|
||||||
|
endIndex = _.sortedLastIndexBy(
|
||||||
|
this.boundedTelemetry,
|
||||||
|
datum,
|
||||||
|
boundedDatum => this.parseTime(boundedDatum)
|
||||||
|
);
|
||||||
|
|
||||||
|
if (endIndex > startIndex) {
|
||||||
|
let potentialDupes = this.boundedTelemetry.slice(startIndex, endIndex);
|
||||||
|
|
||||||
|
isDuplicate = potentialDupes.some(_.isEqual.bind(undefined, datum));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isDuplicate) {
|
||||||
|
let index = endIndex || startIndex;
|
||||||
|
|
||||||
|
this.boundedTelemetry.splice(index, 0, datum);
|
||||||
|
added.push(datum);
|
||||||
|
}
|
||||||
|
|
||||||
|
} else if (afterEndOfBounds) {
|
||||||
|
this.futureBuffer.push(datum);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (added.length) {
|
||||||
|
this.emit('add', added);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Finds the correct insertion point for the given telemetry datum.
|
||||||
|
* Leverages lodash's `sortedIndexBy` function which implements a binary search.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_sortedIndex(datum) {
|
||||||
|
if (this.boundedTelemetry.length === 0) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
let parsedValue = this.parseTime(datum);
|
||||||
|
let lastValue = this.parseTime(this.boundedTelemetry[this.boundedTelemetry.length - 1]);
|
||||||
|
|
||||||
|
if (parsedValue > lastValue || parsedValue === lastValue) {
|
||||||
|
return this.boundedTelemetry.length;
|
||||||
|
} else {
|
||||||
|
return _.sortedIndexBy(
|
||||||
|
this.boundedTelemetry,
|
||||||
|
datum,
|
||||||
|
boundedDatum => this.parseTime(boundedDatum)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* when the start time, end time, or both have been updated.
|
||||||
|
* data could be added OR removed here we update the current
|
||||||
|
* bounded telemetry
|
||||||
|
*
|
||||||
|
* @param {TimeConductorBounds} bounds The newly updated bounds
|
||||||
|
* @param {boolean} [tick] `true` if the bounds update was due to
|
||||||
|
* a "tick" event (ie. was an automatic update), false otherwise.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_bounds(bounds, isTick) {
|
||||||
|
let startChanged = this.lastBounds.start !== bounds.start;
|
||||||
|
let endChanged = this.lastBounds.end !== bounds.end;
|
||||||
|
|
||||||
|
this.lastBounds = bounds;
|
||||||
|
|
||||||
|
if (isTick) {
|
||||||
|
// need to check futureBuffer and need to check
|
||||||
|
// if anything has fallen out of bounds
|
||||||
|
let startIndex = 0;
|
||||||
|
let endIndex = 0;
|
||||||
|
|
||||||
|
let discarded = [];
|
||||||
|
let added = [];
|
||||||
|
let testDatum = {};
|
||||||
|
|
||||||
|
if (startChanged) {
|
||||||
|
testDatum[this.timeKey] = bounds.start;
|
||||||
|
// Calculate the new index of the first item within the bounds
|
||||||
|
startIndex = _.sortedIndexBy(
|
||||||
|
this.boundedTelemetry,
|
||||||
|
testDatum,
|
||||||
|
datum => this.parseTime(datum)
|
||||||
|
);
|
||||||
|
discarded = this.boundedTelemetry.splice(0, startIndex);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (endChanged) {
|
||||||
|
testDatum[this.timeKey] = bounds.end;
|
||||||
|
// Calculate the new index of the last item in bounds
|
||||||
|
endIndex = _.sortedLastIndexBy(
|
||||||
|
this.futureBuffer,
|
||||||
|
testDatum,
|
||||||
|
datum => this.parseTime(datum)
|
||||||
|
);
|
||||||
|
added = this.futureBuffer.splice(0, endIndex);
|
||||||
|
this.boundedTelemetry = [...this.boundedTelemetry, ...added];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (discarded.length > 0) {
|
||||||
|
this.emit('remove', discarded);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (added.length > 0) {
|
||||||
|
this.emit('add', added);
|
||||||
|
}
|
||||||
|
|
||||||
|
} else {
|
||||||
|
// user bounds change, reset
|
||||||
|
this._reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* whenever the time system is updated need to update related values in
|
||||||
|
* the Telemetry Collection and reset the telemetry collection
|
||||||
|
*
|
||||||
|
* @param {TimeSystem} timeSystem - the value of the currently applied
|
||||||
|
* Time System
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_timeSystem(timeSystem) {
|
||||||
|
let domains = this.metadata.valuesForHints(['domain']);
|
||||||
|
let domain = domains.find((d) => d.key === timeSystem.key);
|
||||||
|
|
||||||
|
if (domain === undefined) {
|
||||||
|
this._error(ERRORS.TIMESYSTEM_KEY);
|
||||||
|
}
|
||||||
|
|
||||||
|
// timeKey is used to create a dummy datum used for sorting
|
||||||
|
this.timeKey = domain.source; // this defaults to key if no source is set
|
||||||
|
let metadataValue = this.metadata.value(timeSystem.key) || { format: timeSystem.key };
|
||||||
|
let valueFormatter = this.openmct.telemetry.getValueFormatter(metadataValue);
|
||||||
|
|
||||||
|
this.parseTime = (datum) => {
|
||||||
|
return valueFormatter.parse(datum);
|
||||||
|
};
|
||||||
|
|
||||||
|
this._reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset the telemetry data of the collection, and re-request
|
||||||
|
* historical telemetry
|
||||||
|
* @private
|
||||||
|
*
|
||||||
|
* @todo handle subscriptions more granually
|
||||||
|
*/
|
||||||
|
_reset() {
|
||||||
|
this.boundedTelemetry = [];
|
||||||
|
this.futureBuffer = [];
|
||||||
|
|
||||||
|
this.emit('clear');
|
||||||
|
|
||||||
|
this._requestHistoricalTelemetry();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds the _bounds callback to the 'bounds' timeAPI listener
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_watchBounds() {
|
||||||
|
this.openmct.time.on('bounds', this._bounds, this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes the _bounds callback from the 'bounds' timeAPI listener
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_unwatchBounds() {
|
||||||
|
this.openmct.time.off('bounds', this._bounds, this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds the _timeSystem callback to the 'timeSystem' timeAPI listener
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_watchTimeSystem() {
|
||||||
|
this.openmct.time.on('timeSystem', this._timeSystem, this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* removes the _timeSystem callback from the 'timeSystem' timeAPI listener
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_unwatchTimeSystem() {
|
||||||
|
this.openmct.time.off('timeSystem', this._timeSystem, this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* will throw a new Error, for passed in message
|
||||||
|
* @param {string} message Message describing the error
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
_error(message) {
|
||||||
|
throw new Error(message);
|
||||||
|
}
|
||||||
|
}
|
106
src/api/time/GlobalTimeContext.js
Normal file
106
src/api/time/GlobalTimeContext.js
Normal file
@ -0,0 +1,106 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import TimeContext from "./TimeContext";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The GlobalContext handles getting and setting time of the openmct application in general.
|
||||||
|
* Views will use this context unless they specify an alternate/independent time context
|
||||||
|
*/
|
||||||
|
class GlobalTimeContext extends TimeContext {
|
||||||
|
constructor() {
|
||||||
|
super();
|
||||||
|
|
||||||
|
//The Time Of Interest
|
||||||
|
this.toi = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get or set the start and end time of the time conductor. Basic validation
|
||||||
|
* of bounds is performed.
|
||||||
|
*
|
||||||
|
* @param {module:openmct.TimeAPI~TimeConductorBounds} newBounds
|
||||||
|
* @throws {Error} Validation error
|
||||||
|
* @fires module:openmct.TimeAPI~bounds
|
||||||
|
* @returns {module:openmct.TimeAPI~TimeConductorBounds}
|
||||||
|
* @memberof module:openmct.TimeAPI#
|
||||||
|
* @method bounds
|
||||||
|
*/
|
||||||
|
bounds(newBounds) {
|
||||||
|
if (arguments.length > 0) {
|
||||||
|
super.bounds.call(this, ...arguments);
|
||||||
|
// If a bounds change results in a TOI outside of the current
|
||||||
|
// bounds, unset it
|
||||||
|
if (this.toi < newBounds.start || this.toi > newBounds.end) {
|
||||||
|
this.timeOfInterest(undefined);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//Return a copy to prevent direct mutation of time conductor bounds.
|
||||||
|
return JSON.parse(JSON.stringify(this.boundsVal));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update bounds based on provided time and current offsets
|
||||||
|
* @private
|
||||||
|
* @param {number} timestamp A time from which bounds will be calculated
|
||||||
|
* using current offsets.
|
||||||
|
*/
|
||||||
|
tick(timestamp) {
|
||||||
|
super.tick.call(this, ...arguments);
|
||||||
|
|
||||||
|
// If a bounds change results in a TOI outside of the current
|
||||||
|
// bounds, unset it
|
||||||
|
if (this.toi < this.boundsVal.start || this.toi > this.boundsVal.end) {
|
||||||
|
this.timeOfInterest(undefined);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get or set the Time of Interest. The Time of Interest is a single point
|
||||||
|
* in time, and constitutes the temporal focus of application views. It can
|
||||||
|
* be manipulated by the user from the time conductor or from other views.
|
||||||
|
* The time of interest can effectively be unset by assigning a value of
|
||||||
|
* 'undefined'.
|
||||||
|
* @fires module:openmct.TimeAPI~timeOfInterest
|
||||||
|
* @param newTOI
|
||||||
|
* @returns {number} the current time of interest
|
||||||
|
* @memberof module:openmct.TimeAPI#
|
||||||
|
* @method timeOfInterest
|
||||||
|
*/
|
||||||
|
timeOfInterest(newTOI) {
|
||||||
|
if (arguments.length > 0) {
|
||||||
|
this.toi = newTOI;
|
||||||
|
/**
|
||||||
|
* The Time of Interest has moved.
|
||||||
|
* @event timeOfInterest
|
||||||
|
* @memberof module:openmct.TimeAPI~
|
||||||
|
* @property {number} Current time of interest
|
||||||
|
*/
|
||||||
|
this.emit('timeOfInterest', this.toi);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.toi;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default GlobalTimeContext;
|
94
src/api/time/IndependentTimeContext.js
Normal file
94
src/api/time/IndependentTimeContext.js
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import TimeContext from "./TimeContext";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The IndependentTimeContext handles getting and setting time of the openmct application in general.
|
||||||
|
* Views will use the GlobalTimeContext unless they specify an alternate/independent time context here.
|
||||||
|
*/
|
||||||
|
class IndependentTimeContext extends TimeContext {
|
||||||
|
constructor(globalTimeContext, key) {
|
||||||
|
super();
|
||||||
|
this.key = key;
|
||||||
|
|
||||||
|
this.globalTimeContext = globalTimeContext;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the active clock. Tick source will be immediately subscribed to
|
||||||
|
* and ticking will begin. Offsets from 'now' must also be provided. A clock
|
||||||
|
* can be unset by calling {@link stopClock}.
|
||||||
|
*
|
||||||
|
* @param {Clock || string} keyOrClock The clock to activate, or its key
|
||||||
|
* @param {ClockOffsets} offsets on each tick these will be used to calculate
|
||||||
|
* the start and end bounds. This maintains a sliding time window of a fixed
|
||||||
|
* width that automatically updates.
|
||||||
|
* @fires module:openmct.TimeAPI~clock
|
||||||
|
* @return {Clock} the currently active clock;
|
||||||
|
*/
|
||||||
|
clock(keyOrClock, offsets) {
|
||||||
|
if (arguments.length === 2) {
|
||||||
|
let clock;
|
||||||
|
|
||||||
|
if (typeof keyOrClock === 'string') {
|
||||||
|
clock = this.globalTimeContext.clocks.get(keyOrClock);
|
||||||
|
if (clock === undefined) {
|
||||||
|
throw "Unknown clock '" + keyOrClock + "'. Has it been registered with 'addClock'?";
|
||||||
|
}
|
||||||
|
} else if (typeof keyOrClock === 'object') {
|
||||||
|
clock = keyOrClock;
|
||||||
|
if (!this.globalTimeContext.clocks.has(clock.key)) {
|
||||||
|
throw "Unknown clock '" + keyOrClock.key + "'. Has it been registered with 'addClock'?";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const previousClock = this.activeClock;
|
||||||
|
if (previousClock !== undefined) {
|
||||||
|
previousClock.off("tick", this.tick);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.activeClock = clock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The active clock has changed. Clock can be unset by calling {@link stopClock}
|
||||||
|
* @event clock
|
||||||
|
* @memberof module:openmct.TimeAPI~
|
||||||
|
* @property {Clock} clock The newly activated clock, or undefined
|
||||||
|
* if the system is no longer following a clock source
|
||||||
|
*/
|
||||||
|
this.emit("clock", this.activeClock);
|
||||||
|
|
||||||
|
if (this.activeClock !== undefined) {
|
||||||
|
this.clockOffsets(offsets);
|
||||||
|
this.activeClock.on("tick", this.tick);
|
||||||
|
}
|
||||||
|
|
||||||
|
} else if (arguments.length === 1) {
|
||||||
|
throw "When setting the clock, clock offsets must also be provided";
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.activeClock;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default IndependentTimeContext;
|
@ -20,51 +20,35 @@
|
|||||||
* at runtime from the About dialog for additional information.
|
* at runtime from the About dialog for additional information.
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
|
|
||||||
define(['EventEmitter'], function (EventEmitter) {
|
import GlobalTimeContext from "./GlobalTimeContext";
|
||||||
|
import IndependentTimeContext from "@/api/time/IndependentTimeContext";
|
||||||
/**
|
|
||||||
* The public API for setting and querying the temporal state of the
|
|
||||||
* application. The concept of time is integral to Open MCT, and at least
|
|
||||||
* one {@link TimeSystem}, as well as some default time bounds must be
|
|
||||||
* registered and enabled via {@link TimeAPI.addTimeSystem} and
|
|
||||||
* {@link TimeAPI.timeSystem} respectively for Open MCT to work.
|
|
||||||
*
|
|
||||||
* Time-sensitive views will typically respond to changes to bounds or other
|
|
||||||
* properties of the time conductor and update the data displayed based on
|
|
||||||
* the temporal state of the application. The current time bounds are also
|
|
||||||
* used in queries for historical data.
|
|
||||||
*
|
|
||||||
* The TimeAPI extends the EventEmitter class. A number of events are
|
|
||||||
* fired when properties of the time conductor change, which are documented
|
|
||||||
* below.
|
|
||||||
*
|
|
||||||
* @interface
|
|
||||||
* @memberof module:openmct
|
|
||||||
*/
|
|
||||||
function TimeAPI() {
|
|
||||||
EventEmitter.call(this);
|
|
||||||
|
|
||||||
//The Time System
|
|
||||||
this.system = undefined;
|
|
||||||
//The Time Of Interest
|
|
||||||
this.toi = undefined;
|
|
||||||
|
|
||||||
this.boundsVal = {
|
|
||||||
start: undefined,
|
|
||||||
end: undefined
|
|
||||||
};
|
|
||||||
|
|
||||||
this.timeSystems = new Map();
|
|
||||||
this.clocks = new Map();
|
|
||||||
this.activeClock = undefined;
|
|
||||||
this.offsets = undefined;
|
|
||||||
|
|
||||||
this.tick = this.tick.bind(this);
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The public API for setting and querying the temporal state of the
|
||||||
|
* application. The concept of time is integral to Open MCT, and at least
|
||||||
|
* one {@link TimeSystem}, as well as some default time bounds must be
|
||||||
|
* registered and enabled via {@link TimeAPI.addTimeSystem} and
|
||||||
|
* {@link TimeAPI.timeSystem} respectively for Open MCT to work.
|
||||||
|
*
|
||||||
|
* Time-sensitive views will typically respond to changes to bounds or other
|
||||||
|
* properties of the time conductor and update the data displayed based on
|
||||||
|
* the temporal state of the application. The current time bounds are also
|
||||||
|
* used in queries for historical data.
|
||||||
|
*
|
||||||
|
* The TimeAPI extends the GlobalTimeContext which in turn extends the TimeContext/EventEmitter class. A number of events are
|
||||||
|
* fired when properties of the time conductor change, which are documented
|
||||||
|
* below.
|
||||||
|
*
|
||||||
|
* @interface
|
||||||
|
* @memberof module:openmct
|
||||||
|
*/
|
||||||
|
class TimeAPI extends GlobalTimeContext {
|
||||||
|
constructor(openmct) {
|
||||||
|
super();
|
||||||
|
this.openmct = openmct;
|
||||||
|
this.independentContexts = new Map();
|
||||||
}
|
}
|
||||||
|
|
||||||
TimeAPI.prototype = Object.create(EventEmitter.prototype);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A TimeSystem provides meaning to the values returned by the TimeAPI. Open
|
* A TimeSystem provides meaning to the values returned by the TimeAPI. Open
|
||||||
* MCT supports multiple different types of time values, although all are
|
* MCT supports multiple different types of time values, although all are
|
||||||
@ -94,16 +78,16 @@ define(['EventEmitter'], function (EventEmitter) {
|
|||||||
* @memberof module:openmct.TimeAPI#
|
* @memberof module:openmct.TimeAPI#
|
||||||
* @param {TimeSystem} timeSystem A time system object.
|
* @param {TimeSystem} timeSystem A time system object.
|
||||||
*/
|
*/
|
||||||
TimeAPI.prototype.addTimeSystem = function (timeSystem) {
|
addTimeSystem(timeSystem) {
|
||||||
this.timeSystems.set(timeSystem.key, timeSystem);
|
this.timeSystems.set(timeSystem.key, timeSystem);
|
||||||
};
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns {TimeSystem[]}
|
* @returns {TimeSystem[]}
|
||||||
*/
|
*/
|
||||||
TimeAPI.prototype.getAllTimeSystems = function () {
|
getAllTimeSystems() {
|
||||||
return Array.from(this.timeSystems.values());
|
return Array.from(this.timeSystems.values());
|
||||||
};
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Clocks provide a timing source that is used to
|
* Clocks provide a timing source that is used to
|
||||||
@ -126,340 +110,81 @@ define(['EventEmitter'], function (EventEmitter) {
|
|||||||
* @memberof module:openmct.TimeAPI#
|
* @memberof module:openmct.TimeAPI#
|
||||||
* @param {Clock} clock
|
* @param {Clock} clock
|
||||||
*/
|
*/
|
||||||
TimeAPI.prototype.addClock = function (clock) {
|
addClock(clock) {
|
||||||
this.clocks.set(clock.key, clock);
|
this.clocks.set(clock.key, clock);
|
||||||
};
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @memberof module:openmct.TimeAPI#
|
* @memberof module:openmct.TimeAPI#
|
||||||
* @returns {Clock[]}
|
* @returns {Clock[]}
|
||||||
* @memberof module:openmct.TimeAPI#
|
* @memberof module:openmct.TimeAPI#
|
||||||
*/
|
*/
|
||||||
TimeAPI.prototype.getAllClocks = function () {
|
getAllClocks() {
|
||||||
return Array.from(this.clocks.values());
|
return Array.from(this.clocks.values());
|
||||||
};
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Validate the given bounds. This can be used for pre-validation of bounds,
|
* Get or set an independent time context which follows the TimeAPI timeSystem,
|
||||||
* for example by views validating user inputs.
|
* but with different offsets for a given domain object
|
||||||
* @param {TimeBounds} bounds The start and end time of the conductor.
|
* @param {key | string} key The identifier key of the domain object these offsets are set for
|
||||||
* @returns {string | true} A validation error, or true if valid
|
* @param {ClockOffsets | TimeBounds} value This maintains a sliding time window of a fixed width that automatically updates
|
||||||
|
* @param {key | string} clockKey the real time clock key currently in use
|
||||||
* @memberof module:openmct.TimeAPI#
|
* @memberof module:openmct.TimeAPI#
|
||||||
* @method validateBounds
|
* @method addIndependentTimeContext
|
||||||
*/
|
*/
|
||||||
TimeAPI.prototype.validateBounds = function (bounds) {
|
addIndependentContext(key, value, clockKey) {
|
||||||
if ((bounds.start === undefined)
|
let timeContext = this.independentContexts.get(key);
|
||||||
|| (bounds.end === undefined)
|
if (!timeContext) {
|
||||||
|| isNaN(bounds.start)
|
timeContext = new IndependentTimeContext(this, key);
|
||||||
|| isNaN(bounds.end)
|
this.independentContexts.set(key, timeContext);
|
||||||
) {
|
|
||||||
return "Start and end must be specified as integer values";
|
|
||||||
} else if (bounds.start > bounds.end) {
|
|
||||||
return "Specified start date exceeds end bound";
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
if (clockKey) {
|
||||||
};
|
timeContext.clock(clockKey, value);
|
||||||
|
} else {
|
||||||
/**
|
timeContext.stopClock();
|
||||||
* Validate the given offsets. This can be used for pre-validation of
|
timeContext.bounds(value);
|
||||||
* offsets, for example by views validating user inputs.
|
|
||||||
* @param {ClockOffsets} offsets The start and end offsets from a 'now' value.
|
|
||||||
* @returns {string | true} A validation error, or true if valid
|
|
||||||
* @memberof module:openmct.TimeAPI#
|
|
||||||
* @method validateBounds
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.validateOffsets = function (offsets) {
|
|
||||||
if ((offsets.start === undefined)
|
|
||||||
|| (offsets.end === undefined)
|
|
||||||
|| isNaN(offsets.start)
|
|
||||||
|| isNaN(offsets.end)
|
|
||||||
) {
|
|
||||||
return "Start and end offsets must be specified as integer values";
|
|
||||||
} else if (offsets.start >= offsets.end) {
|
|
||||||
return "Specified start offset must be < end offset";
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
this.emit('timeContext', key);
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
return () => {
|
||||||
* @typedef {Object} TimeBounds
|
this.independentContexts.delete(key);
|
||||||
* @property {number} start The start time displayed by the time conductor
|
timeContext.emit('timeContext', key);
|
||||||
* in ms since epoch. Epoch determined by currently active time system
|
|
||||||
* @property {number} end The end time displayed by the time conductor in ms
|
|
||||||
* since epoch.
|
|
||||||
* @memberof module:openmct.TimeAPI~
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get or set the start and end time of the time conductor. Basic validation
|
|
||||||
* of bounds is performed.
|
|
||||||
*
|
|
||||||
* @param {module:openmct.TimeAPI~TimeConductorBounds} newBounds
|
|
||||||
* @throws {Error} Validation error
|
|
||||||
* @fires module:openmct.TimeAPI~bounds
|
|
||||||
* @returns {module:openmct.TimeAPI~TimeConductorBounds}
|
|
||||||
* @memberof module:openmct.TimeAPI#
|
|
||||||
* @method bounds
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.bounds = function (newBounds) {
|
|
||||||
if (arguments.length > 0) {
|
|
||||||
const validationResult = this.validateBounds(newBounds);
|
|
||||||
if (validationResult !== true) {
|
|
||||||
throw new Error(validationResult);
|
|
||||||
}
|
|
||||||
|
|
||||||
//Create a copy to avoid direct mutation of conductor bounds
|
|
||||||
this.boundsVal = JSON.parse(JSON.stringify(newBounds));
|
|
||||||
/**
|
|
||||||
* The start time, end time, or both have been updated.
|
|
||||||
* @event bounds
|
|
||||||
* @memberof module:openmct.TimeAPI~
|
|
||||||
* @property {TimeConductorBounds} bounds The newly updated bounds
|
|
||||||
* @property {boolean} [tick] `true` if the bounds update was due to
|
|
||||||
* a "tick" event (ie. was an automatic update), false otherwise.
|
|
||||||
*/
|
|
||||||
this.emit('bounds', this.boundsVal, false);
|
|
||||||
|
|
||||||
// If a bounds change results in a TOI outside of the current
|
|
||||||
// bounds, unset it
|
|
||||||
if (this.toi < newBounds.start || this.toi > newBounds.end) {
|
|
||||||
this.timeOfInterest(undefined);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//Return a copy to prevent direct mutation of time conductor bounds.
|
|
||||||
return JSON.parse(JSON.stringify(this.boundsVal));
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get or set the time system of the TimeAPI.
|
|
||||||
* @param {TimeSystem | string} timeSystem
|
|
||||||
* @param {module:openmct.TimeAPI~TimeConductorBounds} bounds
|
|
||||||
* @fires module:openmct.TimeAPI~timeSystem
|
|
||||||
* @returns {TimeSystem} The currently applied time system
|
|
||||||
* @memberof module:openmct.TimeAPI#
|
|
||||||
* @method timeSystem
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.timeSystem = function (timeSystemOrKey, bounds) {
|
|
||||||
if (arguments.length >= 1) {
|
|
||||||
if (arguments.length === 1 && !this.activeClock) {
|
|
||||||
throw new Error(
|
|
||||||
"Must specify bounds when changing time system without "
|
|
||||||
+ "an active clock."
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
let timeSystem;
|
|
||||||
|
|
||||||
if (timeSystemOrKey === undefined) {
|
|
||||||
throw "Please provide a time system";
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof timeSystemOrKey === 'string') {
|
|
||||||
timeSystem = this.timeSystems.get(timeSystemOrKey);
|
|
||||||
|
|
||||||
if (timeSystem === undefined) {
|
|
||||||
throw "Unknown time system " + timeSystemOrKey + ". Has it been registered with 'addTimeSystem'?";
|
|
||||||
}
|
|
||||||
} else if (typeof timeSystemOrKey === 'object') {
|
|
||||||
timeSystem = timeSystemOrKey;
|
|
||||||
|
|
||||||
if (!this.timeSystems.has(timeSystem.key)) {
|
|
||||||
throw "Unknown time system " + timeSystem.key + ". Has it been registered with 'addTimeSystem'?";
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
throw "Attempt to set invalid time system in Time API. Please provide a previously registered time system object or key";
|
|
||||||
}
|
|
||||||
|
|
||||||
this.system = timeSystem;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The time system used by the time
|
|
||||||
* conductor has changed. A change in Time System will always be
|
|
||||||
* followed by a bounds event specifying new query bounds.
|
|
||||||
*
|
|
||||||
* @event module:openmct.TimeAPI~timeSystem
|
|
||||||
* @property {TimeSystem} The value of the currently applied
|
|
||||||
* Time System
|
|
||||||
* */
|
|
||||||
this.emit('timeSystem', this.system);
|
|
||||||
if (bounds) {
|
|
||||||
this.bounds(bounds);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.system;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get or set the Time of Interest. The Time of Interest is a single point
|
|
||||||
* in time, and constitutes the temporal focus of application views. It can
|
|
||||||
* be manipulated by the user from the time conductor or from other views.
|
|
||||||
* The time of interest can effectively be unset by assigning a value of
|
|
||||||
* 'undefined'.
|
|
||||||
* @fires module:openmct.TimeAPI~timeOfInterest
|
|
||||||
* @param newTOI
|
|
||||||
* @returns {number} the current time of interest
|
|
||||||
* @memberof module:openmct.TimeAPI#
|
|
||||||
* @method timeOfInterest
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.timeOfInterest = function (newTOI) {
|
|
||||||
if (arguments.length > 0) {
|
|
||||||
this.toi = newTOI;
|
|
||||||
/**
|
|
||||||
* The Time of Interest has moved.
|
|
||||||
* @event timeOfInterest
|
|
||||||
* @memberof module:openmct.TimeAPI~
|
|
||||||
* @property {number} Current time of interest
|
|
||||||
*/
|
|
||||||
this.emit('timeOfInterest', this.toi);
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.toi;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Update bounds based on provided time and current offsets
|
|
||||||
* @private
|
|
||||||
* @param {number} timestamp A time from which boudns will be calculated
|
|
||||||
* using current offsets.
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.tick = function (timestamp) {
|
|
||||||
const newBounds = {
|
|
||||||
start: timestamp + this.offsets.start,
|
|
||||||
end: timestamp + this.offsets.end
|
|
||||||
};
|
};
|
||||||
|
}
|
||||||
this.boundsVal = newBounds;
|
|
||||||
this.emit('bounds', this.boundsVal, true);
|
|
||||||
|
|
||||||
// If a bounds change results in a TOI outside of the current
|
|
||||||
// bounds, unset it
|
|
||||||
if (this.toi < newBounds.start || this.toi > newBounds.end) {
|
|
||||||
this.timeOfInterest(undefined);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the active clock. Tick source will be immediately subscribed to
|
* Get the independent time context which follows the TimeAPI timeSystem,
|
||||||
* and ticking will begin. Offsets from 'now' must also be provided. A clock
|
* but with different offsets.
|
||||||
* can be unset by calling {@link stopClock}.
|
* @param {key | string} key The identifier key of the domain object these offsets
|
||||||
*
|
* @memberof module:openmct.TimeAPI#
|
||||||
* @param {Clock || string} The clock to activate, or its key
|
* @method getIndependentTimeContext
|
||||||
* @param {ClockOffsets} offsets on each tick these will be used to calculate
|
|
||||||
* the start and end bounds. This maintains a sliding time window of a fixed
|
|
||||||
* width that automatically updates.
|
|
||||||
* @fires module:openmct.TimeAPI~clock
|
|
||||||
* @return {Clock} the currently active clock;
|
|
||||||
*/
|
*/
|
||||||
TimeAPI.prototype.clock = function (keyOrClock, offsets) {
|
getIndependentContext(key) {
|
||||||
if (arguments.length === 2) {
|
return this.independentContexts.get(key);
|
||||||
let clock;
|
}
|
||||||
|
|
||||||
if (typeof keyOrClock === 'string') {
|
|
||||||
clock = this.clocks.get(keyOrClock);
|
|
||||||
if (clock === undefined) {
|
|
||||||
throw "Unknown clock '" + keyOrClock + "'. Has it been registered with 'addClock'?";
|
|
||||||
}
|
|
||||||
} else if (typeof keyOrClock === 'object') {
|
|
||||||
clock = keyOrClock;
|
|
||||||
if (!this.clocks.has(clock.key)) {
|
|
||||||
throw "Unknown clock '" + keyOrClock.key + "'. Has it been registered with 'addClock'?";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const previousClock = this.activeClock;
|
|
||||||
if (previousClock !== undefined) {
|
|
||||||
previousClock.off("tick", this.tick);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.activeClock = clock;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The active clock has changed. Clock can be unset by calling {@link stopClock}
|
|
||||||
* @event clock
|
|
||||||
* @memberof module:openmct.TimeAPI~
|
|
||||||
* @property {Clock} clock The newly activated clock, or undefined
|
|
||||||
* if the system is no longer following a clock source
|
|
||||||
*/
|
|
||||||
this.emit("clock", this.activeClock);
|
|
||||||
|
|
||||||
if (this.activeClock !== undefined) {
|
|
||||||
this.clockOffsets(offsets);
|
|
||||||
this.activeClock.on("tick", this.tick);
|
|
||||||
}
|
|
||||||
|
|
||||||
} else if (arguments.length === 1) {
|
|
||||||
throw "When setting the clock, clock offsets must also be provided";
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.activeClock;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Clock offsets are used to calculate temporal bounds when the system is
|
* Get the a timeContext for a view based on it's objectPath. If there is any object in the objectPath with an independent time context, it will be returned.
|
||||||
* ticking on a clock source.
|
* Otherwise, the global time context will be returned.
|
||||||
*
|
* @param { Array } objectPath The view's objectPath
|
||||||
* @typedef {object} ClockOffsets
|
* @memberof module:openmct.TimeAPI#
|
||||||
* @property {number} start A time span relative to the current value of the
|
* @method getContextForView
|
||||||
* ticking clock, from which start bounds will be calculated. This value must
|
|
||||||
* be < 0. When a clock is active, bounds will be calculated automatically
|
|
||||||
* based on the value provided by the clock, and the defined clock offsets.
|
|
||||||
* @property {number} end A time span relative to the current value of the
|
|
||||||
* ticking clock, from which end bounds will be calculated. This value must
|
|
||||||
* be >= 0.
|
|
||||||
*/
|
*/
|
||||||
/**
|
getContextForView(objectPath) {
|
||||||
* Get or set the currently applied clock offsets. If no parameter is provided,
|
let timeContext = this;
|
||||||
* the current value will be returned. If provided, the new value will be
|
|
||||||
* used as the new clock offsets.
|
|
||||||
* @param {ClockOffsets} offsets
|
|
||||||
* @returns {ClockOffsets}
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.clockOffsets = function (offsets) {
|
|
||||||
if (arguments.length > 0) {
|
|
||||||
|
|
||||||
const validationResult = this.validateOffsets(offsets);
|
objectPath.forEach(item => {
|
||||||
if (validationResult !== true) {
|
const key = this.openmct.objects.makeKeyString(item.identifier);
|
||||||
throw new Error(validationResult);
|
if (this.independentContexts.get(key)) {
|
||||||
|
timeContext = this.independentContexts.get(key);
|
||||||
}
|
}
|
||||||
|
});
|
||||||
|
|
||||||
this.offsets = offsets;
|
return timeContext;
|
||||||
|
}
|
||||||
|
|
||||||
const currentValue = this.activeClock.currentValue();
|
}
|
||||||
const newBounds = {
|
|
||||||
start: currentValue + offsets.start,
|
|
||||||
end: currentValue + offsets.end
|
|
||||||
};
|
|
||||||
|
|
||||||
this.bounds(newBounds);
|
export default TimeAPI;
|
||||||
|
|
||||||
/**
|
|
||||||
* Event that is triggered when clock offsets change.
|
|
||||||
* @event clockOffsets
|
|
||||||
* @memberof module:openmct.TimeAPI~
|
|
||||||
* @property {ClockOffsets} clockOffsets The newly activated clock
|
|
||||||
* offsets.
|
|
||||||
*/
|
|
||||||
this.emit("clockOffsets", offsets);
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.offsets;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Stop the currently active clock from ticking, and unset it. This will
|
|
||||||
* revert all views to showing a static time frame defined by the current
|
|
||||||
* bounds.
|
|
||||||
*/
|
|
||||||
TimeAPI.prototype.stopClock = function () {
|
|
||||||
if (this.activeClock) {
|
|
||||||
this.clock(undefined, undefined);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
return TimeAPI;
|
|
||||||
});
|
|
||||||
|
@ -19,241 +19,243 @@
|
|||||||
* this source code distribution or the Licensing information page available
|
* this source code distribution or the Licensing information page available
|
||||||
* at runtime from the About dialog for additional information.
|
* at runtime from the About dialog for additional information.
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
|
import TimeAPI from "./TimeAPI";
|
||||||
|
import {createOpenMct} from "utils/testing";
|
||||||
|
|
||||||
define(['./TimeAPI'], function (TimeAPI) {
|
describe("The Time API", function () {
|
||||||
describe("The Time API", function () {
|
let api;
|
||||||
let api;
|
let timeSystemKey;
|
||||||
let timeSystemKey;
|
let timeSystem;
|
||||||
let timeSystem;
|
let clockKey;
|
||||||
let clockKey;
|
let clock;
|
||||||
let clock;
|
let bounds;
|
||||||
let bounds;
|
let eventListener;
|
||||||
let eventListener;
|
let toi;
|
||||||
let toi;
|
let openmct;
|
||||||
|
|
||||||
|
beforeEach(function () {
|
||||||
|
openmct = createOpenMct();
|
||||||
|
api = new TimeAPI(openmct);
|
||||||
|
timeSystemKey = "timeSystemKey";
|
||||||
|
timeSystem = {key: timeSystemKey};
|
||||||
|
clockKey = "someClockKey";
|
||||||
|
clock = jasmine.createSpyObj("clock", [
|
||||||
|
"on",
|
||||||
|
"off",
|
||||||
|
"currentValue"
|
||||||
|
]);
|
||||||
|
clock.currentValue.and.returnValue(100);
|
||||||
|
clock.key = clockKey;
|
||||||
|
bounds = {
|
||||||
|
start: 0,
|
||||||
|
end: 1
|
||||||
|
};
|
||||||
|
eventListener = jasmine.createSpy("eventListener");
|
||||||
|
toi = 111;
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Supports setting and querying of time of interest", function () {
|
||||||
|
expect(api.timeOfInterest()).not.toBe(toi);
|
||||||
|
api.timeOfInterest(toi);
|
||||||
|
expect(api.timeOfInterest()).toBe(toi);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Allows setting of valid bounds", function () {
|
||||||
|
bounds = {
|
||||||
|
start: 0,
|
||||||
|
end: 1
|
||||||
|
};
|
||||||
|
expect(api.bounds()).not.toBe(bounds);
|
||||||
|
expect(api.bounds.bind(api, bounds)).not.toThrow();
|
||||||
|
expect(api.bounds()).toEqual(bounds);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Disallows setting of invalid bounds", function () {
|
||||||
|
bounds = {
|
||||||
|
start: 1,
|
||||||
|
end: 0
|
||||||
|
};
|
||||||
|
expect(api.bounds()).not.toEqual(bounds);
|
||||||
|
expect(api.bounds.bind(api, bounds)).toThrow();
|
||||||
|
expect(api.bounds()).not.toEqual(bounds);
|
||||||
|
|
||||||
|
bounds = {start: 1};
|
||||||
|
expect(api.bounds()).not.toEqual(bounds);
|
||||||
|
expect(api.bounds.bind(api, bounds)).toThrow();
|
||||||
|
expect(api.bounds()).not.toEqual(bounds);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Allows setting of previously registered time system with bounds", function () {
|
||||||
|
api.addTimeSystem(timeSystem);
|
||||||
|
expect(api.timeSystem()).not.toBe(timeSystem);
|
||||||
|
expect(function () {
|
||||||
|
api.timeSystem(timeSystem, bounds);
|
||||||
|
}).not.toThrow();
|
||||||
|
expect(api.timeSystem()).toBe(timeSystem);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Disallows setting of time system without bounds", function () {
|
||||||
|
api.addTimeSystem(timeSystem);
|
||||||
|
expect(api.timeSystem()).not.toBe(timeSystem);
|
||||||
|
expect(function () {
|
||||||
|
api.timeSystem(timeSystemKey);
|
||||||
|
}).toThrow();
|
||||||
|
expect(api.timeSystem()).not.toBe(timeSystem);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("allows setting of timesystem without bounds with clock", function () {
|
||||||
|
api.addTimeSystem(timeSystem);
|
||||||
|
api.addClock(clock);
|
||||||
|
api.clock(clockKey, {
|
||||||
|
start: 0,
|
||||||
|
end: 1
|
||||||
|
});
|
||||||
|
expect(api.timeSystem()).not.toBe(timeSystem);
|
||||||
|
expect(function () {
|
||||||
|
api.timeSystem(timeSystemKey);
|
||||||
|
}).not.toThrow();
|
||||||
|
expect(api.timeSystem()).toBe(timeSystem);
|
||||||
|
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Emits an event when time system changes", function () {
|
||||||
|
api.addTimeSystem(timeSystem);
|
||||||
|
expect(eventListener).not.toHaveBeenCalled();
|
||||||
|
api.on("timeSystem", eventListener);
|
||||||
|
api.timeSystem(timeSystemKey, bounds);
|
||||||
|
expect(eventListener).toHaveBeenCalledWith(timeSystem);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Emits an event when time of interest changes", function () {
|
||||||
|
expect(eventListener).not.toHaveBeenCalled();
|
||||||
|
api.on("timeOfInterest", eventListener);
|
||||||
|
api.timeOfInterest(toi);
|
||||||
|
expect(eventListener).toHaveBeenCalledWith(toi);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Emits an event when bounds change", function () {
|
||||||
|
expect(eventListener).not.toHaveBeenCalled();
|
||||||
|
api.on("bounds", eventListener);
|
||||||
|
api.bounds(bounds);
|
||||||
|
expect(eventListener).toHaveBeenCalledWith(bounds, false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("If bounds are set and TOI lies inside them, do not change TOI", function () {
|
||||||
|
api.timeOfInterest(6);
|
||||||
|
api.bounds({
|
||||||
|
start: 1,
|
||||||
|
end: 10
|
||||||
|
});
|
||||||
|
expect(api.timeOfInterest()).toEqual(6);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("If bounds are set and TOI lies outside them, reset TOI", function () {
|
||||||
|
api.timeOfInterest(11);
|
||||||
|
api.bounds({
|
||||||
|
start: 1,
|
||||||
|
end: 10
|
||||||
|
});
|
||||||
|
expect(api.timeOfInterest()).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Maintains delta during tick", function () {
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Allows registered time system to be activated", function () {
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Allows a registered tick source to be activated", function () {
|
||||||
|
const mockTickSource = jasmine.createSpyObj("mockTickSource", [
|
||||||
|
"on",
|
||||||
|
"off",
|
||||||
|
"currentValue"
|
||||||
|
]);
|
||||||
|
mockTickSource.key = 'mockTickSource';
|
||||||
|
});
|
||||||
|
|
||||||
|
describe(" when enabling a tick source", function () {
|
||||||
|
let mockTickSource;
|
||||||
|
let anotherMockTickSource;
|
||||||
|
const mockOffsets = {
|
||||||
|
start: 0,
|
||||||
|
end: 1
|
||||||
|
};
|
||||||
|
|
||||||
beforeEach(function () {
|
beforeEach(function () {
|
||||||
api = new TimeAPI();
|
mockTickSource = jasmine.createSpyObj("clock", [
|
||||||
timeSystemKey = "timeSystemKey";
|
|
||||||
timeSystem = {key: timeSystemKey};
|
|
||||||
clockKey = "someClockKey";
|
|
||||||
clock = jasmine.createSpyObj("clock", [
|
|
||||||
"on",
|
"on",
|
||||||
"off",
|
"off",
|
||||||
"currentValue"
|
"currentValue"
|
||||||
]);
|
]);
|
||||||
clock.currentValue.and.returnValue(100);
|
mockTickSource.currentValue.and.returnValue(10);
|
||||||
clock.key = clockKey;
|
|
||||||
bounds = {
|
|
||||||
start: 0,
|
|
||||||
end: 1
|
|
||||||
};
|
|
||||||
eventListener = jasmine.createSpy("eventListener");
|
|
||||||
toi = 111;
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Supports setting and querying of time of interest", function () {
|
|
||||||
expect(api.timeOfInterest()).not.toBe(toi);
|
|
||||||
api.timeOfInterest(toi);
|
|
||||||
expect(api.timeOfInterest()).toBe(toi);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Allows setting of valid bounds", function () {
|
|
||||||
bounds = {
|
|
||||||
start: 0,
|
|
||||||
end: 1
|
|
||||||
};
|
|
||||||
expect(api.bounds()).not.toBe(bounds);
|
|
||||||
expect(api.bounds.bind(api, bounds)).not.toThrow();
|
|
||||||
expect(api.bounds()).toEqual(bounds);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Disallows setting of invalid bounds", function () {
|
|
||||||
bounds = {
|
|
||||||
start: 1,
|
|
||||||
end: 0
|
|
||||||
};
|
|
||||||
expect(api.bounds()).not.toEqual(bounds);
|
|
||||||
expect(api.bounds.bind(api, bounds)).toThrow();
|
|
||||||
expect(api.bounds()).not.toEqual(bounds);
|
|
||||||
|
|
||||||
bounds = {start: 1};
|
|
||||||
expect(api.bounds()).not.toEqual(bounds);
|
|
||||||
expect(api.bounds.bind(api, bounds)).toThrow();
|
|
||||||
expect(api.bounds()).not.toEqual(bounds);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Allows setting of previously registered time system with bounds", function () {
|
|
||||||
api.addTimeSystem(timeSystem);
|
|
||||||
expect(api.timeSystem()).not.toBe(timeSystem);
|
|
||||||
expect(function () {
|
|
||||||
api.timeSystem(timeSystem, bounds);
|
|
||||||
}).not.toThrow();
|
|
||||||
expect(api.timeSystem()).toBe(timeSystem);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Disallows setting of time system without bounds", function () {
|
|
||||||
api.addTimeSystem(timeSystem);
|
|
||||||
expect(api.timeSystem()).not.toBe(timeSystem);
|
|
||||||
expect(function () {
|
|
||||||
api.timeSystem(timeSystemKey);
|
|
||||||
}).toThrow();
|
|
||||||
expect(api.timeSystem()).not.toBe(timeSystem);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("allows setting of timesystem without bounds with clock", function () {
|
|
||||||
api.addTimeSystem(timeSystem);
|
|
||||||
api.addClock(clock);
|
|
||||||
api.clock(clockKey, {
|
|
||||||
start: 0,
|
|
||||||
end: 1
|
|
||||||
});
|
|
||||||
expect(api.timeSystem()).not.toBe(timeSystem);
|
|
||||||
expect(function () {
|
|
||||||
api.timeSystem(timeSystemKey);
|
|
||||||
}).not.toThrow();
|
|
||||||
expect(api.timeSystem()).toBe(timeSystem);
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Emits an event when time system changes", function () {
|
|
||||||
api.addTimeSystem(timeSystem);
|
|
||||||
expect(eventListener).not.toHaveBeenCalled();
|
|
||||||
api.on("timeSystem", eventListener);
|
|
||||||
api.timeSystem(timeSystemKey, bounds);
|
|
||||||
expect(eventListener).toHaveBeenCalledWith(timeSystem);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Emits an event when time of interest changes", function () {
|
|
||||||
expect(eventListener).not.toHaveBeenCalled();
|
|
||||||
api.on("timeOfInterest", eventListener);
|
|
||||||
api.timeOfInterest(toi);
|
|
||||||
expect(eventListener).toHaveBeenCalledWith(toi);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Emits an event when bounds change", function () {
|
|
||||||
expect(eventListener).not.toHaveBeenCalled();
|
|
||||||
api.on("bounds", eventListener);
|
|
||||||
api.bounds(bounds);
|
|
||||||
expect(eventListener).toHaveBeenCalledWith(bounds, false);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("If bounds are set and TOI lies inside them, do not change TOI", function () {
|
|
||||||
api.timeOfInterest(6);
|
|
||||||
api.bounds({
|
|
||||||
start: 1,
|
|
||||||
end: 10
|
|
||||||
});
|
|
||||||
expect(api.timeOfInterest()).toEqual(6);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("If bounds are set and TOI lies outside them, reset TOI", function () {
|
|
||||||
api.timeOfInterest(11);
|
|
||||||
api.bounds({
|
|
||||||
start: 1,
|
|
||||||
end: 10
|
|
||||||
});
|
|
||||||
expect(api.timeOfInterest()).toBeUndefined();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Maintains delta during tick", function () {
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Allows registered time system to be activated", function () {
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Allows a registered tick source to be activated", function () {
|
|
||||||
const mockTickSource = jasmine.createSpyObj("mockTickSource", [
|
|
||||||
"on",
|
|
||||||
"off",
|
|
||||||
"currentValue"
|
|
||||||
]);
|
|
||||||
mockTickSource.key = 'mockTickSource';
|
|
||||||
});
|
|
||||||
|
|
||||||
describe(" when enabling a tick source", function () {
|
|
||||||
let mockTickSource;
|
|
||||||
let anotherMockTickSource;
|
|
||||||
const mockOffsets = {
|
|
||||||
start: 0,
|
|
||||||
end: 1
|
|
||||||
};
|
|
||||||
|
|
||||||
beforeEach(function () {
|
|
||||||
mockTickSource = jasmine.createSpyObj("clock", [
|
|
||||||
"on",
|
|
||||||
"off",
|
|
||||||
"currentValue"
|
|
||||||
]);
|
|
||||||
mockTickSource.currentValue.and.returnValue(10);
|
|
||||||
mockTickSource.key = "mts";
|
|
||||||
|
|
||||||
anotherMockTickSource = jasmine.createSpyObj("clock", [
|
|
||||||
"on",
|
|
||||||
"off",
|
|
||||||
"currentValue"
|
|
||||||
]);
|
|
||||||
anotherMockTickSource.key = "amts";
|
|
||||||
anotherMockTickSource.currentValue.and.returnValue(10);
|
|
||||||
|
|
||||||
api.addClock(mockTickSource);
|
|
||||||
api.addClock(anotherMockTickSource);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("sets bounds based on current value", function () {
|
|
||||||
api.clock("mts", mockOffsets);
|
|
||||||
expect(api.bounds()).toEqual({
|
|
||||||
start: 10,
|
|
||||||
end: 11
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
it("a new tick listener is registered", function () {
|
|
||||||
api.clock("mts", mockOffsets);
|
|
||||||
expect(mockTickSource.on).toHaveBeenCalledWith("tick", jasmine.any(Function));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("listener of existing tick source is reregistered", function () {
|
|
||||||
api.clock("mts", mockOffsets);
|
|
||||||
api.clock("amts", mockOffsets);
|
|
||||||
expect(mockTickSource.off).toHaveBeenCalledWith("tick", jasmine.any(Function));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("Allows the active clock to be set and unset", function () {
|
|
||||||
expect(api.clock()).toBeUndefined();
|
|
||||||
api.clock("mts", mockOffsets);
|
|
||||||
expect(api.clock()).toBeDefined();
|
|
||||||
api.stopClock();
|
|
||||||
expect(api.clock()).toBeUndefined();
|
|
||||||
});
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
it("on tick, observes offsets, and indicates tick in bounds callback", function () {
|
|
||||||
const mockTickSource = jasmine.createSpyObj("clock", [
|
|
||||||
"on",
|
|
||||||
"off",
|
|
||||||
"currentValue"
|
|
||||||
]);
|
|
||||||
mockTickSource.currentValue.and.returnValue(100);
|
|
||||||
let tickCallback;
|
|
||||||
const boundsCallback = jasmine.createSpy("boundsCallback");
|
|
||||||
const clockOffsets = {
|
|
||||||
start: -100,
|
|
||||||
end: 100
|
|
||||||
};
|
|
||||||
mockTickSource.key = "mts";
|
mockTickSource.key = "mts";
|
||||||
|
|
||||||
|
anotherMockTickSource = jasmine.createSpyObj("clock", [
|
||||||
|
"on",
|
||||||
|
"off",
|
||||||
|
"currentValue"
|
||||||
|
]);
|
||||||
|
anotherMockTickSource.key = "amts";
|
||||||
|
anotherMockTickSource.currentValue.and.returnValue(10);
|
||||||
|
|
||||||
api.addClock(mockTickSource);
|
api.addClock(mockTickSource);
|
||||||
api.clock("mts", clockOffsets);
|
api.addClock(anotherMockTickSource);
|
||||||
|
|
||||||
api.on("bounds", boundsCallback);
|
|
||||||
|
|
||||||
tickCallback = mockTickSource.on.calls.mostRecent().args[1];
|
|
||||||
tickCallback(1000);
|
|
||||||
expect(boundsCallback).toHaveBeenCalledWith({
|
|
||||||
start: 900,
|
|
||||||
end: 1100
|
|
||||||
}, true);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("sets bounds based on current value", function () {
|
||||||
|
api.clock("mts", mockOffsets);
|
||||||
|
expect(api.bounds()).toEqual({
|
||||||
|
start: 10,
|
||||||
|
end: 11
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("a new tick listener is registered", function () {
|
||||||
|
api.clock("mts", mockOffsets);
|
||||||
|
expect(mockTickSource.on).toHaveBeenCalledWith("tick", jasmine.any(Function));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("listener of existing tick source is reregistered", function () {
|
||||||
|
api.clock("mts", mockOffsets);
|
||||||
|
api.clock("amts", mockOffsets);
|
||||||
|
expect(mockTickSource.off).toHaveBeenCalledWith("tick", jasmine.any(Function));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Allows the active clock to be set and unset", function () {
|
||||||
|
expect(api.clock()).toBeUndefined();
|
||||||
|
api.clock("mts", mockOffsets);
|
||||||
|
expect(api.clock()).toBeDefined();
|
||||||
|
api.stopClock();
|
||||||
|
expect(api.clock()).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
||||||
|
|
||||||
|
it("on tick, observes offsets, and indicates tick in bounds callback", function () {
|
||||||
|
const mockTickSource = jasmine.createSpyObj("clock", [
|
||||||
|
"on",
|
||||||
|
"off",
|
||||||
|
"currentValue"
|
||||||
|
]);
|
||||||
|
mockTickSource.currentValue.and.returnValue(100);
|
||||||
|
let tickCallback;
|
||||||
|
const boundsCallback = jasmine.createSpy("boundsCallback");
|
||||||
|
const clockOffsets = {
|
||||||
|
start: -100,
|
||||||
|
end: 100
|
||||||
|
};
|
||||||
|
mockTickSource.key = "mts";
|
||||||
|
|
||||||
|
api.addClock(mockTickSource);
|
||||||
|
api.clock("mts", clockOffsets);
|
||||||
|
|
||||||
|
api.on("bounds", boundsCallback);
|
||||||
|
|
||||||
|
tickCallback = mockTickSource.on.calls.mostRecent().args[1];
|
||||||
|
tickCallback(1000);
|
||||||
|
expect(boundsCallback).toHaveBeenCalledWith({
|
||||||
|
start: 900,
|
||||||
|
end: 1100
|
||||||
|
}, true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
360
src/api/time/TimeContext.js
Normal file
360
src/api/time/TimeContext.js
Normal file
@ -0,0 +1,360 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import EventEmitter from 'EventEmitter';
|
||||||
|
|
||||||
|
class TimeContext extends EventEmitter {
|
||||||
|
constructor() {
|
||||||
|
super();
|
||||||
|
|
||||||
|
//The Time System
|
||||||
|
this.timeSystems = new Map();
|
||||||
|
|
||||||
|
this.system = undefined;
|
||||||
|
|
||||||
|
this.clocks = new Map();
|
||||||
|
|
||||||
|
this.boundsVal = {
|
||||||
|
start: undefined,
|
||||||
|
end: undefined
|
||||||
|
};
|
||||||
|
|
||||||
|
this.activeClock = undefined;
|
||||||
|
this.offsets = undefined;
|
||||||
|
|
||||||
|
this.tick = this.tick.bind(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get or set the time system of the TimeAPI.
|
||||||
|
* @param {TimeSystem | string} timeSystem
|
||||||
|
* @param {module:openmct.TimeAPI~TimeConductorBounds} bounds
|
||||||
|
* @fires module:openmct.TimeAPI~timeSystem
|
||||||
|
* @returns {TimeSystem} The currently applied time system
|
||||||
|
* @memberof module:openmct.TimeAPI#
|
||||||
|
* @method timeSystem
|
||||||
|
*/
|
||||||
|
timeSystem(timeSystemOrKey, bounds) {
|
||||||
|
if (arguments.length >= 1) {
|
||||||
|
if (arguments.length === 1 && !this.activeClock) {
|
||||||
|
throw new Error(
|
||||||
|
"Must specify bounds when changing time system without "
|
||||||
|
+ "an active clock."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let timeSystem;
|
||||||
|
|
||||||
|
if (timeSystemOrKey === undefined) {
|
||||||
|
throw "Please provide a time system";
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof timeSystemOrKey === 'string') {
|
||||||
|
timeSystem = this.timeSystems.get(timeSystemOrKey);
|
||||||
|
|
||||||
|
if (timeSystem === undefined) {
|
||||||
|
throw "Unknown time system " + timeSystemOrKey + ". Has it been registered with 'addTimeSystem'?";
|
||||||
|
}
|
||||||
|
} else if (typeof timeSystemOrKey === 'object') {
|
||||||
|
timeSystem = timeSystemOrKey;
|
||||||
|
|
||||||
|
if (!this.timeSystems.has(timeSystem.key)) {
|
||||||
|
throw "Unknown time system " + timeSystem.key + ". Has it been registered with 'addTimeSystem'?";
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw "Attempt to set invalid time system in Time API. Please provide a previously registered time system object or key";
|
||||||
|
}
|
||||||
|
|
||||||
|
this.system = timeSystem;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time system used by the time
|
||||||
|
* conductor has changed. A change in Time System will always be
|
||||||
|
* followed by a bounds event specifying new query bounds.
|
||||||
|
*
|
||||||
|
* @event module:openmct.TimeAPI~timeSystem
|
||||||
|
* @property {TimeSystem} The value of the currently applied
|
||||||
|
* Time System
|
||||||
|
* */
|
||||||
|
this.emit('timeSystem', this.system);
|
||||||
|
if (bounds) {
|
||||||
|
this.bounds(bounds);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.system;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clock offsets are used to calculate temporal bounds when the system is
|
||||||
|
* ticking on a clock source.
|
||||||
|
*
|
||||||
|
* @typedef {object} ValidationResult
|
||||||
|
* @property {boolean} valid Result of the validation - true or false.
|
||||||
|
* @property {string} message An error message if valid is false.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* Validate the given bounds. This can be used for pre-validation of bounds,
|
||||||
|
* for example by views validating user inputs.
|
||||||
|
* @param {TimeBounds} bounds The start and end time of the conductor.
|
||||||
|
* @returns {ValidationResult} A validation error, or true if valid
|
||||||
|
* @memberof module:openmct.TimeAPI#
|
||||||
|
* @method validateBounds
|
||||||
|
*/
|
||||||
|
validateBounds(bounds) {
|
||||||
|
if ((bounds.start === undefined)
|
||||||
|
|| (bounds.end === undefined)
|
||||||
|
|| isNaN(bounds.start)
|
||||||
|
|| isNaN(bounds.end)
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
valid: false,
|
||||||
|
message: "Start and end must be specified as integer values"
|
||||||
|
};
|
||||||
|
} else if (bounds.start > bounds.end) {
|
||||||
|
return {
|
||||||
|
valid: false,
|
||||||
|
message: "Specified start date exceeds end bound"
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
valid: true,
|
||||||
|
message: ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get or set the start and end time of the time conductor. Basic validation
|
||||||
|
* of bounds is performed.
|
||||||
|
*
|
||||||
|
* @param {module:openmct.TimeAPI~TimeConductorBounds} newBounds
|
||||||
|
* @throws {Error} Validation error
|
||||||
|
* @fires module:openmct.TimeAPI~bounds
|
||||||
|
* @returns {module:openmct.TimeAPI~TimeConductorBounds}
|
||||||
|
* @memberof module:openmct.TimeAPI#
|
||||||
|
* @method bounds
|
||||||
|
*/
|
||||||
|
bounds(newBounds) {
|
||||||
|
if (arguments.length > 0) {
|
||||||
|
const validationResult = this.validateBounds(newBounds);
|
||||||
|
if (validationResult.valid !== true) {
|
||||||
|
throw new Error(validationResult.message);
|
||||||
|
}
|
||||||
|
|
||||||
|
//Create a copy to avoid direct mutation of conductor bounds
|
||||||
|
this.boundsVal = JSON.parse(JSON.stringify(newBounds));
|
||||||
|
/**
|
||||||
|
* The start time, end time, or both have been updated.
|
||||||
|
* @event bounds
|
||||||
|
* @memberof module:openmct.TimeAPI~
|
||||||
|
* @property {TimeConductorBounds} bounds The newly updated bounds
|
||||||
|
* @property {boolean} [tick] `true` if the bounds update was due to
|
||||||
|
* a "tick" event (ie. was an automatic update), false otherwise.
|
||||||
|
*/
|
||||||
|
this.emit('bounds', this.boundsVal, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
//Return a copy to prevent direct mutation of time conductor bounds.
|
||||||
|
return JSON.parse(JSON.stringify(this.boundsVal));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validate the given offsets. This can be used for pre-validation of
|
||||||
|
* offsets, for example by views validating user inputs.
|
||||||
|
* @param {ClockOffsets} offsets The start and end offsets from a 'now' value.
|
||||||
|
* @returns { ValidationResult } A validation error, and true/false if valid or not
|
||||||
|
* @memberof module:openmct.TimeAPI#
|
||||||
|
* @method validateOffsets
|
||||||
|
*/
|
||||||
|
validateOffsets(offsets) {
|
||||||
|
if ((offsets.start === undefined)
|
||||||
|
|| (offsets.end === undefined)
|
||||||
|
|| isNaN(offsets.start)
|
||||||
|
|| isNaN(offsets.end)
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
valid: false,
|
||||||
|
message: "Start and end offsets must be specified as integer values"
|
||||||
|
};
|
||||||
|
} else if (offsets.start >= offsets.end) {
|
||||||
|
return {
|
||||||
|
valid: false,
|
||||||
|
message: "Specified start offset must be < end offset"
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
valid: true,
|
||||||
|
message: ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {Object} TimeBounds
|
||||||
|
* @property {number} start The start time displayed by the time conductor
|
||||||
|
* in ms since epoch. Epoch determined by currently active time system
|
||||||
|
* @property {number} end The end time displayed by the time conductor in ms
|
||||||
|
* since epoch.
|
||||||
|
* @memberof module:openmct.TimeAPI~
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clock offsets are used to calculate temporal bounds when the system is
|
||||||
|
* ticking on a clock source.
|
||||||
|
*
|
||||||
|
* @typedef {object} ClockOffsets
|
||||||
|
* @property {number} start A time span relative to the current value of the
|
||||||
|
* ticking clock, from which start bounds will be calculated. This value must
|
||||||
|
* be < 0. When a clock is active, bounds will be calculated automatically
|
||||||
|
* based on the value provided by the clock, and the defined clock offsets.
|
||||||
|
* @property {number} end A time span relative to the current value of the
|
||||||
|
* ticking clock, from which end bounds will be calculated. This value must
|
||||||
|
* be >= 0.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* Get or set the currently applied clock offsets. If no parameter is provided,
|
||||||
|
* the current value will be returned. If provided, the new value will be
|
||||||
|
* used as the new clock offsets.
|
||||||
|
* @param {ClockOffsets} offsets
|
||||||
|
* @returns {ClockOffsets}
|
||||||
|
*/
|
||||||
|
clockOffsets(offsets) {
|
||||||
|
if (arguments.length > 0) {
|
||||||
|
|
||||||
|
const validationResult = this.validateOffsets(offsets);
|
||||||
|
if (validationResult.valid !== true) {
|
||||||
|
throw new Error(validationResult.message);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.offsets = offsets;
|
||||||
|
|
||||||
|
const currentValue = this.activeClock.currentValue();
|
||||||
|
const newBounds = {
|
||||||
|
start: currentValue + offsets.start,
|
||||||
|
end: currentValue + offsets.end
|
||||||
|
};
|
||||||
|
|
||||||
|
this.bounds(newBounds);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Event that is triggered when clock offsets change.
|
||||||
|
* @event clockOffsets
|
||||||
|
* @memberof module:openmct.TimeAPI~
|
||||||
|
* @property {ClockOffsets} clockOffsets The newly activated clock
|
||||||
|
* offsets.
|
||||||
|
*/
|
||||||
|
this.emit("clockOffsets", offsets);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.offsets;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stop the currently active clock from ticking, and unset it. This will
|
||||||
|
* revert all views to showing a static time frame defined by the current
|
||||||
|
* bounds.
|
||||||
|
*/
|
||||||
|
stopClock() {
|
||||||
|
if (this.activeClock) {
|
||||||
|
this.clock(undefined, undefined);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the active clock. Tick source will be immediately subscribed to
|
||||||
|
* and ticking will begin. Offsets from 'now' must also be provided. A clock
|
||||||
|
* can be unset by calling {@link stopClock}.
|
||||||
|
*
|
||||||
|
* @param {Clock || string} keyOrClock The clock to activate, or its key
|
||||||
|
* @param {ClockOffsets} offsets on each tick these will be used to calculate
|
||||||
|
* the start and end bounds. This maintains a sliding time window of a fixed
|
||||||
|
* width that automatically updates.
|
||||||
|
* @fires module:openmct.TimeAPI~clock
|
||||||
|
* @return {Clock} the currently active clock;
|
||||||
|
*/
|
||||||
|
clock(keyOrClock, offsets) {
|
||||||
|
if (arguments.length === 2) {
|
||||||
|
let clock;
|
||||||
|
|
||||||
|
if (typeof keyOrClock === 'string') {
|
||||||
|
clock = this.clocks.get(keyOrClock);
|
||||||
|
if (clock === undefined) {
|
||||||
|
throw "Unknown clock '" + keyOrClock + "'. Has it been registered with 'addClock'?";
|
||||||
|
}
|
||||||
|
} else if (typeof keyOrClock === 'object') {
|
||||||
|
clock = keyOrClock;
|
||||||
|
if (!this.clocks.has(clock.key)) {
|
||||||
|
throw "Unknown clock '" + keyOrClock.key + "'. Has it been registered with 'addClock'?";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const previousClock = this.activeClock;
|
||||||
|
if (previousClock !== undefined) {
|
||||||
|
previousClock.off("tick", this.tick);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.activeClock = clock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The active clock has changed. Clock can be unset by calling {@link stopClock}
|
||||||
|
* @event clock
|
||||||
|
* @memberof module:openmct.TimeAPI~
|
||||||
|
* @property {Clock} clock The newly activated clock, or undefined
|
||||||
|
* if the system is no longer following a clock source
|
||||||
|
*/
|
||||||
|
this.emit("clock", this.activeClock);
|
||||||
|
|
||||||
|
if (this.activeClock !== undefined) {
|
||||||
|
this.clockOffsets(offsets);
|
||||||
|
this.activeClock.on("tick", this.tick);
|
||||||
|
}
|
||||||
|
|
||||||
|
} else if (arguments.length === 1) {
|
||||||
|
throw "When setting the clock, clock offsets must also be provided";
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.activeClock;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update bounds based on provided time and current offsets
|
||||||
|
* @param {number} timestamp A time from which bounds will be calculated
|
||||||
|
* using current offsets.
|
||||||
|
*/
|
||||||
|
tick(timestamp) {
|
||||||
|
if (!this.activeClock) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const newBounds = {
|
||||||
|
start: timestamp + this.offsets.start,
|
||||||
|
end: timestamp + this.offsets.end
|
||||||
|
};
|
||||||
|
|
||||||
|
this.boundsVal = newBounds;
|
||||||
|
this.emit('bounds', this.boundsVal, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default TimeContext;
|
155
src/api/time/independentTimeAPISpec.js
Normal file
155
src/api/time/independentTimeAPISpec.js
Normal file
@ -0,0 +1,155 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import TimeAPI from "./TimeAPI";
|
||||||
|
import {createOpenMct} from "utils/testing";
|
||||||
|
describe("The Independent Time API", function () {
|
||||||
|
let api;
|
||||||
|
let domainObjectKey;
|
||||||
|
let clockKey;
|
||||||
|
let clock;
|
||||||
|
let bounds;
|
||||||
|
let independentBounds;
|
||||||
|
let eventListener;
|
||||||
|
let openmct;
|
||||||
|
|
||||||
|
beforeEach(function () {
|
||||||
|
openmct = createOpenMct();
|
||||||
|
api = new TimeAPI(openmct);
|
||||||
|
clockKey = "someClockKey";
|
||||||
|
clock = jasmine.createSpyObj("clock", [
|
||||||
|
"on",
|
||||||
|
"off",
|
||||||
|
"currentValue"
|
||||||
|
]);
|
||||||
|
clock.currentValue.and.returnValue(100);
|
||||||
|
clock.key = clockKey;
|
||||||
|
api.addClock(clock);
|
||||||
|
domainObjectKey = 'test-key';
|
||||||
|
bounds = {
|
||||||
|
start: 0,
|
||||||
|
end: 1
|
||||||
|
};
|
||||||
|
api.bounds(bounds);
|
||||||
|
independentBounds = {
|
||||||
|
start: 10,
|
||||||
|
end: 11
|
||||||
|
};
|
||||||
|
eventListener = jasmine.createSpy("eventListener");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Creates an independent time context", () => {
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getIndependentContext(domainObjectKey);
|
||||||
|
expect(timeContext.bounds()).toEqual(independentBounds);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Gets an independent time context given the objectPath", () => {
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getContextForView([{
|
||||||
|
identifier: {
|
||||||
|
namespace: '',
|
||||||
|
key: 'blah'
|
||||||
|
}
|
||||||
|
}, { identifier: domainObjectKey }]);
|
||||||
|
expect(timeContext.bounds()).toEqual(independentBounds);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("defaults to the global time context given the objectPath", () => {
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getContextForView([{
|
||||||
|
identifier: {
|
||||||
|
namespace: '',
|
||||||
|
key: 'blah'
|
||||||
|
}
|
||||||
|
}]);
|
||||||
|
expect(timeContext.bounds()).toEqual(bounds);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Allows setting of valid bounds", function () {
|
||||||
|
bounds = {
|
||||||
|
start: 0,
|
||||||
|
end: 1
|
||||||
|
};
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getContextForView([{identifier: domainObjectKey}]);
|
||||||
|
expect(timeContext.bounds()).not.toEqual(bounds);
|
||||||
|
timeContext.bounds(bounds);
|
||||||
|
expect(timeContext.bounds()).toEqual(bounds);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Disallows setting of invalid bounds", function () {
|
||||||
|
bounds = {
|
||||||
|
start: 1,
|
||||||
|
end: 0
|
||||||
|
};
|
||||||
|
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getContextForView([{identifier: domainObjectKey}]);
|
||||||
|
expect(timeContext.bounds()).not.toBe(bounds);
|
||||||
|
|
||||||
|
expect(timeContext.bounds.bind(timeContext, bounds)).toThrow();
|
||||||
|
expect(timeContext.bounds()).not.toEqual(bounds);
|
||||||
|
|
||||||
|
bounds = {start: 1};
|
||||||
|
expect(timeContext.bounds()).not.toEqual(bounds);
|
||||||
|
expect(timeContext.bounds.bind(timeContext, bounds)).toThrow();
|
||||||
|
expect(timeContext.bounds()).not.toEqual(bounds);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("Emits an event when bounds change", function () {
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getContextForView([{identifier: domainObjectKey}]);
|
||||||
|
expect(eventListener).not.toHaveBeenCalled();
|
||||||
|
timeContext.on('bounds', eventListener);
|
||||||
|
timeContext.bounds(bounds);
|
||||||
|
expect(eventListener).toHaveBeenCalledWith(bounds, false);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe(" when using real time clock", function () {
|
||||||
|
const mockOffsets = {
|
||||||
|
start: 10,
|
||||||
|
end: 11
|
||||||
|
};
|
||||||
|
|
||||||
|
it("Emits an event when bounds change based on current value", function () {
|
||||||
|
let destroyTimeContext = api.addIndependentContext(domainObjectKey, independentBounds);
|
||||||
|
let timeContext = api.getContextForView([{identifier: domainObjectKey}]);
|
||||||
|
expect(eventListener).not.toHaveBeenCalled();
|
||||||
|
timeContext.clock('someClockKey', mockOffsets);
|
||||||
|
timeContext.on('bounds', eventListener);
|
||||||
|
timeContext.tick(10);
|
||||||
|
expect(eventListener).toHaveBeenCalledWith({
|
||||||
|
start: 20,
|
||||||
|
end: 21
|
||||||
|
}, true);
|
||||||
|
destroyTimeContext();
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
||||||
|
});
|
@ -78,6 +78,9 @@ class ImageExporter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return html2canvas(element, {
|
return html2canvas(element, {
|
||||||
|
useCORS: true,
|
||||||
|
allowTaint: true,
|
||||||
|
logging: false,
|
||||||
onclone: function (document) {
|
onclone: function (document) {
|
||||||
if (className) {
|
if (className) {
|
||||||
const clonedElement = document.getElementById(exportId);
|
const clonedElement = document.getElementById(exportId);
|
||||||
@ -87,7 +90,7 @@ class ImageExporter {
|
|||||||
element.id = oldId;
|
element.id = oldId;
|
||||||
},
|
},
|
||||||
removeContainer: true // Set to false to debug what html2canvas renders
|
removeContainer: true // Set to false to debug what html2canvas renders
|
||||||
}).then(function (canvas) {
|
}).then(canvas => {
|
||||||
dialog.dismiss();
|
dialog.dismiss();
|
||||||
|
|
||||||
return new Promise(function (resolve, reject) {
|
return new Promise(function (resolve, reject) {
|
||||||
@ -102,9 +105,10 @@ class ImageExporter {
|
|||||||
|
|
||||||
return canvas.toBlob(blob => resolve({ blob }), mimeType);
|
return canvas.toBlob(blob => resolve({ blob }), mimeType);
|
||||||
});
|
});
|
||||||
}, function (error) {
|
}).catch(error => {
|
||||||
console.log('error capturing image', error);
|
|
||||||
dialog.dismiss();
|
dialog.dismiss();
|
||||||
|
|
||||||
|
console.error('error capturing image', error);
|
||||||
const errorDialog = overlays.dialog({
|
const errorDialog = overlays.dialog({
|
||||||
iconClass: 'error',
|
iconClass: 'error',
|
||||||
message: 'Image was not captured successfully!',
|
message: 'Image was not captured successfully!',
|
||||||
|
32
src/plugins/DeviceClassifier/plugin.js
Normal file
32
src/plugins/DeviceClassifier/plugin.js
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
import Agent from "../../utils/agent/Agent";
|
||||||
|
import DeviceClassifier from "./src/DeviceClassifier";
|
||||||
|
|
||||||
|
export default () => {
|
||||||
|
return (openmct) => {
|
||||||
|
openmct.on("start", () => {
|
||||||
|
const agent = new Agent(window);
|
||||||
|
DeviceClassifier(agent, window.document);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
};
|
72
src/plugins/DeviceClassifier/src/DeviceClassifier.js
Normal file
72
src/plugins/DeviceClassifier/src/DeviceClassifier.js
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs at application startup and adds a subset of the following
|
||||||
|
* CSS classes to the body of the document, depending on device
|
||||||
|
* attributes:
|
||||||
|
*
|
||||||
|
* * `mobile`: Phones or tablets.
|
||||||
|
* * `phone`: Phones specifically.
|
||||||
|
* * `tablet`: Tablets specifically.
|
||||||
|
* * `desktop`: Non-mobile devices.
|
||||||
|
* * `portrait`: Devices in a portrait-style orientation.
|
||||||
|
* * `landscape`: Devices in a landscape-style orientation.
|
||||||
|
* * `touch`: Device supports touch events.
|
||||||
|
*
|
||||||
|
* @param {utils/agent/Agent} agent
|
||||||
|
* the service used to examine the user agent
|
||||||
|
* @param document the HTML DOM document object
|
||||||
|
* @constructor
|
||||||
|
*/
|
||||||
|
import DeviceMatchers from "./DeviceMatchers";
|
||||||
|
|
||||||
|
export default (agent, document) => {
|
||||||
|
const body = document.body;
|
||||||
|
|
||||||
|
Object.keys(DeviceMatchers).forEach((key, index, array) => {
|
||||||
|
if (DeviceMatchers[key](agent)) {
|
||||||
|
body.classList.add(key);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (agent.isMobile()) {
|
||||||
|
const mediaQuery = window.matchMedia("(orientation: landscape)");
|
||||||
|
function eventHandler(event) {
|
||||||
|
console.log("changed");
|
||||||
|
if (event.matches) {
|
||||||
|
body.classList.remove("portrait");
|
||||||
|
body.classList.add("landscape");
|
||||||
|
} else {
|
||||||
|
body.classList.remove("landscape");
|
||||||
|
body.classList.add("portrait");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (mediaQuery.addEventListener) {
|
||||||
|
mediaQuery.addEventListener(`change`, eventHandler);
|
||||||
|
} else {
|
||||||
|
// Deprecated 'MediaQueryList' API, <Safari 14, IE, <Edge 16
|
||||||
|
mediaQuery.addListener(eventHandler);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
105
src/plugins/DeviceClassifier/src/DeviceClassifierSpec.js
Normal file
105
src/plugins/DeviceClassifier/src/DeviceClassifierSpec.js
Normal file
@ -0,0 +1,105 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
import DeviceClassifier from "./DeviceClassifier";
|
||||||
|
import DeviceMatchers from "./DeviceMatchers";
|
||||||
|
|
||||||
|
const AGENT_METHODS = [
|
||||||
|
"isMobile",
|
||||||
|
"isPhone",
|
||||||
|
"isTablet",
|
||||||
|
"isPortrait",
|
||||||
|
"isLandscape",
|
||||||
|
"isTouch"
|
||||||
|
];
|
||||||
|
const TEST_PERMUTATIONS = [
|
||||||
|
["isMobile", "isPhone", "isTouch", "isPortrait"],
|
||||||
|
["isMobile", "isPhone", "isTouch", "isLandscape"],
|
||||||
|
["isMobile", "isTablet", "isTouch", "isPortrait"],
|
||||||
|
["isMobile", "isTablet", "isTouch", "isLandscape"],
|
||||||
|
["isTouch"],
|
||||||
|
[]
|
||||||
|
];
|
||||||
|
|
||||||
|
describe("DeviceClassifier", function () {
|
||||||
|
let mockAgent;
|
||||||
|
let mockDocument;
|
||||||
|
let mockClassList;
|
||||||
|
|
||||||
|
beforeEach(function () {
|
||||||
|
mockAgent = jasmine.createSpyObj(
|
||||||
|
"agent",
|
||||||
|
AGENT_METHODS
|
||||||
|
);
|
||||||
|
|
||||||
|
mockClassList = jasmine.createSpyObj("classList", ["add"]);
|
||||||
|
|
||||||
|
mockDocument = jasmine.createSpyObj(
|
||||||
|
"document",
|
||||||
|
{},
|
||||||
|
{ body: { classList: mockClassList } }
|
||||||
|
);
|
||||||
|
|
||||||
|
AGENT_METHODS.forEach(function (m) {
|
||||||
|
mockAgent[m].and.returnValue(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
TEST_PERMUTATIONS.forEach(function (trueMethods) {
|
||||||
|
const summary =
|
||||||
|
trueMethods.length === 0
|
||||||
|
? "device has no detected characteristics"
|
||||||
|
: "device " + trueMethods.join(", ");
|
||||||
|
|
||||||
|
describe("when " + summary, function () {
|
||||||
|
beforeEach(function () {
|
||||||
|
trueMethods.forEach(function (m) {
|
||||||
|
mockAgent[m].and.returnValue(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
// eslint-disable-next-line no-new
|
||||||
|
DeviceClassifier(mockAgent, mockDocument);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("adds classes for matching, detected characteristics", function () {
|
||||||
|
Object.keys(DeviceMatchers)
|
||||||
|
.filter(function (m) {
|
||||||
|
return DeviceMatchers[m](mockAgent);
|
||||||
|
})
|
||||||
|
.forEach(function (key) {
|
||||||
|
expect(mockDocument.body.classList.add).toHaveBeenCalledWith(key);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not add classes for non-matching characteristics", function () {
|
||||||
|
Object.keys(DeviceMatchers)
|
||||||
|
.filter(function (m) {
|
||||||
|
return !DeviceMatchers[m](mockAgent);
|
||||||
|
})
|
||||||
|
.forEach(function (key) {
|
||||||
|
expect(mockDocument.body.classList.add).not.toHaveBeenCalledWith(
|
||||||
|
key
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
57
src/plugins/DeviceClassifier/src/DeviceMatchers.js
Normal file
57
src/plugins/DeviceClassifier/src/DeviceMatchers.js
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object containing key-value pairs, where keys are symbolic of
|
||||||
|
* device attributes, and values are functions that take the
|
||||||
|
* `agent` as inputs and return boolean values indicating
|
||||||
|
* whether or not the current device has these attributes.
|
||||||
|
*
|
||||||
|
* For internal use by the mobile support bundle.
|
||||||
|
*
|
||||||
|
* @memberof src/plugins/DeviceClassifier
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
|
||||||
|
export default {
|
||||||
|
mobile: function (agent) {
|
||||||
|
return agent.isMobile();
|
||||||
|
},
|
||||||
|
phone: function (agent) {
|
||||||
|
return agent.isPhone();
|
||||||
|
},
|
||||||
|
tablet: function (agent) {
|
||||||
|
return agent.isTablet();
|
||||||
|
},
|
||||||
|
desktop: function (agent) {
|
||||||
|
return !agent.isMobile();
|
||||||
|
},
|
||||||
|
portrait: function (agent) {
|
||||||
|
return agent.isPortrait();
|
||||||
|
},
|
||||||
|
landscape: function (agent) {
|
||||||
|
return agent.isLandscape();
|
||||||
|
},
|
||||||
|
touch: function (agent) {
|
||||||
|
return agent.isTouch();
|
||||||
|
}
|
||||||
|
};
|
65
src/plugins/DeviceClassifier/src/DeviceMatchersSpec.js
Normal file
65
src/plugins/DeviceClassifier/src/DeviceMatchersSpec.js
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
import DeviceMatchers from "./DeviceMatchers";
|
||||||
|
|
||||||
|
describe("DeviceMatchers", function () {
|
||||||
|
let mockAgent;
|
||||||
|
|
||||||
|
beforeEach(function () {
|
||||||
|
mockAgent = jasmine.createSpyObj("agent", [
|
||||||
|
"isMobile",
|
||||||
|
"isPhone",
|
||||||
|
"isTablet",
|
||||||
|
"isPortrait",
|
||||||
|
"isLandscape",
|
||||||
|
"isTouch"
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("detects when a device is a desktop device", function () {
|
||||||
|
mockAgent.isMobile.and.returnValue(false);
|
||||||
|
expect(DeviceMatchers.desktop(mockAgent)).toBe(true);
|
||||||
|
mockAgent.isMobile.and.returnValue(true);
|
||||||
|
expect(DeviceMatchers.desktop(mockAgent)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
function method(deviceType) {
|
||||||
|
return "is" + deviceType[0].toUpperCase() + deviceType.slice(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
[
|
||||||
|
"mobile",
|
||||||
|
"phone",
|
||||||
|
"tablet",
|
||||||
|
"landscape",
|
||||||
|
"portrait",
|
||||||
|
"landscape",
|
||||||
|
"touch"
|
||||||
|
].forEach(function (deviceType) {
|
||||||
|
it("detects when a device is a " + deviceType + " device", function () {
|
||||||
|
mockAgent[method(deviceType)].and.returnValue(true);
|
||||||
|
expect(DeviceMatchers[deviceType](mockAgent)).toBe(true);
|
||||||
|
mockAgent[method(deviceType)].and.returnValue(false);
|
||||||
|
expect(DeviceMatchers[deviceType](mockAgent)).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
78
src/plugins/clearData/ClearDataAction.js
Normal file
78
src/plugins/clearData/ClearDataAction.js
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
function inSelectionPath(openmct, domainObject) {
|
||||||
|
const domainObjectIdentifier = domainObject.identifier;
|
||||||
|
|
||||||
|
return openmct.selection.get().some(selectionPath => {
|
||||||
|
return selectionPath.some(objectInPath => {
|
||||||
|
const objectInPathIdentifier = objectInPath.context.item.identifier;
|
||||||
|
|
||||||
|
return openmct.objects.areIdsEqual(objectInPathIdentifier, domainObjectIdentifier);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export default class ClearDataAction {
|
||||||
|
constructor(openmct, appliesToObjects) {
|
||||||
|
this.name = 'Clear Data for Object';
|
||||||
|
this.key = 'clear-data-action';
|
||||||
|
this.description = 'Clears current data for object, unsubscribes and resubscribes to data';
|
||||||
|
this.cssClass = 'icon-clear-data';
|
||||||
|
|
||||||
|
this._openmct = openmct;
|
||||||
|
this._appliesToObjects = appliesToObjects;
|
||||||
|
}
|
||||||
|
invoke(objectPath) {
|
||||||
|
let domainObject = null;
|
||||||
|
if (objectPath) {
|
||||||
|
domainObject = objectPath[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
this._openmct.objectViews.emit('clearData', domainObject);
|
||||||
|
}
|
||||||
|
appliesTo(objectPath) {
|
||||||
|
if (!objectPath) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const contextualDomainObject = objectPath[0];
|
||||||
|
// first check to see if this action applies to this sort of object at all
|
||||||
|
const appliesToThisObject = this._appliesToObjects.some(type => {
|
||||||
|
return contextualDomainObject.type === type;
|
||||||
|
});
|
||||||
|
if (!appliesToThisObject) {
|
||||||
|
// we've selected something not applicable
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const objectInSelectionPath = inSelectionPath(this._openmct, contextualDomainObject);
|
||||||
|
if (objectInSelectionPath) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
// if this it doesn't match up, check to see if we're in a composition (i.e., layout)
|
||||||
|
const routerPath = this._openmct.router.path[0];
|
||||||
|
|
||||||
|
return routerPath.type === 'layout';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
define([
|
define([
|
||||||
'./components/globalClearIndicator.vue',
|
'./components/globalClearIndicator.vue',
|
||||||
'./clearDataAction',
|
'./ClearDataAction',
|
||||||
'vue'
|
'vue'
|
||||||
], function (
|
], function (
|
||||||
GlobaClearIndicator,
|
GlobaClearIndicator,
|
||||||
|
140
src/plugins/clearData/test/ClearDataActionSpec.js
Normal file
140
src/plugins/clearData/test/ClearDataActionSpec.js
Normal file
@ -0,0 +1,140 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import ClearDataActionPlugin from '../plugin.js';
|
||||||
|
import ClearDataAction from '../ClearDataAction.js';
|
||||||
|
|
||||||
|
describe('When the Clear Data Plugin is installed,', () => {
|
||||||
|
const mockObjectViews = jasmine.createSpyObj('objectViews', ['emit']);
|
||||||
|
const mockIndicatorProvider = jasmine.createSpyObj('indicators', ['add']);
|
||||||
|
const mockActionsProvider = jasmine.createSpyObj('actions', ['register']);
|
||||||
|
const goodMockSelectionPath = [[{
|
||||||
|
context: {
|
||||||
|
item: {
|
||||||
|
identifier: {
|
||||||
|
key: 'apple',
|
||||||
|
namespace: ''
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}]];
|
||||||
|
|
||||||
|
const openmct = {
|
||||||
|
objectViews: mockObjectViews,
|
||||||
|
indicators: mockIndicatorProvider,
|
||||||
|
actions: mockActionsProvider,
|
||||||
|
install: function (plugin) {
|
||||||
|
plugin(this);
|
||||||
|
},
|
||||||
|
selection: {
|
||||||
|
get: function () {
|
||||||
|
return goodMockSelectionPath;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
objects: {
|
||||||
|
areIdsEqual: function (obj1, obj2) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const mockObjectPath = [
|
||||||
|
{
|
||||||
|
name: 'mockObject1',
|
||||||
|
type: 'apple'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'mockObject2',
|
||||||
|
type: 'banana'
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
it('Global Clear Indicator is installed', () => {
|
||||||
|
openmct.install(ClearDataActionPlugin([]));
|
||||||
|
|
||||||
|
expect(mockIndicatorProvider.add).toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('Clear Data context menu action is installed', () => {
|
||||||
|
openmct.install(ClearDataActionPlugin([]));
|
||||||
|
|
||||||
|
expect(mockActionsProvider.register).toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('clear data action emits a clearData event when invoked', () => {
|
||||||
|
const action = new ClearDataAction(openmct);
|
||||||
|
|
||||||
|
action.invoke(mockObjectPath);
|
||||||
|
|
||||||
|
expect(mockObjectViews.emit).toHaveBeenCalledWith('clearData', mockObjectPath[0]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('clears data on applicable objects', () => {
|
||||||
|
let action = new ClearDataAction(openmct, ['apple']);
|
||||||
|
|
||||||
|
const actionApplies = action.appliesTo(mockObjectPath);
|
||||||
|
|
||||||
|
expect(actionApplies).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not clear data on inapplicable objects', () => {
|
||||||
|
let action = new ClearDataAction(openmct, ['pineapple']);
|
||||||
|
|
||||||
|
const actionApplies = action.appliesTo(mockObjectPath);
|
||||||
|
|
||||||
|
expect(actionApplies).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not clear data if not in the selection path and not a layout', () => {
|
||||||
|
openmct.objects = {
|
||||||
|
areIdsEqual: function (obj1, obj2) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
openmct.router = {
|
||||||
|
path: [{type: 'not-a-layout'}]
|
||||||
|
};
|
||||||
|
|
||||||
|
let action = new ClearDataAction(openmct, ['apple']);
|
||||||
|
|
||||||
|
const actionApplies = action.appliesTo(mockObjectPath);
|
||||||
|
|
||||||
|
expect(actionApplies).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does clear data if not in the selection path and is a layout', () => {
|
||||||
|
openmct.objects = {
|
||||||
|
areIdsEqual: function (obj1, obj2) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
openmct.router = {
|
||||||
|
path: [{type: 'layout'}]
|
||||||
|
};
|
||||||
|
|
||||||
|
let action = new ClearDataAction(openmct, ['apple']);
|
||||||
|
|
||||||
|
const actionApplies = action.appliesTo(mockObjectPath);
|
||||||
|
|
||||||
|
expect(actionApplies).toBe(true);
|
||||||
|
});
|
||||||
|
});
|
@ -1,64 +0,0 @@
|
|||||||
/*****************************************************************************
|
|
||||||
* Open MCT, Copyright (c) 2014-2021, United States Government
|
|
||||||
* 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.
|
|
||||||
*****************************************************************************/
|
|
||||||
|
|
||||||
import ClearDataActionPlugin from '../plugin.js';
|
|
||||||
import ClearDataAction from '../clearDataAction.js';
|
|
||||||
|
|
||||||
describe('When the Clear Data Plugin is installed,', function () {
|
|
||||||
const mockObjectViews = jasmine.createSpyObj('objectViews', ['emit']);
|
|
||||||
const mockIndicatorProvider = jasmine.createSpyObj('indicators', ['add']);
|
|
||||||
const mockActionsProvider = jasmine.createSpyObj('actions', ['register']);
|
|
||||||
|
|
||||||
const openmct = {
|
|
||||||
objectViews: mockObjectViews,
|
|
||||||
indicators: mockIndicatorProvider,
|
|
||||||
actions: mockActionsProvider,
|
|
||||||
install: function (plugin) {
|
|
||||||
plugin(this);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const mockObjectPath = [
|
|
||||||
{name: 'mockObject1'},
|
|
||||||
{name: 'mockObject2'}
|
|
||||||
];
|
|
||||||
|
|
||||||
it('Global Clear Indicator is installed', function () {
|
|
||||||
openmct.install(ClearDataActionPlugin([]));
|
|
||||||
|
|
||||||
expect(mockIndicatorProvider.add).toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('Clear Data context menu action is installed', function () {
|
|
||||||
openmct.install(ClearDataActionPlugin([]));
|
|
||||||
|
|
||||||
expect(mockActionsProvider.register).toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('clear data action emits a clearData event when invoked', function () {
|
|
||||||
let action = new ClearDataAction(openmct);
|
|
||||||
|
|
||||||
action.invoke(mockObjectPath);
|
|
||||||
|
|
||||||
expect(mockObjectViews.emit).toHaveBeenCalledWith('clearData', mockObjectPath[0]);
|
|
||||||
});
|
|
||||||
});
|
|
@ -19,40 +19,41 @@
|
|||||||
* this source code distribution or the Licensing information page available
|
* this source code distribution or the Licensing information page available
|
||||||
* at runtime from the About dialog for additional information.
|
* at runtime from the About dialog for additional information.
|
||||||
*****************************************************************************/
|
*****************************************************************************/
|
||||||
define(function () {
|
|
||||||
|
|
||||||
/**
|
import Clock from './components/Clock.vue';
|
||||||
* An object containing key-value pairs, where keys are symbolic of
|
import Vue from 'vue';
|
||||||
* device attributes, and values are functions that take the
|
|
||||||
* `agentService` as inputs and return boolean values indicating
|
export default function ClockViewProvider(openmct) {
|
||||||
* whether or not the current device has these attributes.
|
|
||||||
*
|
|
||||||
* For internal use by the mobile support bundle.
|
|
||||||
*
|
|
||||||
* @memberof platform/commonUI/mobile
|
|
||||||
* @private
|
|
||||||
*/
|
|
||||||
return {
|
return {
|
||||||
mobile: function (agentService) {
|
key: 'clock.view',
|
||||||
return agentService.isMobile();
|
name: 'Clock',
|
||||||
|
cssClass: 'icon-clock',
|
||||||
|
canView(domainObject) {
|
||||||
|
return domainObject.type === 'clock';
|
||||||
},
|
},
|
||||||
phone: function (agentService) {
|
|
||||||
return agentService.isPhone();
|
view: function (domainObject) {
|
||||||
},
|
let component;
|
||||||
tablet: function (agentService) {
|
|
||||||
return agentService.isTablet();
|
return {
|
||||||
},
|
show: function (element) {
|
||||||
desktop: function (agentService) {
|
component = new Vue({
|
||||||
return !agentService.isMobile();
|
el: element,
|
||||||
},
|
components: {
|
||||||
portrait: function (agentService) {
|
Clock
|
||||||
return agentService.isPortrait();
|
},
|
||||||
},
|
provide: {
|
||||||
landscape: function (agentService) {
|
openmct,
|
||||||
return agentService.isLandscape();
|
domainObject
|
||||||
},
|
},
|
||||||
touch: function (agentService) {
|
template: '<clock />'
|
||||||
return agentService.isTouch();
|
});
|
||||||
|
},
|
||||||
|
destroy: function () {
|
||||||
|
component.$destroy();
|
||||||
|
component = undefined;
|
||||||
|
}
|
||||||
|
};
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
});
|
}
|
99
src/plugins/clock/components/Clock.vue
Normal file
99
src/plugins/clock/components/Clock.vue
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
<!--
|
||||||
|
Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="l-angular-ov-wrapper">
|
||||||
|
<div class="u-contents">
|
||||||
|
<div class="c-clock l-time-display u-style-receiver js-style-receiver">
|
||||||
|
<div class="c-clock__timezone">
|
||||||
|
{{ timeZoneAbbr }}
|
||||||
|
</div>
|
||||||
|
<div class="c-clock__value">
|
||||||
|
{{ timeTextValue }}
|
||||||
|
</div>
|
||||||
|
<div class="c-clock__ampm">
|
||||||
|
{{ timeAmPm }}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import moment from 'moment';
|
||||||
|
import momentTimezone from 'moment-timezone';
|
||||||
|
|
||||||
|
export default {
|
||||||
|
inject: ['openmct', 'domainObject'],
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
lastTimestamp: null
|
||||||
|
};
|
||||||
|
},
|
||||||
|
computed: {
|
||||||
|
configuration() {
|
||||||
|
return this.domainObject.configuration;
|
||||||
|
},
|
||||||
|
baseFormat() {
|
||||||
|
return this.configuration.baseFormat;
|
||||||
|
},
|
||||||
|
use24() {
|
||||||
|
return this.configuration.use24 === 'clock24';
|
||||||
|
},
|
||||||
|
timezone() {
|
||||||
|
return this.configuration.timezone;
|
||||||
|
},
|
||||||
|
timeFormat() {
|
||||||
|
return this.use24 ? this.baseFormat.replace('hh', "HH") : this.baseFormat;
|
||||||
|
},
|
||||||
|
zoneName() {
|
||||||
|
return momentTimezone.tz.names().includes(this.timezone) ? this.timezone : "UTC";
|
||||||
|
},
|
||||||
|
momentTime() {
|
||||||
|
return this.zoneName ? moment.utc(this.lastTimestamp).tz(this.zoneName) : moment.utc(this.lastTimestamp);
|
||||||
|
},
|
||||||
|
timeZoneAbbr() {
|
||||||
|
return this.momentTime.zoneAbbr();
|
||||||
|
},
|
||||||
|
timeTextValue() {
|
||||||
|
return this.timeFormat && this.momentTime.format(this.timeFormat);
|
||||||
|
},
|
||||||
|
timeAmPm() {
|
||||||
|
return this.use24 ? '' : this.momentTime.format("A");
|
||||||
|
}
|
||||||
|
},
|
||||||
|
mounted() {
|
||||||
|
const TickerService = this.openmct.$injector.get('tickerService');
|
||||||
|
this.unlisten = TickerService.listen(this.tick);
|
||||||
|
},
|
||||||
|
beforeDestroy() {
|
||||||
|
if (this.unlisten) {
|
||||||
|
this.unlisten();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
methods: {
|
||||||
|
tick(timestamp) {
|
||||||
|
this.lastTimestamp = timestamp;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
</script>
|
64
src/plugins/clock/components/ClockIndicator.vue
Normal file
64
src/plugins/clock/components/ClockIndicator.vue
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
<!--
|
||||||
|
Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="c-indicator t-indicator-clock icon-clock no-minify c-indicator--not-clickable">
|
||||||
|
<span class="label c-indicator__label">
|
||||||
|
{{ timeTextValue }}
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import moment from 'moment';
|
||||||
|
|
||||||
|
export default {
|
||||||
|
inject: ['openmct'],
|
||||||
|
props: {
|
||||||
|
indicatorFormat: {
|
||||||
|
type: String,
|
||||||
|
required: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
timeTextValue: null
|
||||||
|
};
|
||||||
|
},
|
||||||
|
mounted() {
|
||||||
|
this.openmct.on('start', () => {
|
||||||
|
const TickerService = this.openmct.$injector.get('tickerService');
|
||||||
|
this.unlisten = TickerService.listen(this.tick);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
beforeDestroy() {
|
||||||
|
if (this.unlisten) {
|
||||||
|
this.unlisten();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
methods: {
|
||||||
|
tick(timestamp) {
|
||||||
|
this.timeTextValue = `${moment.utc(timestamp).format(this.indicatorFormat)} UTC`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
</script>
|
154
src/plugins/clock/plugin.js
Normal file
154
src/plugins/clock/plugin.js
Normal file
@ -0,0 +1,154 @@
|
|||||||
|
|
||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import ClockViewProvider from './ClockViewProvider';
|
||||||
|
import ClockIndicator from './components/ClockIndicator.vue';
|
||||||
|
|
||||||
|
import momentTimezone from 'moment-timezone';
|
||||||
|
import Vue from 'vue';
|
||||||
|
|
||||||
|
export default function ClockPlugin(options) {
|
||||||
|
return function install(openmct) {
|
||||||
|
const CLOCK_INDICATOR_FORMAT = 'YYYY/MM/DD HH:mm:ss';
|
||||||
|
openmct.types.addType('clock', {
|
||||||
|
name: 'Clock',
|
||||||
|
description: 'A UTC-based clock that supports a variety of display formats. Clocks can be added to Display Layouts.',
|
||||||
|
creatable: true,
|
||||||
|
cssClass: 'icon-clock',
|
||||||
|
initialize: function (domainObject) {
|
||||||
|
domainObject.configuration = {
|
||||||
|
baseFormat: 'YYYY/MM/DD hh:mm:ss',
|
||||||
|
use24: 'clock12',
|
||||||
|
timezone: 'UTC'
|
||||||
|
};
|
||||||
|
},
|
||||||
|
"form": [
|
||||||
|
{
|
||||||
|
"key": "displayFormat",
|
||||||
|
"name": "Display Format",
|
||||||
|
control: 'select',
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
value: 'YYYY/MM/DD hh:mm:ss',
|
||||||
|
name: 'YYYY/MM/DD hh:mm:ss'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
value: 'YYYY/DDD hh:mm:ss',
|
||||||
|
name: 'YYYY/DDD hh:mm:ss'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
value: 'hh:mm:ss',
|
||||||
|
name: 'hh:mm:ss'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
cssClass: 'l-inline',
|
||||||
|
property: [
|
||||||
|
'configuration',
|
||||||
|
'baseFormat'
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
control: 'select',
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
value: 'clock12',
|
||||||
|
name: '12hr'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
value: 'clock24',
|
||||||
|
name: '24hr'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
cssClass: 'l-inline',
|
||||||
|
property: [
|
||||||
|
'configuration',
|
||||||
|
'use24'
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "timezone",
|
||||||
|
"name": "Timezone",
|
||||||
|
"control": "autocomplete",
|
||||||
|
"options": momentTimezone.tz.names(),
|
||||||
|
property: [
|
||||||
|
'configuration',
|
||||||
|
'timezone'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
});
|
||||||
|
openmct.objectViews.addProvider(new ClockViewProvider(openmct));
|
||||||
|
|
||||||
|
if (options && options.enableClockIndicator === true) {
|
||||||
|
const clockIndicator = new Vue ({
|
||||||
|
components: {
|
||||||
|
ClockIndicator
|
||||||
|
},
|
||||||
|
provide: {
|
||||||
|
openmct
|
||||||
|
},
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
indicatorFormat: CLOCK_INDICATOR_FORMAT
|
||||||
|
};
|
||||||
|
},
|
||||||
|
template: '<ClockIndicator :indicator-format="indicatorFormat" />'
|
||||||
|
});
|
||||||
|
const indicator = {
|
||||||
|
element: clockIndicator.$mount().$el,
|
||||||
|
key: 'clock-indicator'
|
||||||
|
};
|
||||||
|
|
||||||
|
openmct.indicators.add(indicator);
|
||||||
|
}
|
||||||
|
|
||||||
|
openmct.objects.addGetInterceptor({
|
||||||
|
appliesTo: (identifier, domainObject) => {
|
||||||
|
return domainObject && domainObject.type === 'clock';
|
||||||
|
},
|
||||||
|
invoke: (identifier, domainObject) => {
|
||||||
|
if (domainObject.configuration) {
|
||||||
|
return domainObject;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (domainObject.clockFormat
|
||||||
|
&& domainObject.timezone) {
|
||||||
|
const baseFormat = domainObject.clockFormat[0];
|
||||||
|
const use24 = domainObject.clockFormat[1];
|
||||||
|
const timezone = domainObject.timezone;
|
||||||
|
|
||||||
|
domainObject.configuration = {
|
||||||
|
baseFormat,
|
||||||
|
use24,
|
||||||
|
timezone
|
||||||
|
};
|
||||||
|
|
||||||
|
openmct.objects.mutate(domainObject, 'configuration', domainObject.configuration);
|
||||||
|
}
|
||||||
|
|
||||||
|
return domainObject;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
};
|
||||||
|
}
|
231
src/plugins/clock/pluginSpec.js
Normal file
231
src/plugins/clock/pluginSpec.js
Normal file
@ -0,0 +1,231 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
import { createOpenMct, resetApplicationState } from 'utils/testing';
|
||||||
|
import clockPlugin from './plugin';
|
||||||
|
|
||||||
|
import Vue from 'vue';
|
||||||
|
|
||||||
|
describe("Clock plugin:", () => {
|
||||||
|
let openmct;
|
||||||
|
let clockDefinition;
|
||||||
|
let element;
|
||||||
|
let child;
|
||||||
|
let appHolder;
|
||||||
|
|
||||||
|
let clockDomainObject;
|
||||||
|
|
||||||
|
function setupClock(enableClockIndicator) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
clockDomainObject = {
|
||||||
|
identifier: {
|
||||||
|
key: 'clock',
|
||||||
|
namespace: 'test-namespace'
|
||||||
|
},
|
||||||
|
type: 'clock'
|
||||||
|
};
|
||||||
|
|
||||||
|
appHolder = document.createElement('div');
|
||||||
|
appHolder.style.width = '640px';
|
||||||
|
appHolder.style.height = '480px';
|
||||||
|
document.body.appendChild(appHolder);
|
||||||
|
|
||||||
|
openmct = createOpenMct();
|
||||||
|
|
||||||
|
element = document.createElement('div');
|
||||||
|
child = document.createElement('div');
|
||||||
|
element.appendChild(child);
|
||||||
|
|
||||||
|
openmct.install(clockPlugin({ enableClockIndicator }));
|
||||||
|
|
||||||
|
clockDefinition = openmct.types.get('clock').definition;
|
||||||
|
clockDefinition.initialize(clockDomainObject);
|
||||||
|
|
||||||
|
openmct.on('start', resolve);
|
||||||
|
openmct.start(appHolder);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("Clock view:", () => {
|
||||||
|
let clockViewProvider;
|
||||||
|
let clockView;
|
||||||
|
let clockViewObject;
|
||||||
|
let mutableClockObject;
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
await setupClock(true);
|
||||||
|
|
||||||
|
clockViewObject = {
|
||||||
|
...clockDomainObject,
|
||||||
|
id: "test-object",
|
||||||
|
name: 'Clock',
|
||||||
|
configuration: {
|
||||||
|
baseFormat: 'YYYY/MM/DD hh:mm:ss',
|
||||||
|
use24: 'clock12',
|
||||||
|
timezone: 'UTC'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
spyOn(openmct.objects, 'get').and.returnValue(Promise.resolve(clockViewObject));
|
||||||
|
spyOn(openmct.objects, 'save').and.returnValue(Promise.resolve(true));
|
||||||
|
|
||||||
|
const applicableViews = openmct.objectViews.get(clockViewObject, [clockViewObject]);
|
||||||
|
clockViewProvider = applicableViews.find(viewProvider => viewProvider.key === 'clock.view');
|
||||||
|
|
||||||
|
mutableClockObject = await openmct.objects.getMutable(clockViewObject.identifier);
|
||||||
|
|
||||||
|
clockView = clockViewProvider.view(mutableClockObject);
|
||||||
|
clockView.show(child);
|
||||||
|
|
||||||
|
await Vue.nextTick();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
clockView.destroy();
|
||||||
|
openmct.objects.destroyMutable(mutableClockObject);
|
||||||
|
if (appHolder) {
|
||||||
|
appHolder.remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
return resetApplicationState(openmct);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("has name as Clock", () => {
|
||||||
|
expect(clockDefinition.name).toEqual('Clock');
|
||||||
|
});
|
||||||
|
|
||||||
|
it("is creatable", () => {
|
||||||
|
expect(clockDefinition.creatable).toEqual(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("provides clock view", () => {
|
||||||
|
expect(clockViewProvider).toBeDefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it("renders clock element", () => {
|
||||||
|
const clockElement = element.querySelectorAll('.c-clock');
|
||||||
|
expect(clockElement.length).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("renders major elements", () => {
|
||||||
|
const clockElement = element.querySelector('.c-clock');
|
||||||
|
const timezone = clockElement.querySelector('.c-clock__timezone');
|
||||||
|
const time = clockElement.querySelector('.c-clock__value');
|
||||||
|
const amPm = clockElement.querySelector('.c-clock__ampm');
|
||||||
|
const hasMajorElements = Boolean(timezone && time && amPm);
|
||||||
|
|
||||||
|
expect(hasMajorElements).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("renders time in UTC", () => {
|
||||||
|
const clockElement = element.querySelector('.c-clock');
|
||||||
|
const timezone = clockElement.querySelector('.c-clock__timezone').textContent.trim();
|
||||||
|
|
||||||
|
expect(timezone).toBe('UTC');
|
||||||
|
});
|
||||||
|
|
||||||
|
it("updates the 24 hour option in the configuration", (done) => {
|
||||||
|
expect(clockDomainObject.configuration.use24).toBe('clock12');
|
||||||
|
const new24Option = 'clock24';
|
||||||
|
|
||||||
|
openmct.objects.observe(clockViewObject, 'configuration', (changedDomainObject) => {
|
||||||
|
expect(changedDomainObject.use24).toBe(new24Option);
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
|
||||||
|
openmct.objects.mutate(clockViewObject, 'configuration.use24', new24Option);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("updates the timezone option in the configuration", (done) => {
|
||||||
|
expect(clockDomainObject.configuration.timezone).toBe('UTC');
|
||||||
|
const newZone = 'CST6CDT';
|
||||||
|
|
||||||
|
openmct.objects.observe(clockViewObject, 'configuration', (changedDomainObject) => {
|
||||||
|
expect(changedDomainObject.timezone).toBe(newZone);
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
|
||||||
|
openmct.objects.mutate(clockViewObject, 'configuration.timezone', newZone);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("updates the time format option in the configuration", (done) => {
|
||||||
|
expect(clockDomainObject.configuration.baseFormat).toBe('YYYY/MM/DD hh:mm:ss');
|
||||||
|
const newFormat = 'hh:mm:ss';
|
||||||
|
|
||||||
|
openmct.objects.observe(clockViewObject, 'configuration', (changedDomainObject) => {
|
||||||
|
expect(changedDomainObject.baseFormat).toBe(newFormat);
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
|
||||||
|
openmct.objects.mutate(clockViewObject, 'configuration.baseFormat', newFormat);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("Clock Indicator view:", () => {
|
||||||
|
let clockIndicator;
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
if (clockIndicator) {
|
||||||
|
clockIndicator.remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
clockIndicator = undefined;
|
||||||
|
if (appHolder) {
|
||||||
|
appHolder.remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
return resetApplicationState(openmct);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("doesn't exist", async () => {
|
||||||
|
await setupClock(false);
|
||||||
|
|
||||||
|
clockIndicator = openmct.indicators.indicatorObjects
|
||||||
|
.find(indicator => indicator.key === 'clock-indicator');
|
||||||
|
|
||||||
|
const clockIndicatorMissing = clockIndicator === null || clockIndicator === undefined;
|
||||||
|
expect(clockIndicatorMissing).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("exists", async () => {
|
||||||
|
await setupClock(true);
|
||||||
|
|
||||||
|
clockIndicator = openmct.indicators.indicatorObjects
|
||||||
|
.find(indicator => indicator.key === 'clock-indicator').element;
|
||||||
|
|
||||||
|
const hasClockIndicator = clockIndicator !== null && clockIndicator !== undefined;
|
||||||
|
expect(hasClockIndicator).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("contains text", async () => {
|
||||||
|
await setupClock(true);
|
||||||
|
|
||||||
|
clockIndicator = openmct.indicators.indicatorObjects
|
||||||
|
.find(indicator => indicator.key === 'clock-indicator').element;
|
||||||
|
|
||||||
|
const clockIndicatorText = clockIndicator.textContent.trim();
|
||||||
|
const textIncludesUTC = clockIndicatorText.includes('UTC');
|
||||||
|
|
||||||
|
expect(textIncludesUTC).toBe(true);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
@ -273,10 +273,7 @@ export default {
|
|||||||
this.openmct.objects.getOriginalPath(this.conditionSetDomainObject.identifier).then(
|
this.openmct.objects.getOriginalPath(this.conditionSetDomainObject.identifier).then(
|
||||||
(objectPath) => {
|
(objectPath) => {
|
||||||
this.objectPath = objectPath;
|
this.objectPath = objectPath;
|
||||||
this.navigateToPath = '#/browse/' + this.objectPath
|
this.navigateToPath = '#/browse/' + this.openmct.objects.getRelativePath(this.objectPath);
|
||||||
.map(o => o && this.openmct.objects.makeKeyString(o.identifier))
|
|
||||||
.reverse()
|
|
||||||
.join('/');
|
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
|
@ -141,6 +141,7 @@ const NON_STYLEABLE_CONTAINER_TYPES = [
|
|||||||
const NON_STYLEABLE_LAYOUT_ITEM_TYPES = [
|
const NON_STYLEABLE_LAYOUT_ITEM_TYPES = [
|
||||||
'line-view',
|
'line-view',
|
||||||
'box-view',
|
'box-view',
|
||||||
|
'ellipse-view',
|
||||||
'image-view'
|
'image-view'
|
||||||
];
|
];
|
||||||
|
|
||||||
@ -296,10 +297,7 @@ export default {
|
|||||||
this.openmct.objects.getOriginalPath(this.conditionSetDomainObject.identifier).then(
|
this.openmct.objects.getOriginalPath(this.conditionSetDomainObject.identifier).then(
|
||||||
(objectPath) => {
|
(objectPath) => {
|
||||||
this.objectPath = objectPath;
|
this.objectPath = objectPath;
|
||||||
this.navigateToPath = '#/browse/' + this.objectPath
|
this.navigateToPath = '#/browse/' + this.openmct.objects.getRelativePath(this.objectPath);
|
||||||
.map(o => o && this.openmct.objects.makeKeyString(o.identifier))
|
|
||||||
.reverse()
|
|
||||||
.join('/');
|
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
@ -321,7 +319,7 @@ export default {
|
|||||||
if (item) {
|
if (item) {
|
||||||
const type = this.openmct.types.get(item.type);
|
const type = this.openmct.types.get(item.type);
|
||||||
if (type && type.definition) {
|
if (type && type.definition) {
|
||||||
creatable = (type.definition.creatable === true);
|
creatable = (type.definition.creatable !== undefined && (type.definition.creatable === 'true' || type.definition.creatable === true));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -230,7 +230,7 @@ describe('the plugin', function () {
|
|||||||
};
|
};
|
||||||
const staticStyle = {
|
const staticStyle = {
|
||||||
"style": {
|
"style": {
|
||||||
"backgroundColor": "#717171",
|
"backgroundColor": "#666666",
|
||||||
"border": "1px solid #00ffff"
|
"border": "1px solid #00ffff"
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@ -238,7 +238,7 @@ describe('the plugin', function () {
|
|||||||
"conditionId": "39584410-cbf9-499e-96dc-76f27e69885d",
|
"conditionId": "39584410-cbf9-499e-96dc-76f27e69885d",
|
||||||
"style": {
|
"style": {
|
||||||
"isStyleInvisible": "",
|
"isStyleInvisible": "",
|
||||||
"backgroundColor": "#717171",
|
"backgroundColor": "#666666",
|
||||||
"border": "1px solid #ffff00"
|
"border": "1px solid #ffff00"
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@ -250,7 +250,7 @@ describe('the plugin', function () {
|
|||||||
"configuration": {
|
"configuration": {
|
||||||
"items": [
|
"items": [
|
||||||
{
|
{
|
||||||
"fill": "#717171",
|
"fill": "#666666",
|
||||||
"stroke": "",
|
"stroke": "",
|
||||||
"x": 1,
|
"x": 1,
|
||||||
"y": 1,
|
"y": 1,
|
||||||
@ -259,12 +259,22 @@ describe('the plugin', function () {
|
|||||||
"type": "box-view",
|
"type": "box-view",
|
||||||
"id": "89b88746-d325-487b-aec4-11b79afff9e8"
|
"id": "89b88746-d325-487b-aec4-11b79afff9e8"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"fill": "#666666",
|
||||||
|
"stroke": "",
|
||||||
|
"x": 1,
|
||||||
|
"y": 1,
|
||||||
|
"width": 10,
|
||||||
|
"height": 5,
|
||||||
|
"type": "ellipse-view",
|
||||||
|
"id": "19b88746-d325-487b-aec4-11b79afff9z8"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"x": 18,
|
"x": 18,
|
||||||
"y": 9,
|
"y": 9,
|
||||||
"x2": 23,
|
"x2": 23,
|
||||||
"y2": 4,
|
"y2": 4,
|
||||||
"stroke": "#717171",
|
"stroke": "#666666",
|
||||||
"type": "line-view",
|
"type": "line-view",
|
||||||
"id": "57d49a28-7863-43bd-9593-6570758916f0"
|
"id": "57d49a28-7863-43bd-9593-6570758916f0"
|
||||||
},
|
},
|
||||||
@ -299,12 +309,12 @@ describe('the plugin', function () {
|
|||||||
"y": 9,
|
"y": 9,
|
||||||
"x2": 23,
|
"x2": 23,
|
||||||
"y2": 4,
|
"y2": 4,
|
||||||
"stroke": "#717171",
|
"stroke": "#666666",
|
||||||
"type": "line-view",
|
"type": "line-view",
|
||||||
"id": "57d49a28-7863-43bd-9593-6570758916f0"
|
"id": "57d49a28-7863-43bd-9593-6570758916f0"
|
||||||
};
|
};
|
||||||
boxLayoutItem = {
|
boxLayoutItem = {
|
||||||
"fill": "#717171",
|
"fill": "#666666",
|
||||||
"stroke": "",
|
"stroke": "",
|
||||||
"x": 1,
|
"x": 1,
|
||||||
"y": 1,
|
"y": 1,
|
||||||
|
@ -29,9 +29,10 @@ const styleProps = {
|
|||||||
noneValue: NONE_VALUE,
|
noneValue: NONE_VALUE,
|
||||||
applicableForType: type => {
|
applicableForType: type => {
|
||||||
return !type ? true : (type === 'text-view'
|
return !type ? true : (type === 'text-view'
|
||||||
|| type === 'telemetry-view'
|
|| type === 'telemetry-view'
|
||||||
|| type === 'box-view'
|
|| type === 'box-view'
|
||||||
|| type === 'subobject-view');
|
|| type === 'ellipse-view'
|
||||||
|
|| type === 'subobject-view');
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
border: {
|
border: {
|
||||||
@ -41,6 +42,7 @@ const styleProps = {
|
|||||||
return !type ? true : (type === 'text-view'
|
return !type ? true : (type === 'text-view'
|
||||||
|| type === 'telemetry-view'
|
|| type === 'telemetry-view'
|
||||||
|| type === 'box-view'
|
|| type === 'box-view'
|
||||||
|
|| type === 'ellipse-view'
|
||||||
|| type === 'image-view'
|
|| type === 'image-view'
|
||||||
|| type === 'line-view'
|
|| type === 'line-view'
|
||||||
|| type === 'subobject-view');
|
|| type === 'subobject-view');
|
||||||
|
@ -149,6 +149,7 @@ define(['lodash'], function (_) {
|
|||||||
return type === 'text-view'
|
return type === 'text-view'
|
||||||
|| type === 'telemetry-view'
|
|| type === 'telemetry-view'
|
||||||
|| type === 'box-view'
|
|| type === 'box-view'
|
||||||
|
|| type === 'ellipse-view'
|
||||||
|| type === 'image-view'
|
|| type === 'image-view'
|
||||||
|| type === 'line-view'
|
|| type === 'line-view'
|
||||||
|| type === 'subobject-view';
|
|| type === 'subobject-view';
|
||||||
@ -180,6 +181,10 @@ define(['lodash'], function (_) {
|
|||||||
"name": "Box",
|
"name": "Box",
|
||||||
"class": "icon-box-round-corners"
|
"class": "icon-box-round-corners"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "Ellipse",
|
||||||
|
"class": "icon-circle"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "Line",
|
"name": "Line",
|
||||||
"class": "icon-line-horz"
|
"class": "icon-line-horz"
|
||||||
@ -745,7 +750,7 @@ define(['lodash'], function (_) {
|
|||||||
if (toolbar.remove.length === 0) {
|
if (toolbar.remove.length === 0) {
|
||||||
toolbar.remove = [getRemoveButton(selectedParent, selectionPath, selectedObjects)];
|
toolbar.remove = [getRemoveButton(selectedParent, selectionPath, selectedObjects)];
|
||||||
}
|
}
|
||||||
} else if (layoutItem.type === 'box-view') {
|
} else if (layoutItem.type === 'box-view' || layoutItem.type === 'ellipse-view') {
|
||||||
if (toolbar.position.length === 0) {
|
if (toolbar.position.length === 0) {
|
||||||
toolbar.position = [
|
toolbar.position = [
|
||||||
getStackOrder(selectedParent, selectionPath),
|
getStackOrder(selectedParent, selectionPath),
|
||||||
|
@ -43,7 +43,7 @@ import conditionalStylesMixin from '../mixins/objectStyles-mixin';
|
|||||||
export default {
|
export default {
|
||||||
makeDefinition() {
|
makeDefinition() {
|
||||||
return {
|
return {
|
||||||
fill: '#717171',
|
fill: '#666666',
|
||||||
stroke: '',
|
stroke: '',
|
||||||
x: 1,
|
x: 1,
|
||||||
y: 1,
|
y: 1,
|
||||||
|
@ -76,6 +76,7 @@ import uuid from 'uuid';
|
|||||||
import SubobjectView from './SubobjectView.vue';
|
import SubobjectView from './SubobjectView.vue';
|
||||||
import TelemetryView from './TelemetryView.vue';
|
import TelemetryView from './TelemetryView.vue';
|
||||||
import BoxView from './BoxView.vue';
|
import BoxView from './BoxView.vue';
|
||||||
|
import EllipseView from './EllipseView.vue';
|
||||||
import TextView from './TextView.vue';
|
import TextView from './TextView.vue';
|
||||||
import LineView from './LineView.vue';
|
import LineView from './LineView.vue';
|
||||||
import ImageView from './ImageView.vue';
|
import ImageView from './ImageView.vue';
|
||||||
@ -112,6 +113,7 @@ const ITEM_TYPE_VIEW_MAP = {
|
|||||||
'subobject-view': SubobjectView,
|
'subobject-view': SubobjectView,
|
||||||
'telemetry-view': TelemetryView,
|
'telemetry-view': TelemetryView,
|
||||||
'box-view': BoxView,
|
'box-view': BoxView,
|
||||||
|
'ellipse-view': EllipseView,
|
||||||
'line-view': LineView,
|
'line-view': LineView,
|
||||||
'text-view': TextView,
|
'text-view': TextView,
|
||||||
'image-view': ImageView
|
'image-view': ImageView
|
||||||
|
@ -28,19 +28,19 @@
|
|||||||
>
|
>
|
||||||
<div
|
<div
|
||||||
class="c-frame-edit__handle c-frame-edit__handle--nw"
|
class="c-frame-edit__handle c-frame-edit__handle--nw"
|
||||||
@mousedown="startResize([1,1], [-1,-1], $event)"
|
@mousedown.left="startResize([1,1], [-1,-1], $event)"
|
||||||
></div>
|
></div>
|
||||||
<div
|
<div
|
||||||
class="c-frame-edit__handle c-frame-edit__handle--ne"
|
class="c-frame-edit__handle c-frame-edit__handle--ne"
|
||||||
@mousedown="startResize([0,1], [1,-1], $event)"
|
@mousedown.left="startResize([0,1], [1,-1], $event)"
|
||||||
></div>
|
></div>
|
||||||
<div
|
<div
|
||||||
class="c-frame-edit__handle c-frame-edit__handle--sw"
|
class="c-frame-edit__handle c-frame-edit__handle--sw"
|
||||||
@mousedown="startResize([1,0], [-1,1], $event)"
|
@mousedown.left="startResize([1,0], [-1,1], $event)"
|
||||||
></div>
|
></div>
|
||||||
<div
|
<div
|
||||||
class="c-frame-edit__handle c-frame-edit__handle--se"
|
class="c-frame-edit__handle c-frame-edit__handle--se"
|
||||||
@mousedown="startResize([0,0], [1,1], $event)"
|
@mousedown.left="startResize([0,0], [1,1], $event)"
|
||||||
></div>
|
></div>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
122
src/plugins/displayLayout/components/EllipseView.vue
Normal file
122
src/plugins/displayLayout/components/EllipseView.vue
Normal file
@ -0,0 +1,122 @@
|
|||||||
|
/*****************************************************************************
|
||||||
|
* Open MCT, Copyright (c) 2014-2021, United States Government
|
||||||
|
* 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.
|
||||||
|
*****************************************************************************/
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<layout-frame
|
||||||
|
:item="item"
|
||||||
|
:grid-size="gridSize"
|
||||||
|
:is-editing="isEditing"
|
||||||
|
@move="(gridDelta) => $emit('move', gridDelta)"
|
||||||
|
@endMove="() => $emit('endMove')"
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
class="c-ellipse-view u-style-receiver js-style-receiver"
|
||||||
|
:class="[styleClass]"
|
||||||
|
:style="style"
|
||||||
|
></div>
|
||||||
|
</layout-frame>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import LayoutFrame from './LayoutFrame.vue';
|
||||||
|
import conditionalStylesMixin from '../mixins/objectStyles-mixin';
|
||||||
|
|
||||||
|
export default {
|
||||||
|
makeDefinition() {
|
||||||
|
return {
|
||||||
|
fill: '#666666',
|
||||||
|
stroke: '',
|
||||||
|
x: 1,
|
||||||
|
y: 1,
|
||||||
|
width: 10,
|
||||||
|
height: 10
|
||||||
|
};
|
||||||
|
},
|
||||||
|
components: {
|
||||||
|
LayoutFrame
|
||||||
|
},
|
||||||
|
mixins: [conditionalStylesMixin],
|
||||||
|
inject: ['openmct'],
|
||||||
|
props: {
|
||||||
|
item: {
|
||||||
|
type: Object,
|
||||||
|
required: true
|
||||||
|
},
|
||||||
|
gridSize: {
|
||||||
|
type: Array,
|
||||||
|
required: true,
|
||||||
|
validator: (arr) => arr && arr.length === 2
|
||||||
|
&& arr.every(el => typeof el === 'number')
|
||||||
|
},
|
||||||
|
index: {
|
||||||
|
type: Number,
|
||||||
|
required: true
|
||||||
|
},
|
||||||
|
initSelect: Boolean,
|
||||||
|
isEditing: {
|
||||||
|
type: Boolean,
|
||||||
|
required: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
computed: {
|
||||||
|
style() {
|
||||||
|
if (this.itemStyle) {
|
||||||
|
return this.itemStyle;
|
||||||
|
} else {
|
||||||
|
return {
|
||||||
|
backgroundColor: this.item.fill,
|
||||||
|
border: this.item.stroke ? '1px solid ' + this.item.stroke : ''
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
watch: {
|
||||||
|
index(newIndex) {
|
||||||
|
if (!this.context) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.context.index = newIndex;
|
||||||
|
},
|
||||||
|
item(newItem) {
|
||||||
|
if (!this.context) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.context.layoutItem = newItem;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
mounted() {
|
||||||
|
this.context = {
|
||||||
|
layoutItem: this.item,
|
||||||
|
index: this.index
|
||||||
|
};
|
||||||
|
this.removeSelectable = this.openmct.selection.selectable(
|
||||||
|
this.$el, this.context, this.initSelect);
|
||||||
|
},
|
||||||
|
destroyed() {
|
||||||
|
if (this.removeSelectable) {
|
||||||
|
this.removeSelectable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
</script>
|
@ -33,7 +33,7 @@
|
|||||||
<slot></slot>
|
<slot></slot>
|
||||||
<div
|
<div
|
||||||
class="c-frame__move-bar"
|
class="c-frame__move-bar"
|
||||||
@mousedown="isEditing ? startMove([1,1], [0,0], $event) : null"
|
@mousedown.left="startMove($event)"
|
||||||
></div>
|
></div>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
@ -93,7 +93,11 @@ export default {
|
|||||||
return value - this.initialPosition[index];
|
return value - this.initialPosition[index];
|
||||||
}.bind(this));
|
}.bind(this));
|
||||||
},
|
},
|
||||||
startMove(posFactor, dimFactor, event) {
|
startMove(event, posFactor = [1, 1], dimFactor = [0, 0]) {
|
||||||
|
if (!this.isEditing) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
document.body.addEventListener('mousemove', this.continueMove);
|
document.body.addEventListener('mousemove', this.continueMove);
|
||||||
document.body.addEventListener('mouseup', this.endMove);
|
document.body.addEventListener('mouseup', this.endMove);
|
||||||
this.dragPosition = {
|
this.dragPosition = {
|
||||||
|
@ -45,7 +45,7 @@
|
|||||||
|
|
||||||
<div
|
<div
|
||||||
class="c-frame__move-bar"
|
class="c-frame__move-bar"
|
||||||
@mousedown="startDrag($event)"
|
@mousedown.left="startDrag($event)"
|
||||||
></div>
|
></div>
|
||||||
<div
|
<div
|
||||||
v-if="showFrameEdit"
|
v-if="showFrameEdit"
|
||||||
@ -96,7 +96,7 @@ export default {
|
|||||||
y: 10,
|
y: 10,
|
||||||
x2: 10,
|
x2: 10,
|
||||||
y2: 5,
|
y2: 5,
|
||||||
stroke: '#717171'
|
stroke: '#666666'
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
mixins: [conditionalStylesMixin],
|
mixins: [conditionalStylesMixin],
|
||||||
|
@ -72,7 +72,7 @@
|
|||||||
<script>
|
<script>
|
||||||
import LayoutFrame from './LayoutFrame.vue';
|
import LayoutFrame from './LayoutFrame.vue';
|
||||||
import conditionalStylesMixin from "../mixins/objectStyles-mixin";
|
import conditionalStylesMixin from "../mixins/objectStyles-mixin";
|
||||||
import { getDefaultNotebook } from '@/plugins/notebook/utils/notebook-storage.js';
|
import { getDefaultNotebook, getNotebookSectionAndPage } from '@/plugins/notebook/utils/notebook-storage.js';
|
||||||
|
|
||||||
const DEFAULT_TELEMETRY_DIMENSIONS = [10, 5];
|
const DEFAULT_TELEMETRY_DIMENSIONS = [10, 5];
|
||||||
const DEFAULT_POSITION = [1, 1];
|
const DEFAULT_POSITION = [1, 1];
|
||||||
@ -336,12 +336,15 @@ export default {
|
|||||||
},
|
},
|
||||||
async getContextMenuActions() {
|
async getContextMenuActions() {
|
||||||
const defaultNotebook = getDefaultNotebook();
|
const defaultNotebook = getDefaultNotebook();
|
||||||
const domainObject = defaultNotebook && await this.openmct.objects.get(defaultNotebook.notebookMeta.identifier);
|
|
||||||
|
|
||||||
let defaultNotebookName;
|
let defaultNotebookName;
|
||||||
if (defaultNotebook) {
|
if (defaultNotebook) {
|
||||||
const defaultPath = domainObject && `${domainObject.name} - ${defaultNotebook.section.name} - ${defaultNotebook.page.name}`;
|
const domainObject = await this.openmct.objects.get(defaultNotebook.identifier);
|
||||||
defaultNotebookName = `Copy to Notebook ${defaultPath}`;
|
const { section, page } = getNotebookSectionAndPage(domainObject, defaultNotebook.defaultSectionId, defaultNotebook.defaultPageId);
|
||||||
|
if (section && page) {
|
||||||
|
const defaultPath = domainObject && `${domainObject.name} - ${section.name} - ${page.name}`;
|
||||||
|
defaultNotebookName = `Copy to Notebook ${defaultPath}`;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return CONTEXT_MENU_ACTIONS
|
return CONTEXT_MENU_ACTIONS
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
.c-box-view {
|
.c-box-view,
|
||||||
|
.c-ellipse-view {
|
||||||
border-width: $drawingObjBorderW !important;
|
border-width: $drawingObjBorderW !important;
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: stretch;
|
align-items: stretch;
|
||||||
@ -8,6 +9,10 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.c-ellipse-view {
|
||||||
|
border-radius: 50%;
|
||||||
|
}
|
||||||
|
|
||||||
.c-line-view {
|
.c-line-view {
|
||||||
&.c-frame {
|
&.c-frame {
|
||||||
box-shadow: none !important;
|
box-shadow: none !important;
|
||||||
|
@ -186,7 +186,7 @@ describe('the plugin', function () {
|
|||||||
'configuration': {
|
'configuration': {
|
||||||
'items': [
|
'items': [
|
||||||
{
|
{
|
||||||
'fill': '#717171',
|
'fill': '#666666',
|
||||||
'stroke': '',
|
'stroke': '',
|
||||||
'x': 1,
|
'x': 1,
|
||||||
'y': 1,
|
'y': 1,
|
||||||
@ -195,12 +195,22 @@ describe('the plugin', function () {
|
|||||||
'type': 'box-view',
|
'type': 'box-view',
|
||||||
'id': '89b88746-d325-487b-aec4-11b79afff9e8'
|
'id': '89b88746-d325-487b-aec4-11b79afff9e8'
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
'fill': '#666666',
|
||||||
|
'stroke': '',
|
||||||
|
'x': 1,
|
||||||
|
'y': 1,
|
||||||
|
'width': 10,
|
||||||
|
'height': 10,
|
||||||
|
'type': 'ellipse-view',
|
||||||
|
'id': '19b88746-d325-487b-aec4-11b79afff9z8'
|
||||||
|
},
|
||||||
{
|
{
|
||||||
'x': 18,
|
'x': 18,
|
||||||
'y': 9,
|
'y': 9,
|
||||||
'x2': 23,
|
'x2': 23,
|
||||||
'y2': 4,
|
'y2': 4,
|
||||||
'stroke': '#717171',
|
'stroke': '#666666',
|
||||||
'type': 'line-view',
|
'type': 'line-view',
|
||||||
'id': '57d49a28-7863-43bd-9593-6570758916f0'
|
'id': '57d49a28-7863-43bd-9593-6570758916f0'
|
||||||
},
|
},
|
||||||
@ -341,7 +351,7 @@ describe('the plugin', function () {
|
|||||||
it('provides controls including separators', () => {
|
it('provides controls including separators', () => {
|
||||||
const displayLayoutToolbar = openmct.toolbars.get(selection);
|
const displayLayoutToolbar = openmct.toolbars.get(selection);
|
||||||
|
|
||||||
expect(displayLayoutToolbar.length).toBe(9);
|
expect(displayLayoutToolbar.length).toBe(7);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user