@enervance/insight-cim-model 0.0.12 → 0.0.14

package/src/model/core/ACDCTerminal.ts

@@ -1,63 +0,0 @@
-import { Model } from "../model/Model";
-import { convertValue, toBoolean } from '../../util/datatype-converter';
-import { getValue, writeElement } from '../../util/utils';
-import { RDF_XML } from '../../constants/rdf-xml';
-import XMLWriter from 'xml-writer';
-import { IdentifiedObject } from './IdentifiedObject';
-import { IACDCTerminal } from '../../interfaces/model/core/IACDCTerminal';
-
-
-export abstract class ACDCTerminal extends IdentifiedObject implements IACDCTerminal {
-
-  sequenceNumber: number;
-  connected: boolean = true; //per default geschlossen
-
-  protected constructor(mrid?: string, name?: string, shortName?: string, description?: string, sequenceNumber?: number) {
-    super(mrid, name, shortName, description);
-    this.sequenceNumber = sequenceNumber ?? 0;
-
-    this.prop2namespacePrefix.set('sequenceNumber', 'cim'); // zur Generierung der Insert-Statements
-    this.prop2Class.set('sequenceNumber', 'ACDCTerminal');
-    this.prop2Datatype.set('sequenceNumber', 'number');
-    this.property2type.set('sequenceNumber', 'property');
-
-    this.prop2namespacePrefix.set('connected', 'cim'); // zur Generierung der Insert-Statements
-    this.prop2Class.set('connected', 'ACDCTerminal');
-    this.prop2Datatype.set('connected', 'boolean');
-    this.property2type.set('connected', 'property');
-  }
-
-  protected toCIMXMLAttributes(xmlWriter: XMLWriter, profile: string) {
-    super.toCIMXMLAttributes(xmlWriter, profile);
-    if (profile === RDF_XML.PROFILE_EQ) {
-      writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:ACDCTerminal.sequenceNumber`, this.sequenceNumber);
-    } else if (profile === RDF_XML.PROFILE_SSH) {
-      writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:ACDCTerminal.connected`, this.connected);
-    }
-  }
-
-  protected resolveAttributesFusekiJSON(value: any) {
-    super.resolveAttributesFusekiJSON(value);
-    this.sequenceNumber = +getValue(value, 'sequenceNumber');
-    this.connected = toBoolean(getValue(value, 'connected'));
-
-  }
-
-  public resolveParsedAssociations(cimModel: Model) {
-    super.resolveParsedAssociations(cimModel);
-  }
-
-  public resolveAttributesRDFXML(className: string, attrName: string, value: string) {
-    if (className === 'ACDCTerminal') {
-      const dataType = this.prop2Datatype.get(attrName);
-      if (dataType) {
-        this[attrName] = convertValue(dataType, value);
-      }
-    } else {
-      super.resolveAttributesRDFXML(className, attrName, value);
-    }
-  }
-
-  public resolveAssociationRDFXML(className: string, resourceName: string, resourceUUID: string) {
-  }
-}

package/src/model/core/BaseVoltage.ts

