feat: migrate originDestination connectionPenalty to netzgrafikDto (#314

)

* feat: migrate originDestination connectionPenalty to netzgrafixDto

* fixup! feat: migrate originDestination connectionPenalty to netzgrafixDto

documentation/DATA_MODEL_JSON.md

@@ -378,7 +378,8 @@ More details about TimeLock
   "netzgrafikColors": [],
   "trainrunCategories": [],
   "trainrunFrequencies": [],
-  "trainrunTimeCategories": []
+  "trainrunTimeCategories": [],
+  "analyticsSettings": {}
 }
 ```
 
@@ -600,6 +601,26 @@ Define the dayTimeIntervalElement
 ```
 - **from** : interval starts at time (include), in minute : numeric
 - **to** : interval ends at time (include), in minute : numeric 
+</details>
+
+<details>
+<summary>
+analyticsSettings: Contains settings for analytics features, such as originDestination matrix.
+</summary>
+
+
+```JSON
+"analyticsSettings": {
+    "originDestinationSettings": {
+        "connectionPenalty": 5
+    },
+}
+```
+
+- **connectionPenalty**: Cost to add for each connection, in minute : numeric
+
+
+
 </details>
 
 --- 

src/app/data-structures/business.data.structures.ts

@@ -252,6 +252,15 @@ export interface Haltezeit {
   no_halt: boolean; // no halt per default
 }
 
+export interface OriginDestinationSettingsDto {
+  // TODO: we may want a UI to display/edit this.
+  connectionPenalty: number; // the cost to add for each connection, in minutes
+}
+
+export interface AnalyticsSettingsDto {
+  originDestinationSettings: OriginDestinationSettingsDto;
+}
+
 /**
  * Groups Meta data in exported JSON / internal data structure (global properties for a project)
  */
@@ -260,6 +269,7 @@ export interface MetadataDto {
   trainrunFrequencies: TrainrunFrequency[];
   trainrunTimeCategories: TrainrunTimeCategory[];
   netzgrafikColors: NetzgrafikColorDto[];
+  analyticsSettings: AnalyticsSettingsDto;
 }
 
 /**

src/app/sample-netzgrafik/netzgrafik.default.ts

@@ -205,6 +205,11 @@ export class NetzgrafikDefault {
       trainruns: [],
       resources: [],
       metadata: {
+        analyticsSettings: {
+          originDestinationSettings: {
+            connectionPenalty: 5,
+          }
+        },
         trainrunCategories: [
           {
             id: 0,

src/app/utils/data-migration.ts

@@ -80,6 +80,11 @@ export class DataMigration {
         NetzgrafikDefault.getDefaultNetzgrafik().metadata.netzgrafikColors;
     }
 
+    if (netzgrafikDto.metadata.analyticsSettings === undefined) {
+      netzgrafikDto.metadata.analyticsSettings =
+        NetzgrafikDefault.getDefaultNetzgrafik().metadata.analyticsSettings;
+    }
+
     if (netzgrafikDto.freeFloatingTexts === undefined) {
       netzgrafikDto.freeFloatingTexts =
         NetzgrafikDefault.getDefaultNetzgrafik().freeFloatingTexts;

src/app/view/editor-tools-view-component/editor-tools-view.component.ts

@@ -500,9 +500,6 @@ export class EditorToolsViewComponent {
   // Split trainruns are not supported at the moment:
   // https://github.com/SchweizerischeBundesbahnen/netzgrafik-editor-frontend/issues/285
   private convertToOriginDestinationCSV(): string {
-    // The cost to add for each connection.
-    // TODO: this may belong to the grafix metadata.
-    const connectionPenalty = 5;
     // Duration of the schedule to consider (in minutes).
     // TODO: ideally this would be 24 hours, but performance is a concern.
     const timeLimit = 10*60;
@@ -514,6 +511,9 @@ export class EditorToolsViewComponent {
     headers.push($localize`:@@app.view.editor-side-view.editor-tools-view-component.connections:Connections`);
     headers.push($localize`:@@app.view.editor-side-view.editor-tools-view-component.totalCost:Total cost`);
 
+    const metadata = this.dataService.getNetzgrafikDto().metadata;
+    // The cost to add for each connection.
+    const connectionPenalty = metadata.analyticsSettings.originDestinationSettings.connectionPenalty;
     const nodes = this.nodeService.getNodes();
     const selectedNodes = this.nodeService.getSelectedNodes();
     const odNodes = selectedNodes.length > 0 ? selectedNodes : this.nodeService.getVisibleNodes();

src/integration-testing/netzgrafik.unit.test.reconnec.trainrunsectionst.ts

@@ -696,6 +696,11 @@ export class NetzgrafikUnitTestingReconnectTrainrunSection {
         },
       ],
       metadata: {
+        analyticsSettings: {
+          originDestinationSettings: {
+            connectionPenalty: 5,
+          }
+        },
         trainrunCategories: [
           {
             id: 0,

src/integration-testing/netzgrafik.unit.testing.od.matrix.ts

@@ -950,6 +950,11 @@ export class NetzgrafikUnitTestingOdMatrix {
           }
       ],
       "metadata": {
+          "analyticsSettings": {
+              "originDestinationSettings": {
+                  "connectionPenalty": 5,
+              }
+          },
           "trainrunCategories": [
               {
                   "id": 0,

src/integration-testing/netzgrafik.unit.testing.transition.ts

@@ -1126,6 +1126,11 @@ export class NetzgrafikUnitTestingTransition {
         },
       ],
       metadata: {
+        analyticsSettings: {
+          originDestinationSettings: {
+            connectionPenalty: 5,
+          }
+        },
         trainrunCategories: [
           {
             id: 0,

src/integration-testing/netzgrafik.unit.testing.ts

@@ -820,6 +820,11 @@ export class NetzgrafikUnitTesting {
       ],
       resources: [],
       metadata: {
+        analyticsSettings: {
+          originDestinationSettings: {
+            connectionPenalty: 5,
+          }
+        },
         trainrunCategories: [
           {
             id: 0,