Change OCPP classes methods scope to protected
[e-mobility-charging-stations-simulator.git] / src / utils / CircularArray.ts
index 5dab1e2c072425a894b3a641e063aafc4c0f9198..93dacdb0ee8d421f592ff6b05e31ef1b23b9acc4 100644 (file)
@@ -1,24 +1,85 @@
-import Constants from './Constants';
+export const DEFAULT_CIRCULAR_ARRAY_SIZE = 2000;
 
-export default class CircularArray<T> extends Array<T> {
+/** Array with a maximum length shifting items when full. */
+export class CircularArray<T> extends Array<T> {
   public size: number;
 
-  constructor(size: number = Constants.MAXIMUM_MEASUREMENTS_NUMBER) {
+  constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) {
     super();
+    this.checkSize(size);
     this.size = size;
+    if (arguments.length > 1) {
+      this.push(...items);
+    }
+  }
+
+  public push(...items: T[]): number {
+    const length = super.push(...items);
+    if (length > this.size) {
+      super.splice(0, length - this.size);
+    }
+    return this.length;
+  }
+
+  public unshift(...items: T[]): number {
+    const length = super.unshift(...items);
+    if (length > this.size) {
+      super.splice(this.size, items.length);
+    }
+    return this.length;
+  }
+
+  public concat(...items: (T | ConcatArray<T>)[]): CircularArray<T> {
+    const concatenatedCircularArray = super.concat(
+      items as T[]
+    ) as CircularArray<T>;
+    concatenatedCircularArray.size = this.size;
+    if (concatenatedCircularArray.length > concatenatedCircularArray.size) {
+      concatenatedCircularArray.splice(
+        0,
+        concatenatedCircularArray.length - concatenatedCircularArray.size
+      );
+    }
+    return concatenatedCircularArray;
   }
 
-  push(...items: T[]): number {
-    while (this.length > this.size) {
-      this.shift();
+  public splice(start: number, deleteCount?: number, ...items: T[]): T[] {
+    let itemsRemoved: T[];
+    if (arguments.length >= 3 && typeof deleteCount !== 'undefined') {
+      itemsRemoved = super.splice(start, deleteCount);
+      // FIXME: that makes the items insert not in place
+      this.push(...items);
+    } else if (arguments.length === 2) {
+      itemsRemoved = super.splice(start, deleteCount);
+    } else {
+      itemsRemoved = super.splice(start);
     }
-    return super.push(...items);
+    return itemsRemoved;
+  }
+
+  public resize(size: number): void {
+    this.checkSize(size);
+    if (size === 0) {
+      this.length = 0;
+    } else if (size < this.size) {
+      for (let i = size; i < this.size; i++) {
+        super.pop();
+      }
+    }
+    this.size = size;
+  }
+
+  public empty(): boolean {
+    return this.length === 0;
+  }
+
+  public full(): boolean {
+    return this.length === this.size;
   }
 
-  unshift(...items: T[]): number {
-    while (this.length > this.size) {
-      this.pop();
+  private checkSize(size: number) {
+    if (size < 0) {
+      throw new RangeError('Invalid circular array size');
     }
-    return super.unshift(...items);
   }
 }