@@ -1,129 +0,0 @@
-import { IdentifiedObject } from './IdentifiedObject';
-import { Voltage } from "../domain/Voltage";
-import { Model } from "../model/Model";
-import { getValue, writeElement, writeElementAttribute } from '../../util/utils';
-import { RDF_XML } from '../../constants/rdf-xml';
-import XMLWriter from 'xml-writer';
-
-export class BaseVoltage extends IdentifiedObject {
-
-  nominalVoltage: Voltage | undefined;
-  nominalVoltageValue: number = 0;
-
-  constructor(uuid?: string, name?: string, shortName?: string, description?: string) {
-    super(uuid, name, shortName, description);
-  }
-
-  public static getQuerySPARQL(graphURI: string): string {
-    if (graphURI.length > 0) {
-      return BaseVoltage.sparqlQuery.replace("<http://default/>", graphURI);
-    }
-    return BaseVoltage.sparqlQuery;
-  }
-
-
-  public static sparqlQuery: string = `
-                PREFIX cim:	 		<http://iec.ch/TC57/2013/CIM-schema-cim16#> 
-                PREFIX enervance:	<http://enervance.com/CIM/Extensions#> 
-                PREFIX entsoe:	 	<http://entsoe.eu/CIM/SchemaExtension/3/1#> 
-                PREFIX rdf:	 		<http://www.w3.org/1999/02/22-rdf-syntax-ns#> 
-                PREFIX amp:	 		<http://amprion.net/2018/cim_extensions#> 
-                PREFIX apf:	 		<http://jena.hpl.hp.com/ARQ/property#>
-                PREFIX afn:	 		<http://jena.apache.org/ARQ/function#>
-                
-                SELECT  (strafter(strafter(str(?bvUUID), "#"), "_") AS ?uuid) 
-                ?name ?shortName ?description ?nominalVoltage
-                
-                WHERE { 
-                    GRAPH <http://default/>{
-                    
-                        ?bvUUID rdf:type cim:BaseVoltage .
-                        OPTIONAL{?bvUUID cim:IdentifiedObject.name ?name .}
-                        OPTIONAL{?bvUUID entsoe:IdentifiedObject.shortName ?shortName .}
-                        OPTIONAL{?bvUUID cim:IdentifiedObject.description ?description .}
-                        OPTIONAL{?bvUUID cim:BaseVoltage.nominalVoltage ?nominalVoltage .}
-                    }
-                }
-    `
-
-  public static resolveClassFusekiJSON(data: any, cimModel: Model) {
-    data.results.bindings.forEach((value: any) => {
-      const baseVoltage = new BaseVoltage();
-      baseVoltage.resolveAttributesFusekiJSON(value);
-      cimModel.addBaseVoltage(baseVoltage);
-    });
-  }
-
-  protected resolveAttributesFusekiJSON(value: any) {
-    super.resolveAttributesFusekiJSON(value);
-    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();
-    if (this.nominalVoltage) {
-      this.json['nominalVoltage'] = this.nominalVoltage.value;
-    } else {
-      this.json['nominalVoltage'] = 'none';
-    }
-  }
-
-  public toJSONAssociations() {
-    super.toJSONAssociations();
-    // this.json['substationUUID'] = this.substationUUID;
-  }
-
-  /** CIM RDF/XML Serialisierung */
-  public toCIMXML(xmlWriter: XMLWriter, profile: string) {
-    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();
-    }
-  }
-
-
-  protected toCIMXMLAttributes(xmlWriter: XMLWriter, profile: string) {
-    super.toCIMXMLAttributes(xmlWriter, profile);
-    if (profile === RDF_XML.PROFILE_EQ) {
-      writeElement(xmlWriter, `${RDF_XML.CIM_NS_PREFIX}:BaseVoltage.nominalVoltage`, String(this.nominalVoltage.value));
-    }
-  }
-
-  protected toCIMXMLAssociations(xmlWriter: XMLWriter, profile: string) {
-    super.toCIMXMLAssociations(xmlWriter, profile);
-  }
-
-
-  /** ------------------ CIM RDF/XML Parser ------------------*/
-  public static resolveClassRDFXML(uuid: string, cimModel: Model): IdentifiedObject | undefined {
-    const newClass = new BaseVoltage(uuid);
-    cimModel.addBaseVoltage(newClass);
-    return newClass;
-  }
-
-  public resolveAttributesRDFXML(className: string, attrName: string, value: string) {
-    if (className === 'BaseVoltage') {
-
-    } else {
-      super.resolveAttributesRDFXML(className, attrName, value);
-    }
-  }
-}

package/src/model/core/Bay.ts

