[Time API] Modified public Time API to support registration of time systems and clocks, setting of active clock, simplification of clocks and time systems, setting of offsets(deltas) and other changes as per #1265 and #1474. Refactoring of UI code to support changes.

src/plugins/plugins.js

@@ -22,14 +22,16 @@
 
 define([
     'lodash',
-    '../../platform/features/conductor/utcTimeSystem/src/UTCTimeSystem',
+    './utcTimeSystem/plugin',
     '../../example/generator/plugin',
-    '../../platform/features/autoflow/plugin'
+    '../../platform/features/autoflow/plugin',
+    './timeConductor/plugin'
 ], function (
     _,
     UTCTimeSystem,
     GeneratorPlugin,
-    AutoflowPlugin
+    AutoflowPlugin,
+    TimeConductorPlugin
 ) {
     var bundleMap = {
         CouchDB: 'platform/persistence/couch',
@@ -48,14 +50,7 @@ define([
         };
     });
 
-    plugins.UTCTimeSystem = function () {
-        return function (openmct) {
-            openmct.legacyExtension("timeSystems", {
-                "implementation": UTCTimeSystem,
-                "depends": ["$timeout"]
-            });
-        };
-    };
+    plugins.UTCTimeSystem = UTCTimeSystem;
 
     /**
      * A tabular view showing the latest values of multiple telemetry points at
@@ -68,50 +63,7 @@ define([
      */
     plugins.AutoflowView = AutoflowPlugin;
 
-    var conductorInstalled = false;
-
-    plugins.Conductor = function (options) {
-        if (!options) {
-            options = {};
-        }
-
-        function applyDefaults(openmct, timeConductorViewService) {
-            var defaults = {};
-            var timeSystem = timeConductorViewService.systems.find(function (ts) {
-                return ts.metadata.key === options.defaultTimeSystem;
-            });
-            if (timeSystem !== undefined) {
-                openmct.conductor.timeSystem(timeSystem, defaults.bounds);
-            }
-        }
-
-        return function (openmct) {
-            openmct.legacyExtension('constants', {
-                key: 'DEFAULT_TIMECONDUCTOR_MODE',
-                value: options.showConductor ? 'fixed' : 'realtime',
-                priority: conductorInstalled ? 'mandatory' : 'fallback'
-            });
-            if (options.showConductor !== undefined) {
-                openmct.legacyExtension('constants', {
-                    key: 'SHOW_TIMECONDUCTOR',
-                    value: options.showConductor,
-                    priority: conductorInstalled ? 'mandatory' : 'fallback'
-                });
-            }
-            if (options.defaultTimeSystem !== undefined || options.defaultTimespan !== undefined) {
-                openmct.legacyExtension('runs', {
-                    implementation: applyDefaults,
-                    depends: ["openmct", "timeConductorViewService"]
-                });
-            }
-
-            if (!conductorInstalled) {
-                openmct.legacyRegistry.enable('platform/features/conductor/core');
-                openmct.legacyRegistry.enable('platform/features/conductor/compatibility');
-            }
-            conductorInstalled = true;
-        };
-    };
+    plugins.Conductor = TimeConductorPlugin;
 
     plugins.CouchDB = function (url) {
         return function (openmct) {

src/plugins/timeConductor/plugin.js

@@ -0,0 +1,93 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-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([], function () {
+
+    return function (config) {
+
+        function validateConfiguration() {
+            if (config === undefined || config.menuOptions === undefined || config.menuOptions.length === 0) {
+                return "Please provide some configuration for the time conductor. https://github.com/nasa/openmct/blob/master/API.md#time-conductor";
+            }
+            return undefined;
+        }
+
+        return function (openmct) {
+
+            function getTimeSystem(key) {
+                return openmct.time.allTimeSystems().filter(function (timeSystem) {
+                    return timeSystem.key === key;
+                })[0];
+            }
+
+            var validationError = validateConfiguration();
+            if (validationError) {
+                throw validationError;
+            }
+
+            openmct.legacyExtension('constants', {
+                key: 'CONDUCTOR_CONFIG',
+                value: config,
+                priority: 'mandatory'
+            });
+
+            openmct.legacyRegistry.enable('platform/features/conductor/core');
+            openmct.legacyRegistry.enable('platform/features/conductor/compatibility');
+
+            openmct.on('start', function () {
+                /*
+                 On app startup, default the conductor
+                 */
+                var timeSystem = openmct.time.timeSystem();
+                var clock = openmct.time.clock();
+
+                if (timeSystem === undefined) {
+                    timeSystem = getTimeSystem(config.menuOptions[0].timeSystem);
+                    if (timeSystem === undefined) {
+                        throw 'Please install and configure at least one time system';
+                    }
+                }
+
+                var configForTimeSystem = config.menuOptions.filter(function (menuOption) {
+                    return menuOption.timeSystem === (timeSystem && timeSystem.key) && menuOption.clock === (clock && clock.key);
+                })[0];
+
+                if (configForTimeSystem !== undefined) {
+                    var bounds;
+                    if (clock === undefined) {
+                        bounds = configForTimeSystem.bounds;
+                    } else {
+                        var clockOffsets = configForTimeSystem.clockOffsets;
+
+                        bounds = {
+                            start: clock.currentValue() + clockOffsets.start,
+                            end: clock.currentValue() + clockOffsets.end
+                        }
+                    }
+                    openmct.time.timeSystem(timeSystem, bounds);
+                } else {
+                    throw 'Invalid time conductor configuration. Please define defaults for time system "' + timeSystem.key + '"';
+                }
+            });
+        }
+    }
+});

src/plugins/utcTimeSystem/LocalClock.js

@@ -0,0 +1,110 @@
+/*****************************************************************************
+ * Open MCT Web, Copyright (c) 2014-2015, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT Web 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 Web 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(['EventEmitter'], function (EventEmitter) {
+    /**
+     * @implements TickSource
+     * @constructor
+     */
+    function LocalClock(period) {
+        EventEmitter.call(this);
+
+        /*
+        Metadata fields
+         */
+        this.key = 'local';
+        this.cssClass = 'icon-clock';
+        this.label = 'Local Clock';
+        this.name = 'Local Clock';
+        this.description = "Updates every second, providing UTC timestamps from " +
+            "user's local computer.";
+
+        this.period = period;
+        this.timeoutHandle = undefined;
+        this.lastTick = Date.now();
+    }
+
+    LocalClock.prototype = Object.create(EventEmitter.prototype);
+
+    /**
+     * @private
+     */
+    LocalClock.prototype.start = function () {
+        this.timeoutHandle = setTimeout(this.tick.bind(this), this.period);
+    };
+
+    /**
+     * @private
+     */
+    LocalClock.prototype.stop = function () {
+        if (this.timeoutHandle) {
+            clearTimeout(this.timeoutHandle);
+            this.timeoutHandle = undefined;
+        }
+    };
+
+    LocalClock.prototype.tick = function () {
+        var now = Date.now();
+        this.emit("tick", now);
+        this.lastTick = now;
+        this.timeoutHandle = setTimeout(this.tick.bind(this), this.period);
+    };
+
+    /**
+     * Register a listener for the local clock. When it ticks, the local
+     * clock will provide the current local system time
+     *
+     * @param listener
+     * @returns {function} a function for deregistering the provided listener
+     */
+    LocalClock.prototype.on = function (event, listener) {
+        var result = EventEmitter.prototype.on.apply(this, arguments);
+
+        if (this.listeners(event).length === 1) {
+            this.start();
+        }
+        return result;
+    };
+
+    /**
+     * Register a listener for the local clock. When it ticks, the local
+     * clock will provide the current local system time
+     *
+     * @param listener
+     * @returns {function} a function for deregistering the provided listener
+     */
+    LocalClock.prototype.off = function (event, listener) {
+        var result = EventEmitter.prototype.off.apply(this, arguments);
+
+        if (this.listeners(event).length === 0) {
+            this.stop();
+        }
+
+        return result;
+    };
+
+    LocalClock.prototype.currentValue = function () {
+        return this.lastTick;
+    };
+
+    return LocalClock;
+});

src/plugins/utcTimeSystem/LocalClockSpec.js

@@ -0,0 +1,50 @@
+/*****************************************************************************
+ * Open MCT Web, Copyright (c) 2014-2015, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT Web 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 Web 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(["./LocalClock"], function (LocalClock) {
+    describe("The LocalClock class", function () {
+        var clock,
+            mockTimeout,
+            timeoutHandle = {};
+
+        beforeEach(function () {
+            mockTimeout = jasmine.createSpy("timeout");
+            mockTimeout.andReturn(timeoutHandle);
+            mockTimeout.cancel = jasmine.createSpy("cancel");
+
+            clock = new LocalClock(mockTimeout, 0);
+            clock.start();
+        });
+
+        it("calls listeners on tick with current time", function () {
+            var mockListener = jasmine.createSpy("listener");
+            clock.listen(mockListener);
+            clock.tick();
+            expect(mockListener).toHaveBeenCalledWith(jasmine.any(Number));
+        });
+
+        it("stops ticking when stop is called", function () {
+            clock.stop();
+            expect(mockTimeout.cancel).toHaveBeenCalledWith(timeoutHandle);
+        });
+    });
+});

src/plugins/utcTimeSystem/UTCTimeSystem.js

@@ -0,0 +1,47 @@
+/*****************************************************************************
+ * Open MCT Web, Copyright (c) 2014-2015, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT Web 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 Web 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 () {
+    /**
+     * This time system supports UTC dates and provides a ticking clock source.
+     * @implements TimeSystem
+     * @constructor
+     */
+    function UTCTimeSystem() {
+
+        /**
+         * Some metadata, which will be used to identify the time system in
+         * the UI
+         * @type {{key: string, name: string, cssClass: string}}
+         */
+        this.key = 'utc';
+        this.name = 'UTC';
+        this.cssClass = 'icon-clock';
+
+        this.timeFormat = 'utc';
+        this.durationFormat = 'duration';
+
+        this.isUTCBased = true;
+    }
+
+    return UTCTimeSystem;
+});

