@enervance/insight-cim-model 0.0.1 → 0.0.3

package/src/model/wires/EnergySource.ts

@@ -1,29 +1,29 @@
-import {ConductingEquipment} from '../core/ConductingEquipment';
+import { ConductingEquipment } from '../core/ConductingEquipment';
 import { Voltage } from '../domain/Voltage';
 import { Model } from '../model/Model';
 import { ConnectivityNode } from '../core/ConnectivityNode';
 
 import { DiagramObject } from '../diagram/DiagramObject';
-import {IRectangleShapeInfo, ISchemaSettings} from '../../interfaces/schema-settings/ShapeInfos';
+import { IRectangleShapeInfo, ISchemaSettings } from '../../interfaces/schema-settings/ShapeInfos';
 import { getValue, writeElement, writeElementAttribute } from '../../util/utils';
 import { CIM_CLASS_NAMES } from '../../constants/cim-class-names';
 
 import {
-    NS_PREFIX_AFN,
-    NS_PREFIX_APF,
-    NS_PREFIX_CIM,
-    NS_PREFIX_ENERVANCE,
-    NS_PREFIX_ENTSOE,
-    NS_PREFIX_RDF,
+  NS_PREFIX_AFN,
+  NS_PREFIX_APF,
+  NS_PREFIX_CIM,
+  NS_PREFIX_ENERVANCE,
+  NS_PREFIX_ENTSOE,
+  NS_PREFIX_RDF,
 } from '../../util/sparql/sparql-building-block';
 import { convertValue } from '../../util/datatype-converter';
 import XMLWriter from 'xml-writer';
 import { RDF_XML } from '../../constants/rdf-xml';
 import { IConnectivityNode, IdentifiedObject } from "../..";
 