@@ -1,178 +0,0 @@
-import { EquipmentContainer } from '../core/EquipmentContainer';
-import { VoltageLevel } from '../core/VoltageLevel';
-import { Substation } from './Substation';
-import { BaseVoltage } from './BaseVoltage';
-import XMLWriter from 'xml-writer';
-import { getValue, writeElementAttribute, writeStartElement } from '../../util/utils';
-import { RDF_XML } from '../../constants/rdf-xml';
-import { DiagramObject, ISchemaSettings, Model } from "../..";
-
-export class Bay extends EquipmentContainer {
-
-  voltageLevel: VoltageLevel | undefined;
-  voltageLevelUUID: string | undefined;
-
-  constructor(uuid?: string, name?: string, shortName?: string, description?: string) {
-    super(uuid, name, shortName, description);
-  }
-
-  public static sparqlQuery: string = `
-        PREFIX cim:	 		<http://iec.ch/TC57/2013/CIM-schema-cim16#> 
-        PREFIX enervance:	<http://enervance.com/CIM/Extensions#> 
-        PREFIX entsoe:	 	<http://entsoe.eu/CIM/SchemaExtension/3/1#> 
-        PREFIX rdf:	 		<http://www.w3.org/1999/02/22-rdf-syntax-ns#> 
-        PREFIX apf:	 		<http://jena.hpl.hp.com/ARQ/property#>
-        PREFIX afn:	 		<http://jena.apache.org/ARQ/function#>
-        
-        SELECT  (strafter(strafter(str(?bayUUID), '#'), '_') AS ?uuid) 
-                 (CONCAT(STRBEFORE(str(?bayUUID), '#_'), '#_') AS ?baseIRI) 
-                 ?name ?shortName ?description 
-                 (strafter(strafter(str(?vlUUID), '#'), '_') AS ?voltageLevelUUID)
-        WHERE { 
-            GRAPH <http://default/>{
-                ?bayUUID rdf:type cim:Bay .
-                OPTIONAL {?bayUUID cim:IdentifiedObject.name ?name . }
-                OPTIONAL {?bayUUID entsoe:IdentifiedObject.shortName ?shortName .}
-                OPTIONAL {?bayUUID cim:IdentifiedObject.description ?description .}
-  
-                OPTIONAL {?bayUUID cim:Bay.VoltageLevel ?vlUUID}
-            }
-        }
-    `
-
-
-  public static getQuerySPARQL(graphURI: string): string {
-    if (graphURI.length > 0) {
-      return Bay.sparqlQuery.replace('<http://default/>', graphURI);
-    }
-    return Bay.sparqlQuery;
-  }
-
-  public static resolveClassFusekiJSON(data: any, cimModel: Model) {
-    data.results.bindings.forEach((value: any) => {
-      const bay = new Bay();
-      bay.resolveAttributesFusekiJSON(value)
-      cimModel.addBay(bay);
-    });
-  }
-
-  protected resolveAttributesFusekiJSON(value: any) {
-    super.resolveAttributesFusekiJSON(value);
-    this.voltageLevelUUID = getValue(value, 'voltageLevelUUID');
-  }
-
-  public resolveParsedAssociations(cimModel: Model) {
-    super.resolveParsedAssociations(cimModel);
-    //Substation
-    this.voltageLevel = cimModel.getVoltageLevel(this.voltageLevelUUID);
-    if (this.voltageLevel) this.voltageLevel.addBay(this);
-    else console.log(this.constructor.name + ' ' + this.mrid + ' hat keine VoltageLevel ' + this.voltageLevelUUID);
-  }
-
-  public toJSON() {
-    super.toJSON();
-    this.toJSONAttributes();
-    this.toJSONAssociations();
-    return this.json;
-  }
-
-  public toJSONAttributes() {
-    super.toJSONAttributes();
-  }
-
-  public toJSONAssociations() {
-    super.toJSONAssociations();
-    this.json['voltageLevelUUID'] = this.voltageLevel ? this.voltageLevel.mrid : this.voltageLevelUUID;
-  }
-
-  public getBaseVoltageAsNumber(): number {
-    if (this.voltageLevel) {
-      return this.voltageLevel.getBaseVoltageAsNumber();
-    }
-    return 0;
-  }
-
-  public getBaseVoltage(): BaseVoltage {
-    if (this.voltageLevel) {
-      return this.voltageLevel.baseVoltage;
-    }
-  }
-
-  public getVoltageLevel(): VoltageLevel {
-    return this.voltageLevel;
-  }
-
-  public getSubstation(): Substation | undefined {
-    if (this.voltageLevel) {
-      return this.voltageLevel.getSubstation();
-    }
-    return;
-  }
-
-  /** CIM RDF/XML Serialisierung */
-  public toCIMXML(xmlWriter: XMLWriter, profile: string) {
-    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();
-    }
-  }
-
-  protected toCIMXMLAttributes(xmlWriter: XMLWriter, profile: string) {
-    super.toCIMXMLAttributes(xmlWriter, profile);
-  }
-
-  protected toCIMXMLAssociations(xmlWriter: XMLWriter, profile: string) {
-    super.toCIMXMLAssociations(xmlWriter, profile);
-    if (profile === RDF_XML.PROFILE_EQ) {
-      if (this.voltageLevel) {
-        xmlWriter.startElementNS(RDF_XML.CIM_NS_PREFIX, 'Bay.VoltageLevel', RDF_XML.CIM_NS_16);
-        writeElementAttribute(xmlWriter, RDF_XML.RDF_RESRC, `${RDF_XML.HASH_UNDERSCORE}${this.voltageLevel.mrid}`);
-        xmlWriter.endElement();
-      } else if (this.voltageLevelUUID) {
-        xmlWriter.startElementNS(RDF_XML.CIM_NS_PREFIX, 'Bay.VoltageLevel', RDF_XML.CIM_NS_16);
-        writeElementAttribute(xmlWriter, RDF_XML.RDF_RESRC, `${RDF_XML.HASH_UNDERSCORE}${this.voltageLevelUUID}`);
-        xmlWriter.endElement();
-      } else {
-        xmlWriter.writeComment('VoltageLevel is not defined');
-      }
-    }
-  }
-
-  public toGeoJSON(geoJSON: any, profile: string, schemaSettings: ISchemaSettings, diagramObject?: DiagramObject): any {
-    if (diagramObject) {
-      super.toGeoJSON(geoJSON, profile, schemaSettings, diagramObject);
-
-      const cimPoints = diagramObject.diagramObjectPoints;
-      const points: number[][] = [];
-      if (cimPoints.length === 7) {
-        points.push([cimPoints[5].xPosition, -cimPoints[5].yPosition]);
-        points.push([cimPoints[6].xPosition, -cimPoints[6].yPosition]);
-      }
-      /*          for (const doPoint of cimPoints) {
-                    points.push([doPoint.xPosition, -doPoint.yPosition]);
-                }*/
-      const pointsPolygon: number[][][] = [];
-      pointsPolygon.push(points);
-
-      geoJSON['geometry'] = {
-        type: 'Polygon',
-        coordinates: pointsPolygon
-      };
-      geoJSON['properties'] = {
-        diagramObjectUUID: diagramObject.mrid,
-        objectType: this.constructor.name,
-        width: 0,
-        height: 0,
-        offsetX: 0,
-        offsetY: 0,
-        fill: undefined,
-      }
-    }
-    return geoJSON;
-  }
-}