src/plugins/utcTimeSystem/UTCTimeSystemSpec.js

@@ -0,0 +1,46 @@
+/*****************************************************************************
+ * Open MCT Web, Copyright (c) 2014-2015, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT Web 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 Web 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(['./UTCTimeSystem'], function (UTCTimeSystem) {
+    describe("The UTCTimeSystem class", function () {
+        var timeSystem,
+            mockTimeout;
+
+        beforeEach(function () {
+            mockTimeout = jasmine.createSpy("timeout");
+            timeSystem = new UTCTimeSystem(mockTimeout);
+        });
+
+        it("defines at least one format", function () {
+            expect(timeSystem.formats().length).toBeGreaterThan(0);
+        });
+
+        it("defines a tick source", function () {
+            var tickSources = timeSystem.tickSources();
+            expect(tickSources.length).toBeGreaterThan(0);
+        });
+
+        it("defines some defaults", function () {
+            expect(timeSystem.defaults()).toBeDefined();
+        });
+    });
+});

src/plugins/utcTimeSystem/plugin.js

@@ -0,0 +1,38 @@
+/*****************************************************************************
+ * Open MCT Web, Copyright (c) 2014-2015, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT Web 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 Web 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([
+    "./UTCTimeSystem",
+    "./LocalClock"
+], function (
+    UTCTimeSystem,
+    LocalClock
+) {
+    var ONE_DAY = 24 * 60 * 60 * 1000;
+    return function () {
+        return function (openmct) {
+            var timeSystem = new UTCTimeSystem();
+            openmct.time.addTimeSystem(timeSystem);
+            openmct.time.addClock(new LocalClock(100));
+        }
+    };
+});