-export class EnergySource extends ConductingEquipment{
+export class EnergySource extends ConductingEquipment {
 
-    public static sparqlQuery : string = `
+  public static sparqlQuery: string = `
         ${NS_PREFIX_CIM} 
         ${NS_PREFIX_ENERVANCE} 
         ${NS_PREFIX_ENTSOE} 
@@ -70,234 +70,268 @@ export class EnergySource extends ConductingEquipment{
         ?r ?r0 ?rx ?x ?x0 ?xn ?nominalVoltage ?voltageMagnitude ?voltageAngle ?ecUUID ?ptUUID
     `
 
-    activePower: number;
-    reactivePower: number;
-    
-    r: number;
-    r0: number;
-    rn: number;
-    x: number;
-    x0: number;
-    xn: number;
-
-   nominalVoltage: Voltage;
-   nominalVoltageValue: number;
-   //voltageMagnitude
-   //voltageAngle
-
-
-    constructor(uuid?: string, name?: string, shortName?: string, description?: string){
-        super(uuid, name, shortName, description);
-
-        this.prop2namespacePrefix.set('activePower', 'cim'); // zur Generierung der Insert-Statements
-        this.prop2Class.set('activePower', 'EnergySource');
-        this.prop2Datatype.set('activePower', 'number');
-
-        this.prop2namespacePrefix.set('reactivePower', 'cim'); // zur Generierung der Insert-Statements
-        this.prop2Class.set('reactivePower', 'EnergySource');
-        this.prop2Datatype.set('reactivePower', 'number');
-
-    }
-
-    public print(){
-        super.print();
-        console.log('\tactivePower ' + this.activePower + ' reactivePower ' + this.reactivePower);
-    }
-
-
-    public toGeoJSON (geoJSON: any, profile: string, schemaSettings: ISchemaSettings, diagramObject?: DiagramObject): any {
-
-        const coordinates : number[] = diagramObject.computeRectBounds(diagramObject);
-        const shapeInfos: IRectangleShapeInfo = schemaSettings.getRectangleShapeInfo(profile);
-
-        const x = coordinates[0];
-        const y = coordinates[1] * -1;
-        const width = coordinates[2] == 1 ? +shapeInfos.width : coordinates[2];
-        const height = (coordinates[3] == 1 ? +shapeInfos.height : coordinates[3]) * -1;
-        const offsetX = width == 1 ? +width/2 : 0;
-        const offsetY = height == 1 ? +height/2 : 0;
-
-        if(x != 0 && y != 0 && width != 0 && height != 0) {
-            super.toGeoJSON(geoJSON, profile, schemaSettings, diagramObject);
-
-            const pointsPolygon : number[][][] = [
-                [
-                    [x - offsetX, y - offsetY], 
-                    [x + width, y], 
-                    [x + width, y + height], 
-                    [x, y + height], 
-                    [x - offsetX, y - offsetY]
-                ]
-            ];
-            geoJSON['geometry'] = {
-                type: 'Polygon',
-                coordinates: pointsPolygon
-            }
-
-            geoJSON['properties'] = {
-                diagramObjectUUID: diagramObject.mrid,
-                objectType: this.constructor.name,
-            }
-        }
-        return geoJSON;
-    }
-
-    public static getQuerySPARQL(graphURI : string) : string{
-        if(graphURI.length > 0){
-            return EnergySource.sparqlQuery.replace('<http://default/>', graphURI);
-        }
-        return EnergySource.sparqlQuery;
-    }
-
-    public static resolveClassFusekiJSON(data: any, cimModel: Model){
-        data.results.bindings.forEach((value: any) => {
-            const newClass = new EnergySource();
-            newClass.resolveAttributesFusekiJSON(value);
-            cimModel.addEnergySource(newClass);
-        });
-    }
-
-	protected resolveAttributesFusekiJSON(value: any){
-        super.resolveAttributesFusekiJSON(value);
-        this.activePower = +getValue(value, 'activePower');
-        this.reactivePower = +getValue(value, 'reactivePower');
-        this.nominalVoltageValue = +getValue(value, 'nominalVoltage');
-	}
-	public resolveParsedAssociations(cimModel: Model){
-        super.resolveParsedAssociations(cimModel);
-        const voltage = cimModel.getVoltage(this.nominalVoltageValue)
-        this.nominalVoltage = voltage;
-    }
-    
-
-
-    public toJSON(){
-        super.toJSON();
-        this.toJSONAttributes();
-        this.toJSONAssociations();
-        return this.json; 
-    }
-
-    public toJSONAttributes(){
-        super.toJSONAttributes();
-        this.json['activePower'] = this.activePower; 
-        this.json['reactivePower'] = this.reactivePower; 
-
+  activePower: number;
+  reactivePower: number;
+
+  r: number;
+  r0: number;
+  rn: number;
+  x: number;
+  x0: number;
+  xn: number;
+
+  nominalVoltage: Voltage;
+  nominalVoltageValue: number;
+  //voltageMagnitude
+  //voltageAngle
+
+
+  constructor(uuid?: string, name?: string, shortName?: string, description?: string) {
+    super(uuid, name, shortName, description);
+
+    this.prop2namespacePrefix.set('activePower', 'cim'); // zur Generierung der Insert-Statements
+    this.prop2Class.set('activePower', 'EnergySource');
+    this.prop2Datatype.set('activePower', 'number');
+
+    this.prop2namespacePrefix.set('reactivePower', 'cim'); // zur Generierung der Insert-Statements
+    this.prop2Class.set('reactivePower', 'EnergySource');
+    this.prop2Datatype.set('reactivePower', 'number');
+
+  }
+
+  public print() {
+    super.print();
+    console.log('\tactivePower ' + this.activePower + ' reactivePower ' + this.reactivePower);
+  }
+
+
+  public toGeoJSON(geoJSON: any, profile: string, schemaSettings: ISchemaSettings, diagramObject?: DiagramObject): any {
+
+    const coordinates: number[] = diagramObject.computeRectBounds(diagramObject);
+    const shapeInfos: IRectangleShapeInfo = schemaSettings.getRectangleShapeInfo(profile);
+
+    const x = coordinates[0];
+    const y = coordinates[1] * -1;
+    const width = coordinates[2] == 1 ? +shapeInfos.width : coordinates[2];
+    const height = (coordinates[3] == 1 ? +shapeInfos.height : coordinates[3]) * -1;
+    const offsetX = width == 1 ? +width / 2 : 0;
+    const offsetY = height == 1 ? +height / 2 : 0;
+
+    if (x != 0 && y != 0 && width != 0 && height != 0) {
+      super.toGeoJSON(geoJSON, profile, schemaSettings, diagramObject);
+
+      const pointsPolygon: number[][][] = [
+        [
+          [x - offsetX, y - offsetY],
+          [x + width, y],
+          [x + width, y + height],
+          [x, y + height],
+          [x - offsetX, y - offsetY]
+        ]
+      ];
+      geoJSON['geometry'] = {
+        type: 'Polygon',
+        coordinates: pointsPolygon
+      }
+
+      geoJSON['properties'] = {
+        diagramObjectUUID: diagramObject.mrid,
+        objectType: this.constructor.name,
+      }
     }
+    return geoJSON;
+  }
 
-    public toJSONAssociations(){
-        super.toJSONAssociations();
+  public static getQuerySPARQL(graphURI: string): string {
+    if (graphURI.length > 0) {
+      return EnergySource.sparqlQuery.replace('<http://default/>', graphURI);
     }
-
-    public determineGridIslands(networkElements: any []){
-        super.determineGridIslands(networkElements);
+    return EnergySource.sparqlQuery;
+  }
+
+  public static resolveClassFusekiJSON(data: any, cimModel: Model) {
+    data.results.bindings.forEach((value: any) => {
+      const newClass = new EnergySource();
+      newClass.resolveAttributesFusekiJSON(value);
+      cimModel.addEnergySource(newClass);
+    });
+  }
+
+  protected resolveAttributesFusekiJSON(value: any) {
+    super.resolveAttributesFusekiJSON(value);
+    this.activePower = +getValue(value, 'activePower');
+    this.reactivePower = +getValue(value, 'reactivePower');
+    this.nominalVoltageValue = +getValue(value, 'nominalVoltage');
+  }
+
+  public resolveParsedAssociations(cimModel: Model) {
+    super.resolveParsedAssociations(cimModel);
+    const voltage = cimModel.getVoltage(this.nominalVoltageValue)
+    this.nominalVoltage = voltage;
+  }
+
+
+  public toJSON() {
+    super.toJSON();
+    this.toJSONAttributes();
+    this.toJSONAssociations();
+    return this.json;
+  }
+
+  public toJSONAttributes() {
+    super.toJSONAttributes();
+    this.json['activePower'] = this.activePower;
+    this.json['reactivePower'] = this.reactivePower;
+
+  }
+
+  public toJSONAssociations() {
+    super.toJSONAssociations();
+  }
+
+  public determineGridIslands(networkElements: any []) {
+    super.determineGridIslands(networkElements);
+  }
+
+  public breadthFirstSearch(networkElements: any[]) {
+    if (!this.visited) {
+      this.addNetworkElement(networkElements);
+      super.breadthFirstSearch(networkElements);
     }
+  }
+
+  //hier endet der Aufruf
+  public determineTopologicalNodes(connNodes: IConnectivityNode[]) {
+    return;
+  }
+
+  public isLoadOrFeed(): boolean {
+    return true;
+  }
+
+  public getApparentPower() {
+    return Math.sqrt(Math.pow(this.activePower ? this.activePower : 0, 2) +
+      Math.pow(this.reactivePower ? this.reactivePower : 0, 2));
+  }
+
+  /** die Methode bestimmen den Datentyp, konvertiert und weist den Wert zu */
+  /*    public setProperty(cimModel: Model, propName: string, propertyValue: any){
+          const dataType: string = this.prop2Datatype.get(propName);
+
+          if(dataType) {
+              if(CIM_CLASS_NAMES[dataType]) { // komplexer Datentyp
+                  this.setAssociation(cimModel, propName, propertyValue);
+              } else { // primitiver Datentyp
+                  this[propName] = convertValue(dataType, propertyValue);
+              }
+          }
+      }*/
+
+
+  /** die Methode gibt basierend auf der aktuellen Ausprägung des übergebenen Property
+   * ein SPARQL-INSERT Statement zurück.
+   * 2 Szearien:
+   *      Löschen der aktuellen Ausprägung -> wird im DELETE DATA Block platziert.
+   *      Einfügen der aktuellen Ausprägung -> wird im INSERT DATA Block platziert. */
+
+  /*    public getUpdateSPARQL(className: string, propName: string): string  {
+          if(this.constructor.name === className) {
+              const dataType: string = this.prop2Datatype.get(propName);
+              if(CIM_CLASS_NAMES[dataType]) { // komplexer Datentyp
+                 return super.getUpdateSPARQL(className, propName);
+              } else {
+                  const propValue = String(this[propName]); // aktuelle Ausprägung auslesen
+
+                  const propNS = this.prop2namespacePrefix.get(String(propName));
+                  const propClassName = this.prop2Class.get(String(propName));
+                  if(propNS) {
+                      return `<${this.baseIRI}${this.mrid}> ${propNS}:${propClassName}.${propName} \'${propValue}\' . `;
+                  }
+              }
+          } else {
+              //TODO überarbeiten
+              return super.getUpdateSPARQL(className, propName);
+          }
+          return;
+      }*/
+
+
+  /** CIM RDF/XML Serialisierung */
+  public toCIMXML(xmlWriter: XMLWriter, profile: string) {
+    let defaultValues = '';
+    this.checkMandatoryAttributes(profile, defaultValues);
+    this.description += defaultValues;
+    if (profile === RDF_XML.PROFILE_EQ) {
+      const suffixID = this.getSuffixID(profile);
+      const prefixUUID = this.getPrefixUUID(suffixID);
+      xmlWriter.startElementNS(RDF_XML.CIM_NS_PREFIX, this.constructor.name, RDF_XML.CIM_NS_16);
+      writeElementAttribute(xmlWriter, suffixID, `${prefixUUID}${this.mrid}`);
+      this.toCIMXMLAttributes(xmlWriter, profile);
+      this.toCIMXMLAssociations(xmlWriter, profile);
+      xmlWriter.endElement();
+    } else if (profile === RDF_XML.PROFILE_SSH && this.checkExportData(profile)) {
 
-    public breadthFirstSearch(networkElements: any[]){
-        if(!this.visited){
-            this.addNetworkElement(networkElements);
-            super.breadthFirstSearch(networkElements);
-        }
     }
+  }
 
-    //hier endet der Aufruf
-    public determineTopologicalNodes(connNodes: IConnectivityNode[]){
-        return;
+  protected toCIMXMLAttributes(xmlWriter: XMLWriter, profile: string) {
+    super.toCIMXMLAttributes(xmlWriter, profile);
+    if (profile === RDF_XML.PROFILE_SSH && this.checkExportData(profile)) {
+      writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:${this.constructor.name}.activePower`, this.activePower);
+      writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:${this.constructor.name}.reactivePower`, this.reactivePower);
     }
-
-    public isLoadOrFeed(): boolean{
+  }
+
+  protected toCIMXMLAssociations(xmlWriter: XMLWriter, profile: string) {
+    super.toCIMXMLAssociations(xmlWriter, profile);
+  }
+
+  /** Die Methode überprüft, ob für die übergebene ProfilURI
+   * relevante Informationen gepflegt sind.
+   * @param profile URI des Profils. */
+  checkExportData(profile: string): boolean {
+    if (profile === RDF_XML.PROFILE_SSH) {
+      if (this.activePower || !this.reactivePower) {
         return true;
+      }
     }
-
-    public getApparentPower() {
-        return Math.sqrt(Math.pow(this.activePower ? this.activePower : 0, 2) +
-                            Math.pow(this.reactivePower ? this.reactivePower : 0, 2));
+    return false;
+  }
+
+  checkMandatoryAttributes(profile: string, defaultValues: string) {
+    super.checkMandatoryAttributes(profile, defaultValues);
+    if (profile === RDF_XML.PROFILE_SSH) {
+      if (!this.activePower) {
+        this.activePower = 0;
+        defaultValues += 'activePower,'
+      }
+      if (!this.reactivePower) {
+        this.reactivePower = 0;
+        defaultValues += 'reactivePower,'
+      }
     }
+  }
 
-    /** die Methode bestimmen den Datentyp, konvertiert und weist den Wert zu */
-/*    public setProperty(cimModel: Model, propName: string, propertyValue: any){
-        const dataType: string = this.prop2Datatype.get(propName);
+  /** CIM XML Parser */
+  public static resolveClassRDFXML(uuid: string, cimModel: Model): IdentifiedObject | undefined {
+    const newClass = new EnergySource(uuid);
+    cimModel.addEnergySource(newClass);
+    return newClass;
+  }
 
-        if(dataType) {
-            if(CIM_CLASS_NAMES[dataType]) { // komplexer Datentyp
-                this.setAssociation(cimModel, propName, propertyValue);
-            } else { // primitiver Datentyp
-                this[propName] = convertValue(dataType, propertyValue);
-            }
-        }
-    }*/
-
-
-    /** die Methode gibt basierend auf der aktuellen Ausprägung des übergebenen Property
-     * ein SPARQL-INSERT Statement zurück.
-     * 2 Szearien:
-     *      Löschen der aktuellen Ausprägung -> wird im DELETE DATA Block platziert.
-     *      Einfügen der aktuellen Ausprägung -> wird im INSERT DATA Block platziert. */
-/*    public getUpdateSPARQL(className: string, propName: string): string  {
-        if(this.constructor.name === className) {
-            const dataType: string = this.prop2Datatype.get(propName);
-            if(CIM_CLASS_NAMES[dataType]) { // komplexer Datentyp
-               return super.getUpdateSPARQL(className, propName);
-            } else {
-                const propValue = String(this[propName]); // aktuelle Ausprägung auslesen
-
-                const propNS = this.prop2namespacePrefix.get(String(propName));
-                const propClassName = this.prop2Class.get(String(propName));
-                if(propNS) {
-                    return `<${this.baseIRI}${this.mrid}> ${propNS}:${propClassName}.${propName} \'${propValue}\' . `;
-                }
-            }
-        } else {
-            //TODO überarbeiten
-            return super.getUpdateSPARQL(className, propName);
-        }
-        return;
-    }*/
-
-
-    /** CIM RDF/XML Serialisierung */
-    public toCIMXML(xmlWriter: XMLWriter, profile: string) {
-        if(profile === RDF_XML.PROFILE_EQ || profile === RDF_XML.PROFILE_SSH) {
-            const suffixID =  this.getSuffixID(profile);
-            const prefixUUID = this.getPrefixUUID(suffixID);
-            xmlWriter.startElementNS(RDF_XML.CIM_NS_PREFIX, this.constructor.name, RDF_XML.CIM_NS_16);
-            writeElementAttribute(xmlWriter, suffixID, `${prefixUUID}${this.mrid}`);
-            this.toCIMXMLAttributes(xmlWriter, profile);
-            this.toCIMXMLAssociations(xmlWriter, profile);
-            xmlWriter.endElement();
-        }
-    }
+  public resolveAttributesRDFXML(className: string, attrName: string, value: string) {
+    if (className === 'EnergySource') {
 
-    protected toCIMXMLAttributes(xmlWriter: XMLWriter, profile: string) {
-        super.toCIMXMLAttributes(xmlWriter, profile);
-        if(profile === RDF_XML.PROFILE_SSH) {
-            writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:${this.constructor.name}.activePower`, this.activePower);
-            writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:${this.constructor.name}.reactivePower`, this.reactivePower);
-        }
+    } else {
+      super.resolveAttributesRDFXML(className, attrName, value);
     }
+  }
 
-    protected toCIMXMLAssociations(xmlWriter: XMLWriter, profile: string) {
-        super.toCIMXMLAssociations(xmlWriter, profile);
-    }
+  public resolveAssociationRDFXML(className: string, resourceName: string, resourceUUID: string) {
+    if (className === 'EnergySource') {
 
-    /** CIM XML Parser */
-    public static resolveClassRDFXML(uuid: string, cimModel: Model): IdentifiedObject | undefined {
-        const newClass = new EnergySource(uuid);
-        cimModel.addEnergySource(newClass);
-        return newClass;
-    }
-    public resolveAttributesRDFXML(className: string, attrName: string, value: string){
-        if(className === 'EnergySource') {
-
-        } else {
-            super.resolveAttributesRDFXML(className, attrName, value);
-        }
-    }
-    public resolveAssociationRDFXML(className: string,  resourceName: string, resourceUUID: string){
-        if(className === 'EnergySource') {
-
-        } else {
-            super.resolveAssociationRDFXML(className,  resourceName, resourceUUID);
-        }
+    } else {
+      super.resolveAssociationRDFXML(className, resourceName, resourceUUID);
     }
+  }
 }