package/src/model/core/ConductingEquipment.ts

@@ -1,182 +0,0 @@
-import { Terminal } from './Terminal';
-import { BaseVoltage } from './BaseVoltage';
-import { Model } from '../model/Model';
-import { Equipment } from './Equipment';
-import { getValue, isInArray, writeElementAttribute } from '../../util/utils';
-import { RDF_XML } from '../../constants/rdf-xml';
-import XMLWriter from 'xml-writer';
-import { SvStatus } from '../statevariables/SvStatus';
-import { IIdentifiedObject } from '../../interfaces/model/core/IIdentifiedObject';
-import { IConnectivityNode } from '../../interfaces/model/core/IConnectivityNode';
-import { Outage } from '../operations/Outage';
-import { IOutage } from '../../interfaces/model/operations/IOutage';
-import { IConductingEquipment } from '../../interfaces/model/core/IConductingEquipment';
-import { ITerminal } from '../../interfaces/model/core/ITerminal';
-
-export class ConductingEquipment extends Equipment implements IConductingEquipment {
-
-  terminals: Map<string, ITerminal>;
-  terminalsUUIDs: string[] = [];
-
-  baseVoltage: BaseVoltage | undefined;
-  baseVoltageUUID: string | undefined;
-
-  svStatus: SvStatus;
-  svStatusUUID: string | undefined;
-
-  /** Abweichend vom CIM Model: statt 0..1, 0..n Kardinalität!*/
-  outages: Map<string, IOutage>;
-
-  constructor(uuid?: string, name?: string, shortName?: string, description?: string, aggregate?: boolean) {
-    super(uuid, name, shortName, description, aggregate);
-    this.terminals = new Map();
-    this.outages = new Map();
-  }
-
-  public addTerminal(terminal: Terminal) {
-    this.terminals.set(terminal.getUUID(), terminal);
-  }
-
-  public getTerminal(uuid: string): ITerminal | undefined {
-    return this.terminals.get(uuid);
-  }
-
-  protected resolveAttributesFusekiJSON(value: any) {
-    super.resolveAttributesFusekiJSON(value);
-    this.baseVoltageUUID = getValue(value, 'baseVoltageUUID');
-    // this.outageUUID = getValue(value, 'outageUUID');
-  }
-
-  public resolveParsedAssociations(cimModel: Model) {
-    super.resolveParsedAssociations(cimModel);
-    this.baseVoltage = cimModel.getBaseVoltageByUUID(this.baseVoltageUUID || '');
-    if (this.constructor.name === 'ACLineSegment' && !this.baseVoltage) {
-      // console.log(this.constructor.name + ' ' + this.mrid + ' hat keine BaseVoltage ' + this.baseVoltageUUID);
-    }
-  }
-
-  public toJSONAttributes() {
-    super.toJSONAttributes();
-    // this.json['baseVoltageUUID'] = this.baseVoltage.nominalVoltage.value;
-    // this.json['un'] = (this.baseVoltage ? this.baseVoltage.nominalVoltage.value : 0)
-  }
-
-  public determineGridIslands(networkElements: any []) {
-    if (!this.visited) {
-      this.addNetworkElement(networkElements);
-      // 0 = key, 1 = value
-      for (const entry of this.terminals.entries()) {
-        const value = entry[1];
-        value.determineGridIslands(networkElements);
-      }
-    }
-  }
-
-  public breadthFirstSearch(networkElements: any[]) {
-    // 0 = key, 1 = value
-    for (const entry of this.terminals.entries()) {
-      const value = entry[1];
-      value.breadthFirstSearch(networkElements);
-    }
-  }
-
-  /* Bestimmt alle zum Slack gehörende Netzelemente (CN, Terminals Sammelschienen, Trafos)*/
-  public determineSlackNodes(slackElemenets: IIdentifiedObject[]) {
-    if (!this.visited) {
-      this.addNetworkElement(slackElemenets);
-      // 0 = key, 1 = value
-      for (const entry of this.terminals.entries()) {
-        const value = entry[1];
-        value.determineSlackNodes(slackElemenets);
-      }
-    }
-  }
-
-  /** für Switches separate Implementierung, da der Schaltzustand berücksichtigt werden muss. */
-  public determineMidVoltageLineElements(feederLineElemenets: IIdentifiedObject[], slackSubstationElements: IIdentifiedObject[][]) {
-    if (!this.visited && !isInArray(this, slackSubstationElements)) {
-      this.addNetworkElement(feederLineElemenets);
-      // 0 = key, 1 = value
-      for (const entry of this.terminals.entries()) {
-        const value = entry[1];
-        value.determineMidVoltageLineElements(feederLineElemenets, slackSubstationElements);
-      }
-    }
-  }
-
-  public determineTopologicalNodes(connNodes: IConnectivityNode[]) {
-    // 0 = key, 1 = value
-    for (const entry of this.terminals.entries()) {
-      const value = entry[1];
-      value.determineTopologicalNodes(connNodes);
-    }
-  }
-
-  public getBusConnections(): IIdentifiedObject[] {
-    const connections: IIdentifiedObject[] = [];
-    // 0 = key, 1 = value
-    for (const value of this.terminals.values()) {
-      connections.push(value.connectivityNode);
-    }
-    return connections;
-  }
-
-  /*
-      die Methode prüft, ob die Terminals im Geschlossenenzustand sind;
-  */
-  public isConnected(): boolean {
-    let connected = true;
-    for (const value of this.terminals.values()) {
-      if (!value.isClosed() && connected) {
-        connected = false;
-      }
-    }
-    return connected;
-  }
-
-  public getCurrentLimit(): number {
-    let limit: number = 0;
-    for (const entry of this.terminals.entries()) {
-      const value = entry[1];
-      if (value && value.operationalLimitSets.length > 0) {
-        const limitNew = this.getLimitValue(value.operationalLimitSets);
-        if (limitNew > limit) {
-          limit = limitNew;
-        }
-      }
-    }
-    //OperationalLimitSet ist direkt mit Equipment verknüpft
-    if (limit === 0) {
-      limit = super.getCurrentLimit();
-    }
-    return limit;
-  }
-
-  //
-  public isLoadOrFeed(): boolean {
-    return false;
-  }
-
-  protected toCIMXMLAssociations(xmlWriter: XMLWriter, profile: string) {
-    super.toCIMXMLAssociations(xmlWriter, profile);
-    if (profile === RDF_XML.PROFILE_EQ) {
-      if (this.baseVoltage) {
-        xmlWriter.startElementNS(RDF_XML.CIM_NS_PREFIX, 'ConductingEquipment.BaseVoltage', RDF_XML.CIM_NS_16);
-        writeElementAttribute(xmlWriter, RDF_XML.RDF_RESRC, `${RDF_XML.HASH_UNDERSCORE}${this.baseVoltage.mrid}`);
-        xmlWriter.endElement();
-      } else if (this.baseVoltageUUID) {
-        xmlWriter.startElementNS(RDF_XML.CIM_NS_PREFIX, 'ConductingEquipment.BaseVoltage', RDF_XML.CIM_NS_16);
-        writeElementAttribute(xmlWriter, RDF_XML.RDF_RESRC, `${RDF_XML.HASH_UNDERSCORE}${this.baseVoltageUUID}`);
-        xmlWriter.endElement();
-      } else {
-        if (this.constructor.name === 'ACLineSegment') {
-          xmlWriter.writeComment('BaseVoltage is not defined');
-        }
-      }
-    }
-  }
-
-  addOutage(outage: IOutage) {
-    this.outages.set(outage.mrid, outage);
-  }
-}