@ricado/api-client 1.4.1 → 2.0.0

package/src/Models/Site/AlarmModel.js

@@ -4,24 +4,23 @@
  * Do Not Edit this File Manually!
  */
 
-import BaseSiteModel from '../../Models/Site/BaseSiteModel';
+import BaseModel from '../../Models/BaseModel';
 
 /**
  * Model Class for a Alarm
  * 
  * @class
  * @hideconstructor
- * @extends BaseSiteModel
+ * @extends BaseModel
  */
-class AlarmModel extends BaseSiteModel
+class AlarmModel extends BaseModel
 {
     /**
      * AlarmModel Constructor
      * 
      * @protected
-     * @param {number} siteId The Site ID associated with this Alarm
      */
-    constructor(siteId)
+    constructor()
     {
         super();
         
@@ -29,372 +28,137 @@ class AlarmModel extends BaseSiteModel
          * The Alarm ID
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._id = undefined;
+        this.id = undefined;
         
         /**
          * The RTU this Alarm belongs to
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._rtuId = undefined;
+        this.rtuId = undefined;
         
         /**
          * The Alarm Group this Alarm is a part of
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._groupId = undefined;
+        this.groupId = undefined;
         
         /**
          * The Alarm Name
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._name = undefined;
+        this.name = undefined;
         
         /**
          * Whether the Alarm is Critical or not
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._critical = undefined;
+        this.critical = undefined;
         
         /**
          * The Python Script with the Conditions to Trip this Alarm
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._tripScript = undefined;
+        this.tripScript = undefined;
         
         /**
          * The Python Script with the Conditions to Reset this Alarm
          * 
          * @type {?string}
-         * @private
+         * @public
          */
-        this._resetScript = undefined;
+        this.resetScript = undefined;
         
         /**
          * The Delay before this Alarm will Trip in Milliseconds
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._tripDelay = undefined;
+        this.tripDelay = undefined;
         
         /**
          * The Delay before this Alarm will Reset in Milliseconds
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._resetDelay = undefined;
+        this.resetDelay = undefined;
         
         /**
          * Whether the Alarm should Automatically Reset
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._autoReset = undefined;
+        this.autoReset = undefined;
         
         /**
          * The Delay before this Alarm should Auto Reset in Milliseconds
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._autoResetDelay = undefined;
+        this.autoResetDelay = undefined;
         
         /**
          * The Point used to store the Alarm Tripped State
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._trippedStatePoint = undefined;
+        this.trippedStatePoint = undefined;
         
         /**
          * The Point used to store the Alarm Tripped Timestamp
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._trippedTimestampPoint = undefined;
+        this.trippedTimestampPoint = undefined;
         
         /**
          * The Point used to store the Alarm's Internal Trip Start
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._internalTripStartPoint = undefined;
+        this.internalTripStartPoint = undefined;
         
         /**
          * The Point used to store the Alarm's Internal Reset Start
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._internalResetStartPoint = undefined;
+        this.internalResetStartPoint = undefined;
         
         /**
          * Whether the Alarm has been deleted
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._deleted = undefined;
+        this.deleted = undefined;
         
         /**
          * When the Alarm was last updated
          * 
          * @type {Date}
-         * @private
+         * @public
          */
-        this._updateTimestamp = undefined;
-        
-        /**
-         * The Site ID associated with this Alarm
-         * 
-         * @type {number}
-         * @private
-         */
-        this._siteId = siteId;
-    }
-
-    /**
-     * The Alarm ID
-     * 
-     * @public
-     * @type {string}
-     */
-    get id()
-    {
-        return this._id;
-    }
-
-    /**
-     * The RTU this Alarm belongs to
-     * 
-     * @public
-     * @type {?number}
-     */
-    get rtuId()
-    {
-        return this._rtuId;
-    }
-
-    /**
-     * The Alarm Group this Alarm is a part of
-     * 
-     * @public
-     * @type {string}
-     */
-    get groupId()
-    {
-        return this._groupId;
-    }
-
-    /**
-     * The Alarm Name
-     * 
-     * @public
-     * @type {string}
-     */
-    get name()
-    {
-        return this._name;
-    }
-
-    /**
-     * Whether the Alarm is Critical or not
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get critical()
-    {
-        return this._critical;
-    }
-
-    /**
-     * The Python Script with the Conditions to Trip this Alarm
-     * 
-     * @public
-     * @type {string}
-     */
-    get tripScript()
-    {
-        return this._tripScript;
-    }
-
-    /**
-     * The Python Script with the Conditions to Reset this Alarm
-     * 
-     * @public
-     * @type {?string}
-     */
-    get resetScript()
-    {
-        return this._resetScript;
-    }
-
-    /**
-     * The Delay before this Alarm will Trip in Milliseconds
-     * 
-     * @public
-     * @type {number}
-     */
-    get tripDelay()
-    {
-        return this._tripDelay;
-    }
-
-    /**
-     * The Delay before this Alarm will Reset in Milliseconds
-     * 
-     * @public
-     * @type {number}
-     */
-    get resetDelay()
-    {
-        return this._resetDelay;
-    }
-
-    /**
-     * Whether the Alarm should Automatically Reset
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get autoReset()
-    {
-        return this._autoReset;
-    }
-
-    /**
-     * The Delay before this Alarm should Auto Reset in Milliseconds
-     * 
-     * @public
-     * @type {number}
-     */
-    get autoResetDelay()
-    {
-        return this._autoResetDelay;
-    }
-
-    /**
-     * The Point used to store the Alarm Tripped State
-     * 
-     * @public
-     * @type {number}
-     */
-    get trippedStatePoint()
-    {
-        return this._trippedStatePoint;
-    }
-
-    /**
-     * The Point used to store the Alarm Tripped Timestamp
-     * 
-     * @public
-     * @type {number}
-     */
-    get trippedTimestampPoint()
-    {
-        return this._trippedTimestampPoint;
-    }
-
-    /**
-     * The Point used to store the Alarm's Internal Trip Start
-     * 
-     * @public
-     * @type {number}
-     */
-    get internalTripStartPoint()
-    {
-        return this._internalTripStartPoint;
-    }
-
-    /**
-     * The Point used to store the Alarm's Internal Reset Start
-     * 
-     * @public
-     * @type {number}
-     */
-    get internalResetStartPoint()
-    {
-        return this._internalResetStartPoint;
-    }
-
-    /**
-     * Whether the Alarm has been deleted
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get deleted()
-    {
-        return this._deleted;
-    }
-
-    /**
-     * When the Alarm was last updated
-     * 
-     * @public
-     * @type {Date}
-     */
-    get updateTimestamp()
-    {
-        return this._updateTimestamp;
-    }
-
-    /**
-     * The Site ID associated with this Alarm
-     * 
-     * @public
-     * @type {number}
-     */
-    get siteId()
-    {
-        return this._siteId;
-    }
-
-    /**
-     * Convert this **AlarmModel** to a JSON Object
-     * 
-     * @public
-     * @return {Object<string, any>}
-     */
-    toJSON()
-    {
-        return {
-            id: this._id,
-            rtuId: this._rtuId,
-            groupId: this._groupId,
-            name: this._name,
-            critical: this._critical,
-            tripScript: this._tripScript,
-            resetScript: this._resetScript,
-            tripDelay: this._tripDelay,
-            resetDelay: this._resetDelay,
-            autoReset: this._autoReset,
-            autoResetDelay: this._autoResetDelay,
-            trippedStatePoint: this._trippedStatePoint,
-            trippedTimestampPoint: this._trippedTimestampPoint,
-            internalTripStartPoint: this._internalTripStartPoint,
-            internalResetStartPoint: this._internalResetStartPoint,
-            deleted: this._deleted,
-            updateTimestamp: this._updateTimestamp
-        };
+        this.updateTimestamp = undefined;
     }
 
     /**
@@ -403,12 +167,11 @@ class AlarmModel extends BaseSiteModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
-     * @param {number} siteId The Site ID associated with this Alarm
      * @return {AlarmModel}
      */
-    static fromJSON(json, siteId)
+    static fromJSON(json)
     {
-        let model = new AlarmModel(siteId);
+        let model = new AlarmModel();
         
         /**
          * The JSON Object
@@ -428,7 +191,7 @@ class AlarmModel extends BaseSiteModel
         
         if('id' in jsonObject)
         {
-            model._id = (function(){
+            model.id = (function(){
                 if(typeof jsonObject['id'] !== 'string')
                 {
                     return String(jsonObject['id']);
@@ -440,7 +203,7 @@ class AlarmModel extends BaseSiteModel
         
         if('rtuId' in jsonObject)
         {
-            model._rtuId = (function(){
+            model.rtuId = (function(){
                 if(jsonObject['rtuId'] === null)
                 {
                     return null;
@@ -457,7 +220,7 @@ class AlarmModel extends BaseSiteModel
         
         if('groupId' in jsonObject)
         {
-            model._groupId = (function(){
+            model.groupId = (function(){
                 if(typeof jsonObject['groupId'] !== 'string')
                 {
                     return String(jsonObject['groupId']);
@@ -469,7 +232,7 @@ class AlarmModel extends BaseSiteModel
         
         if('name' in jsonObject)
         {
-            model._name = (function(){
+            model.name = (function(){
                 if(typeof jsonObject['name'] !== 'string')
                 {
                     return String(jsonObject['name']);
@@ -481,7 +244,7 @@ class AlarmModel extends BaseSiteModel
         
         if('critical' in jsonObject)
         {
-            model._critical = (function(){
+            model.critical = (function(){
                 if(typeof jsonObject['critical'] !== 'boolean')
                 {
                     return Boolean(jsonObject['critical']);
@@ -493,7 +256,7 @@ class AlarmModel extends BaseSiteModel
         
         if('tripScript' in jsonObject)
         {
-            model._tripScript = (function(){
+            model.tripScript = (function(){
                 if(typeof jsonObject['tripScript'] !== 'string')
                 {
                     return String(jsonObject['tripScript']);
@@ -505,7 +268,7 @@ class AlarmModel extends BaseSiteModel
         
         if('resetScript' in jsonObject)
         {
-            model._resetScript = (function(){
+            model.resetScript = (function(){
                 if(jsonObject['resetScript'] === null)
                 {
                     return null;
@@ -522,7 +285,7 @@ class AlarmModel extends BaseSiteModel
         
         if('tripDelay' in jsonObject)
         {
-            model._tripDelay = (function(){
+            model.tripDelay = (function(){
                 if(typeof jsonObject['tripDelay'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['tripDelay'])) ? Number(jsonObject['tripDelay']) : Math.floor(Number(jsonObject['tripDelay']));
@@ -534,7 +297,7 @@ class AlarmModel extends BaseSiteModel
         
         if('resetDelay' in jsonObject)
         {
-            model._resetDelay = (function(){
+            model.resetDelay = (function(){
                 if(typeof jsonObject['resetDelay'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['resetDelay'])) ? Number(jsonObject['resetDelay']) : Math.floor(Number(jsonObject['resetDelay']));
@@ -546,7 +309,7 @@ class AlarmModel extends BaseSiteModel
         
         if('autoReset' in jsonObject)
         {
-            model._autoReset = (function(){
+            model.autoReset = (function(){
                 if(typeof jsonObject['autoReset'] !== 'boolean')
                 {
                     return Boolean(jsonObject['autoReset']);
@@ -558,7 +321,7 @@ class AlarmModel extends BaseSiteModel
         
         if('autoResetDelay' in jsonObject)
         {
-            model._autoResetDelay = (function(){
+            model.autoResetDelay = (function(){
                 if(typeof jsonObject['autoResetDelay'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['autoResetDelay'])) ? Number(jsonObject['autoResetDelay']) : Math.floor(Number(jsonObject['autoResetDelay']));
@@ -570,7 +333,7 @@ class AlarmModel extends BaseSiteModel
         
         if('trippedStatePoint' in jsonObject)
         {
-            model._trippedStatePoint = (function(){
+            model.trippedStatePoint = (function(){
                 if(typeof jsonObject['trippedStatePoint'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['trippedStatePoint'])) ? Number(jsonObject['trippedStatePoint']) : Math.floor(Number(jsonObject['trippedStatePoint']));
@@ -582,7 +345,7 @@ class AlarmModel extends BaseSiteModel
         
         if('trippedTimestampPoint' in jsonObject)
         {
-            model._trippedTimestampPoint = (function(){
+            model.trippedTimestampPoint = (function(){
                 if(typeof jsonObject['trippedTimestampPoint'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['trippedTimestampPoint'])) ? Number(jsonObject['trippedTimestampPoint']) : Math.floor(Number(jsonObject['trippedTimestampPoint']));
@@ -594,7 +357,7 @@ class AlarmModel extends BaseSiteModel
         
         if('internalTripStartPoint' in jsonObject)
         {
-            model._internalTripStartPoint = (function(){
+            model.internalTripStartPoint = (function(){
                 if(typeof jsonObject['internalTripStartPoint'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['internalTripStartPoint'])) ? Number(jsonObject['internalTripStartPoint']) : Math.floor(Number(jsonObject['internalTripStartPoint']));
@@ -606,7 +369,7 @@ class AlarmModel extends BaseSiteModel
         
         if('internalResetStartPoint' in jsonObject)
         {
-            model._internalResetStartPoint = (function(){
+            model.internalResetStartPoint = (function(){
                 if(typeof jsonObject['internalResetStartPoint'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['internalResetStartPoint'])) ? Number(jsonObject['internalResetStartPoint']) : Math.floor(Number(jsonObject['internalResetStartPoint']));
@@ -618,7 +381,7 @@ class AlarmModel extends BaseSiteModel
         
         if('deleted' in jsonObject)
         {
-            model._deleted = (function(){
+            model.deleted = (function(){
                 if(typeof jsonObject['deleted'] !== 'boolean')
                 {
                     return Boolean(jsonObject['deleted']);
@@ -630,7 +393,7 @@ class AlarmModel extends BaseSiteModel
         
         if('updateTimestamp' in jsonObject)
         {
-            model._updateTimestamp = (function(){
+            model.updateTimestamp = (function(){
                 if(typeof jsonObject['updateTimestamp'] !== 'string')
                 {
                     return new Date(String(jsonObject['updateTimestamp']));