Merge pull request openscd#826 from openscd/104-init-structure

feat(104/CreateAddresses): Use DO Template Structure to create DAI Elements

Author: Dennis Labordus

src/editors/ied/da-container.ts

@@ -118,7 +118,7 @@ export class DAContainer extends Container {
     // Next create all missing elements (DOI/SDI/DOI)
     const newElement = initializeElements(uninitializedTemplateStructure);
 
-    if (parentElement && newElement) {
+    if (newElement) {
       const wizard = createDAIWizard(parentElement, newElement, this.element);
       if (wizard) this.dispatchEvent(newWizardEvent(wizard));
     }

src/editors/protocol104/doi-container.ts

@@ -24,12 +24,12 @@ import '../../action-pane.js';
 
 import {
   get104DetailsLine,
-  getCdcValue,
+  getCdcValueFromDOIElement,
   getFullPath,
-  PRIVATE_TYPE_104,
 } from './foundation/foundation.js';
 import { editAddressWizard } from './wizards/address.js';
 import { showDOIInfoWizard } from './wizards/doi.js';
+import { PROTOCOL_104_PRIVATE } from './foundation/private.js';
 
 /**
  * Container showing all the DAI Elements, related to the 104 Protocol, of the passed DOI Element in a list.
@@ -48,8 +48,9 @@ export class Doi104Container extends LitElement {
     return Array.from(this.element.querySelectorAll(`DAI`))
       .filter(
         daiElement =>
-          daiElement.querySelector(`Private[type="${PRIVATE_TYPE_104}"]`) !==
-          null
+          daiElement.querySelector(
+            `Private[type="${PROTOCOL_104_PRIVATE}"] > Address`
+          ) !== null
       )
       .sort((dai1, dai2) =>
         getFullPath(dai1, 'DOI').localeCompare(getFullPath(dai2, 'DOI'))
@@ -59,12 +60,16 @@ export class Doi104Container extends LitElement {
   private getAddressElements(daiElement: Element): Element[] {
     return Array.from(
       daiElement.querySelectorAll(
-        `Private[type="${PRIVATE_TYPE_104}"] > Address`
-      )
-    ).sort((addr1, addr2) =>
-      (addr1.getAttribute('ioa') ?? '').localeCompare(
-        addr2.getAttribute('ioa') ?? ''
+        `Private[type="${PROTOCOL_104_PRIVATE}"] > Address`
       )
+    ).sort(
+      (addr1, addr2) =>
+        (addr1.getAttribute('casdu') ?? '').localeCompare(
+          addr2.getAttribute('casdu') ?? ''
+        ) &&
+        (addr1.getAttribute('ioa') ?? '').localeCompare(
+          addr2.getAttribute('ioa') ?? ''
+        )
     );
   }
 
@@ -76,8 +81,12 @@ export class Doi104Container extends LitElement {
     daiElement: Element,
     addressElement: Element
   ): void {
+    const doiElement = daiElement.closest('DOI')!;
+    const iedElement = doiElement.closest('IED')!;
     this.dispatchEvent(
-      newWizardEvent(editAddressWizard(daiElement, addressElement))
+      newWizardEvent(
+        editAddressWizard(iedElement, doiElement, daiElement, addressElement)
+      )
     );
   }
 
@@ -88,7 +97,7 @@ export class Doi104Container extends LitElement {
   @property()
   get header(): TemplateResult {
     const fullPath = getFullPath(this.element, 'IED');
-    const cdc = getCdcValue(this.element);
+    const cdc = getCdcValueFromDOIElement(this.element);
 
     return html`${fullPath}${cdc ? html` (${cdc})` : nothing}`;
   }

src/editors/protocol104/foundation/actions.ts

@@ -1,96 +1,71 @@
-import { Create, newWizardEvent } from '../../../foundation.js';
-
-import { editAddressWizard } from '../wizards/address.js';
+import { Create } from '../../../foundation.js';
 import { TiInformation } from './cdc.js';
 
 /**
  * Create a list of Create Actions using the parameters passed. First search for the DAI Elements
  * that can be effected. Next create the action and add it to this list, also start the Edit
  * Address Element wizard for all Address Elements created.
  *
- * @param doiElement     - The DOI Element.
- * @param wizard         - The Wizard to dispatch the Open Wizard event on.
- * @param ti             - The TI Value set on the new Address Elements.
- * @param inverted       - Indicates if the Engineer want to create inverted Address Elements, if applicable.
- * @param tiInformation  - Information about how to create the Address Elements for the passed TI.
+ * @param lnElement       - The LN Element.
+ * @param lnClonedElement - The Cloned LN Element, used to create new structure and determine which Create actions are needed.
+ * @param doElement       - The DO Element.
+ * @param wizard          - The Wizard to dispatch the Open Wizard event on.
+ * @param ti              - The TI Value set on the new Address Elements.
+ * @param inverted        - Indicates if the Engineer want to create inverted Address Elements, if applicable.
+ * @param tiInformation   - Information about how to create the Address Elements for the passed TI.
  * @returns A list of Create Action that will be added to the complex action.
  */
 export function createActions(
-  doiElement: Element,
+  lnElement: Element,
+  lnClonedElement: Element,
+  doElement: Element,
   wizard: Element,
   ti: string,
   inverted: boolean,
   tiInformation: TiInformation
 ): Create[] {
-  const actions: Create[] = [];
-  const daiElements = doiElement.querySelectorAll(tiInformation.filter);
-  if (daiElements.length > 0) {
-    daiElements.forEach(daiElement => {
-      const createActions = tiInformation.create(
-        daiElement,
-        ti,
-        tiInformation.inverted ? inverted : false // If the TI Allows it and the Engineer selected it, true will be passed.
-      );
-      actions.push(...createActions);
-
-      createActions.forEach(createAction => {
-        const privateElement = <Element>createAction.new.element;
-        Array.from(privateElement.querySelectorAll('Address')).forEach(
-          addressElement => {
-            wizard.dispatchEvent(
-              newWizardEvent(() =>
-                editAddressWizard(daiElement, addressElement)
-              )
-            );
-          }
-        );
-      });
-    });
-  }
-  return actions;
+  return tiInformation.create(
+    lnElement,
+    lnClonedElement,
+    doElement,
+    wizard,
+    ti,
+    tiInformation.daPaths,
+    // If the TI Allows inverted and the Engineer selected it, true will be passed.
+    tiInformation.inverted ? inverted : false
+  );
 }
 
 /**
  * Create a list of Create Actions using the parameters passed. First search for the DAI Elements [name="Check"].
  * Next create the action and add it to this list, also start the Edit Address Element wizard for all Address Elements
  * created.
  *
- * @param doiElement     - The DOI Element.
- * @param wizard         - The Wizard to dispatch the Open Wizard event on.
- * @param ti             - The TI Value set on the new Address Elements.
- * @param tiInformation  - Information about how to create the Address Elements for the passed TI.
+ * @param lnElement       - The LN Element.
+ * @param lnClonedElement - The Cloned LN Element, used to create new structure and determine which Create actions are needed.
+ * @param doElement       - The DO Element.
+ * @param wizard          - The Wizard to dispatch the Open Wizard event on.
+ * @param ti              - The TI Value set on the new Address Elements.
+ * @param tiInformation   - Information about how to create the Address Elements for the passed TI.
  * @returns A list of Create Action that will be added to the complex action.
  */
 export function createCheckActions(
-  doiElement: Element,
+  lnElement: Element,
+  lnClonedElement: Element,
+  doElement: Element,
   wizard: Element,
   ti: string,
   tiInformation: TiInformation
 ): Create[] {
-  const actions: Create[] = [];
-  if (tiInformation.checkFilter) {
-    const daiElements = doiElement.querySelectorAll(tiInformation.checkFilter);
-    if (daiElements.length > 0) {
-      daiElements.forEach(daiElement => {
-        if (tiInformation.checkCreate) {
-          const createActions = tiInformation.checkCreate(daiElement, ti);
-          actions.push(...createActions);
-
-          createActions.forEach(createAction => {
-            const privateElement = <Element>createAction.new.element;
-            Array.from(privateElement.querySelectorAll('Address')).forEach(
-              addressElement => {
-                wizard.dispatchEvent(
-                  newWizardEvent(() =>
-                    editAddressWizard(daiElement, addressElement)
-                  )
-                );
-              }
-            );
-          });
-        }
-      });
-    }
+  if (tiInformation.checkDaPaths && tiInformation.checkCreate) {
+    return tiInformation.checkCreate(
+      lnElement,
+      lnClonedElement,
+      doElement,
+      wizard,
+      ti,
+      tiInformation.checkDaPaths
+    );
   }
-  return actions;
+  return [];
 }