Updating JSDOC, extending DataStore

Author: harshita-adsk

client/data/Hyperion.Data.DeviceModel.js

@@ -232,35 +232,44 @@ class DeviceModel {
         this._deviceModelId = deviceModelId;
         this._adapterId = adapterId;
 
-        /** @type {Object.<string, DeviceProperty>} */
+        /** @type {Object.<string, DeviceProperty>} 
+         * The properties belonging to this DeviceModel.
+        */
         this._properties = {};
 
-        /** @type {Object.<string, Device>} */
+        /** @type {Object.<string, Device>}
+         * The list of devices belonging to this DeviceModel.
+         */
         this._devices = {};
     }
 
     /**
+     * The name of this device model, if any.
      * @param {string} value The name of this device model, if any.
      */
     set name(value) {
         this._name = value;
     }
 
     /**
+     * The description of this device model, if any.
      * @param {string} value The description of this device model, if any.
      */
     set description(value) {
         this._description = value;
     }
 
     /**
+     * The identifier of this instance of DeviceModel object.
      * @returns {string} The identifier of this instance of DeviceModel object.
      */
     get id() {
         return this._deviceModelId;
     }
 
     /**
+     * The identifier of the DataAdapter that this instance
+     * &nbsp;of DeviceModel object originated from.
      * @returns {string} The identifier of the DataAdapter that this instance
      * of DeviceModel object originated from.
      */
@@ -269,41 +278,47 @@ class DeviceModel {
     }
 
     /**
+     * The name of this device model, if any.
      * @returns {string} The name of this device model, if any.
      */
     get name() {
         return this._name;
     }
 
     /**
+     * The description of this device model, if any.
      * @returns {string} The description of this device model, if any.
      */
     get description() {
         return this._description;
     }
 
     /**
+     * All property identifiers for this DeviceModel.
      * @returns {string[]} All property identifiers for this DeviceModel.
      */
     get propertyIds() {
         return Object.keys(this._properties);
     }
 
     /**
+     * The properties belonging to this DeviceModel.
      * @returns {DeviceProperty[]} The properties belonging to this DeviceModel.
      */
     get properties() {
         return Object.values(this._properties);
     }
 
     /**
+     * All device identifiers found within this DeviceModel.
      * @returns {string[]} All device identifiers found within this DeviceModel.
      */
     get deviceIds() {
         return Object.keys(this._devices);
     }
 
     /**
+     * The list of devices belonging to this DeviceModel.
      * @returns {Device[]} The list of devices belonging to this DeviceModel.
      */
     get devices() {

client/data/Hyperion.Data.Storage.js

@@ -312,6 +312,10 @@ class DataStore extends EventSource {
         });
     }
 
+    addDeviceModel(deviceMode) {
+        this._deviceModels[deviceMode.id] = deviceMode;
+    }
+
     /**
      * Creates an instance of DataView object for this DataStore.
      *
@@ -511,5 +515,10 @@ class DataStore extends EventSource {
         let filteredMap = new Map(nestedList.map(obj => [`${obj.id}`, obj]));
         return filteredMap;
     }
+
+
+    get adapters() {
+        return this._dataAdapters;
+    }
 }
 export { DataStore };

package.json

@@ -1,6 +1,6 @@
 {
     "name": "forge-dataviz-iot-data-modules",
-    "version": "0.1.6",
+    "version": "0.1.8",
     "description": "IoT data modules used by https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app",
     "author": "Autodesk Inc",
     "license": "Apache-2.0",

server/gateways/Hyperion.Server.SyntheticGateway.js

@@ -35,7 +35,7 @@ function weekNum(time) {
 class Synthetic {
     /**
      *
-     * @param {string} configFile File path to config file defining the data stops and range values used to generate synthetic data. For an example, refer to https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app/blob/main/server/gateways/synthetic-data/config.js
+     * @param {string} configFile File path to config file defining the data stops and range values used to generate synthetic data. For an example, refer to https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app/blob/main/server/gateways/synthetic-data/config.json
      */
     constructor(configFile) {
         this.configFile = configFile;
@@ -118,7 +118,7 @@ class SyntheticGateway extends DataGateway {
      *
      * @param {string} deviceModelFile File path to JSON file containing device model information. For an example, refer to https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app/blob/main/server/gateways/synthetic-data/device-models.json
      * @param {string} deviceFile File path to JSON file containing device information. For an example, refer to https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app/blob/main/server/gateways/synthetic-data/devices.json
-     * @param {string} configFile File path to config file defining the data stops and range values used to generate synthetic data. For an example, refer to https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app/blob/main/server/gateways/synthetic-data/config.js
+     * @param {string} configFile File path to config file defining the data stops and range values used to generate synthetic data. For an example, refer to https://github.com/Autodesk-Forge/forge-dataviz-iot-reference-app/blob/main/server/gateways/synthetic-data/config.json
      */
     constructor(deviceModelFile, deviceFile, configFile) {
         super("SyntheticGateway");