linny-r 2.0.6 → 2.0.8

package/static/scripts/linny-r-gui-monitor.js

@@ -11,7 +11,7 @@ for the Linny-R Monitor dialog.
 */
 
 /*
-Copyright (c) 2017-2024 Delft University of Technology
+Copyright (c) 2017-2025 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/static/scripts/linny-r-gui-paper.js

@@ -11,7 +11,7 @@ functionality for the Linny-R model editor.
 */
 
 /*
-Copyright (c) 2017-2024 Delft University of Technology
+Copyright (c) 2017-2025 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -909,16 +909,17 @@ class Paper {
   }
   
   //
-  // Diagram-drawing method draws the diagram for the focal cluster
+  // Diagram-drawing method draws the diagram for the focal cluster.
   //
   
   drawModel(mdl) {
-    // Draw the diagram for the focal cluster
+    // Draw the diagram for the focal cluster.
     this.clear();
-    // Prepare to draw all elements in the focal cluster
+    // Prepare to draw all elements in the focal cluster.
     const fc = mdl.focal_cluster;
     fc.categorizeEntities();
-    // NOTE: product positions must be updated before links are drawn
+    // NOTE: Product positions must be updated before links are drawn, so
+    // that links arrows will be drawn over their shapes.
     fc.positionProducts();
     for(let i = 0; i < fc.processes.length; i++) {
       fc.processes[i].clearHiddenIO();
@@ -926,10 +927,10 @@ class Paper {
     for(let i = 0; i < fc.sub_clusters.length; i++) {
       fc.sub_clusters[i].clearHiddenIO();
     }
-    // NOTE: also ensure that notes will update their fields
+    // NOTE: Also ensure that notes will update their fields.
     fc.resetNoteFields();
     // Draw link arrows and constraints first, as all other entities are
-    // slightly transparent so they cannot completely hide these lines
+    // slightly transparent so they cannot completely hide these lines.
     for(let i = 0; i < fc.arrows.length; i++) {
       this.drawArrow(fc.arrows[i]);
     }
@@ -945,25 +946,25 @@ class Paper {
     for(let i = 0; i < fc.sub_clusters.length; i++) {
       this.drawCluster(fc.sub_clusters[i]);
     }
-    // Draw notes last, as they are semi-transparent (and can be quite small)
+    // Draw notes last, as they are semi-transparent (and can be quite small).
     for(let i = 0; i < fc.notes.length; i++) {
       this.drawNote(fc.notes[i]);
     }
-    // Resize paper if necessary
+    // Resize paper if necessary.
     this.extend();
-    // Display model name in browser
+    // Display model name in browser.
     document.title = mdl.name || 'Linny-R';
   }
   
   drawSelection(mdl, dx=0, dy=0) {
     // NOTE: Clear this global, as Bezier curves move from under the cursor
-    // without a mouseout event 
+    // without a mouseout event.
     this.constraint_under_cursor = null;
-    // Draw the selected entities and associated links, and also constraints
+    // Draw the selected entities and associated links, and also constraints.
     for(let i = 0; i < mdl.selection.length; i++) {
       const obj = mdl.selection[i];
       // Links and constraints are drawn separately, so do not draw those
-      // contained in the selection 
+      // contained in the selection.
       if(!(obj instanceof Link || obj instanceof Constraint)) {
         if(obj instanceof Note) obj.parsed = false;
         UI.drawObject(obj, dx, dy);
@@ -972,12 +973,12 @@ class Paper {
     if(mdl.selection_related_arrows.length === 0) {
       mdl.selection_related_arrows = mdl.focal_cluster.selectedArrows();
     }
-    // Only draw the arrows that relate to the selection
+    // Only draw the arrows that relate to the selection.
     for(let i = 0; i < mdl.selection_related_arrows.length; i++) {
       this.drawArrow(mdl.selection_related_arrows[i]);
     }
     // As they typically are few, simply redraw all constraints that relate to
-    // the focal cluster
+    // the focal cluster.
     for(let i = 0; i < mdl.focal_cluster.related_constraints.length; i++) {
       this.drawConstraint(mdl.focal_cluster.related_constraints[i]);
     }
@@ -990,23 +991,23 @@ class Paper {
   //
 
   drawArrow(arrw, dx=0, dy=0) {
-    // Draws an arrow from FROM nodebox to TO nodebox
-    // NOTE: first erase previously drawn arrow
+    // Draw an arrow from FROM nodebox to TO nodebox.
+    // NOTE: First erase previously drawn arrow.
     arrw.shape.clear();
     arrw.hidden_nodes.length = 0;
-    // Use local variables so as not to change any "real" attribute values
+    // Use local variables so as not to change any "real" attribute values.
     let cnb, proc, prod, fnx, fny, fnw, fnh, tnx, tny, tnw, tnh,
         cp, rr, aa, bb, dd, nn, af, l, s, w, tw, th, bpx, bpy, epx, epy,
         sda, stroke_color, stroke_width, arrow_start, arrow_end,
         font_color, font_weight, luc = null, grid = null;
-    // Get the main arrow attributes
+    // Get the main arrow attributes.
     const
         from_nb = arrw.from_node,
         to_nb = arrw.to_node;
-    // Use "let" because `ignored` may also be set later on (for single link)
+    // Use "let" because `ignored` may also be set later on (for single link).
     let ignored = (from_nb && MODEL.ignored_entities[from_nb.identifier]) ||
         (to_nb && MODEL.ignored_entities[to_nb.identifier]);
-    // First check if this is a block arrow (ONE node being null)
+    // First check if this is a block arrow (ONE node being null).
     if(!from_nb) {
       cnb = to_nb;
     } else if(!to_nb) {
@@ -1014,22 +1015,22 @@ class Paper {
     } else {
       cnb = null;
     }
-    // If not NULL `cnb` is the cluster or node box (product or process) having
+    // If not NULL, `cnb` is the cluster or node box (product or process) having
     // links to entities outside the focal cluster. Such links are summarized
     // by "block arrows": on the left edge of the box to indicate inflows,
     // on the right edge to indicate outflows, and two-headed on the top edge
     // to indicate two-way flows. When the cursor is moved over a block arrow,
     // the Documentation dialog will display the list of associated nodes
-    // (with their actual flows if non-zero)
+    // (with their actual flows if non-zero).
     if(cnb) {
-      // Distinguish between input, output and io products
+      // Distinguish between input, output and io products.
       let ip = [], op = [], iop = [];
       if(cnb instanceof Cluster) {
         for(let i = 0; i < arrw.links.length; i++) {
           const lnk = arrw.links[i];
-          // determine which product is involved
+          // Determine which product is involved.
           prod = (lnk.from_node instanceof Product ? lnk.from_node : lnk.to_node);
-          // NOTE: clusters "know" their input/output products
+          // NOTE: Clusters "know" their input/output products.
           if(cnb.io_products.indexOf(prod) >= 0) {
             addDistinct(prod, iop);
           } else if(cnb.consumed_products.indexOf(prod) >= 0) {
@@ -1039,7 +1040,7 @@ class Paper {
           }
         }
       } else {
-        // cnb is process or product => knows its inputs and outputs
+        // `cnb` is process or product => knows its inputs and outputs.
         for(let i = 0; i < arrw.links.length; i++) {
           const lnk = arrw.links[i];
           if(lnk.from_node === cnb) {
@@ -1047,7 +1048,7 @@ class Paper {
           } else {
             addDistinct(lnk.from_node, ip);
           }
-          // NOTE: for processes, products cannot be BOTH input and output
+          // NOTE: For processes, products cannot be BOTH input and output.
         }
       }
       cnb.hidden_inputs = ip;

package/static/scripts/linny-r-model.js

@@ -10,7 +10,7 @@ the Linny-R project.
 */
 
 /*
-Copyright (c) 2017-2024 Delft University of Technology
+Copyright (c) 2017-2025 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -5801,7 +5801,7 @@ class NodeBox extends ObjectWithXYWH {
   }
   
   resize() {
-    // Resizes this node; returns TRUE iff size has changed.
+    // Resize this node; returns TRUE iff size has changed.
     // Therefore, keep track of original width and height.
     const
         ow = this.width,
@@ -5814,7 +5814,7 @@ class NodeBox extends ObjectWithXYWH {
       w = Math.max(w, UI.textSize(`[${this.scale_unit}]`).width);
     }
     this.frame_width = w + 7;
-    // Add 17 pixels height for actor name
+    // Add 17 pixels height for actor name.
     this.height = Math.max(50, this.bbox.height + 17);
     if(this instanceof Process) {
       this.width = Math.max(90, this.frame_width + 20);
@@ -5822,11 +5822,11 @@ class NodeBox extends ObjectWithXYWH {
     } else if(this instanceof Cluster) {
       this.width = Math.max(
           CONFIGURATION.min_cluster_size, this.frame_width + 20);
-      // Clusters have a square shape
+      // Clusters have a square shape.
       this.height = Math.max(this.width, this.height); 
     } else {
       this.height += 8;
-      // Reserve some extra space for UB/LB if defined
+      // Reserve some extra space for UB/LB if defined.
       if(this.lower_bound.defined || this.upper_bound.defined) {
         this.frame_width += 16;
       }
@@ -8282,20 +8282,20 @@ class Product extends Node {
     // By default, processes have the letter p, products the letter q.
     this.TEX_id = 'p';
     // For products, the default bounds are [0, 0], and modeler-defined bounds
-    // typically are equal
+    // typically are equal.
     this.equal_bounds = true;
-    // In addition to LB, UB and IL, products has 1 input attribute: P
+    // In addition to LB, UB and IL, products has 1 input attribute: P.
     this.price = new Expression(this, 'P', '');
-    // Products have a highest cost price, and may have a stock price (if storage)
+    // Products have a highest cost price, and may have a stock price (if storage).
     this.highest_cost_price = [];
     this.stock_price = [];
     // Stock level changing from 0 to positive counts as "start up", while
-    // changing from positive to 0 counts as a "shut-down"
-    // NOTE: being relatively rare, start_ups and shut_downs are not vectors,
-    // but store the numbers of the time steps in which they occurred
+    // changing from positive to 0 counts as a "shut-down".
+    // NOTE: Being relatively rare, start_ups and shut_downs are not vectors,
+    // but store the numbers of the time steps in which they occurred.
     this.start_ups = [];
     this.shut_downs = [];
-    // Modeler may set explicit properties
+    // Modeler may set explicit properties.
     this.is_source = false;
     this.is_sink = false;
     this.is_buffer = false;
@@ -8650,13 +8650,13 @@ class Product extends Node {
   }
 
   get defaultAttribute() {
-    // Products have their level as default attribute 
+    // Products have their level as default attribute.
     return 'L';
   }
 
   attributeValue(a) {
-    // Returns the computed result for attribute `a`
-    // (for products, this is always a vector except IL)
+    // Return the computed result for attribute `a`.
+    // NOTE: For products, this is always a vector except IL.
     if(a === 'L') return this.level;
     if(a === 'CP') return this.cost_price;
     if(a === 'HCP') return this.highest_cost_price;
@@ -8664,7 +8664,7 @@ class Product extends Node {
   }
 
   attributeExpression(a) {
-    // Products have four expression attributes
+    // Products have four expression attributes.
     if(a === 'LB') return this.lower_bound;
     if(a === 'UB') {
       return (this.equal_bounds ? this.lower_bound : this.upper_bound);
@@ -8748,7 +8748,7 @@ class Product extends Node {
   }
 
   copyPropertiesFrom(p) {
-    // Set properties to be identical to those of product `p`
+    // Set properties to be identical to those of product `p`.
     this.x = p.x;
     this.y = p.y;
     this.comments = p.comments;
@@ -8765,11 +8765,11 @@ class Product extends Node {
     this.initial_level.text = p.initial_level.text;
     this.integer_level = p.integer_level;
     this.TEX_id = p.TEX_id;
-    // NOTE: do not copy the `no_links` property, nor the import/export status
+    // NOTE: Do not copy the `no_links` property, nor the import/export status.
   }
 
   differences(p) {
-    // Return "dictionary" of differences, or NULL if none
+    // Return "dictionary" of differences, or NULL if none.
     const d = differences(this, p, UI.MC.PRODUCT_PROPS);
     if(Object.keys(d).length > 0) return d;
     return null;
@@ -12699,6 +12699,10 @@ class BoundLine {
         VM.constraint_codes[this.type] + '] bound line #' +
         this.constraint.bound_lines.indexOf(this);
   }
+  
+  get name() {
+    return this.displayName;
+  }
 
   get copy() {
     // Return a "clone" of this bound line.

package/static/scripts/linny-r-utils.js

@@ -9,7 +9,7 @@ This JavaScript file (linny-r-utils.js) defines a variety of "helper" functions
 that are used in other Linny-R modules.
 */
 /*
-Copyright (c) 2017-2024 Delft University of Technology
+Copyright (c) 2017-2025 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -74,16 +74,16 @@ function safeStrToFloat(str, val=0) {
 }
 
 function safeStrToInt(str, val=0) {
-  // Returns numeric value of integer string, IGNORING decimals after
+  // Return numeric value of integer string, IGNORING decimals after
   // point or comma.
-  // NOTE: returns default value `val` if `str` is empty, null or undefined
+  // NOTE: Return default value `val` if `str` is empty, null or undefined.
   const n = (str ? parseInt(str) : val);
   return (isNaN(n) ? val : n);
 }
 
 function rangeToList(str, max=0) {
-  // Parses ranges "n-m/i" into a list of integers
-  // Returns FALSE if range is not valid according to the convention below
+  // Parse ranges "n-m/i" into a list of integers
+  // Return FALSE if range is not valid according to the convention below
   // The part "/i" is optional and denotes the increment; by default, i = 1.
   // The returned list will contain all integers starting at n and up to
   // at most (!) m, with increments of i, so [n, n+i, n+2i, ...]
@@ -112,6 +112,33 @@ function rangeToList(str, max=0) {
   return list;
 }
 
+function listToRange(list) {
+  // Return a string that represents the given list of integers as a series
+  // of subranges, e.g., [0,1,2,3,5,6,9,11] results in "0-3, 5-6, 9, 11".
+  const
+      n = list.length,
+      subs = [];
+  if(!n) return '';
+  let i = 0,
+      from = list[0],
+      to = from;
+  while(i < n) {
+    i++;
+    if(list[i] === to + 1) {
+      to++;
+    } else {
+      if(from === to) {
+        subs.push(from);
+      } else {
+        subs.push(`${from}-${to}`);
+      }
+      from = list[i];
+      to = from;
+    }
+  }
+  return subs.join(', ');
+}
+
 function dateToString(d) {
   // Returns date-time `d` in UTC format, accounting for time zone
   const offset = d.getTimezoneOffset();
@@ -198,6 +225,13 @@ function ellipsedText(text, n=50, m=10) {
   return text.slice(0, n) + ' \u2026 ' + text.slice(text.length - m);
 }
 
+function unquoteCSV(s) {
+  // Returns a double-quoted string `s` without its quotes, and with
+  // quote pairs "" replaced by single " quotes.
+  if(!s.startsWith('"') || !s.endsWith('"')) return s;
+  return s.slice(1, -1).replaceAll('""', '"');
+}
+
 //
 // Functions used when comparing two Linny-R models
 //
@@ -1098,12 +1132,14 @@ if(NODE) module.exports = {
   safeStrToFloat: safeStrToFloat,
   safeStrToInt: safeStrToInt,
   rangeToList: rangeToList,
+  listToRange: listToRange,
   dateToString: dateToString,
   msecToTime: msecToTime,
   compactClockTime: compactClockTime,
   uniformDecimals: uniformDecimals,
   capitalized: capitalized,
   ellipsedText: ellipsedText,
+  unquoteCSV: unquoteCSV,
   earlierVersion: earlierVersion,
   differences: differences,
   markFirstDifference: markFirstDifference,