FlowMapEntry should not inherit from RootEntity

but just from Entity
GreenDelta · Apr 19, 2021 · 03a7953 · 03a7953
1 parent 1ab2f1a
commit 03a7953
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 46 deletions.
diff --git a/docs/FlowMapEntry.html b/docs/FlowMapEntry.html
@@ -19,7 +19,7 @@
 </head>
 <body style="padding:20px;">
     <h1>Class <a href="#">FlowMapEntry</a></h1>
-    <p class="comment">A mapping from one flow to another.</p>
+    <p class="comment">A mapping from a source flow to a target flow.</p>
 
     <p>~</p>
     <p class="comment">Properties:</p>
@@ -28,54 +28,22 @@ <h1>Class <a href="#">FlowMapEntry</a></h1>
         <tr>
             <td><span class="property">from</span></td>
             <td><a href="./FlowMapRef.html">FlowMapRef</a></td>
-            <td class="comment">The flow, flow property, and unit of the source flow.</td>
+            <td class="comment">Describes the source flow of the mapping.</td>
         </tr>
 
         <tr>
             <td><span class="property">to</span></td>
             <td><a href="./FlowMapRef.html">FlowMapRef</a></td>
-            <td class="comment">The flow, flow property, and unit of the target flow.</td>
+            <td class="comment">Describes the target of the mapping.</td>
         </tr>
 
         <tr>
             <td><span class="property">conversionFactor</span></td>
             <td><a href="http://www.w3.org/TR/xmlschema-2/#double">double</a></td>
-            <td class="comment">The factor to convert the original source flow to the target flow.</td>
-        </tr>
-
-    </table>
-
-
-
-    <p>~</p>
-    <p class="comment">Properties from <a href="./RootEntity.html">RootEntity</a>:</p>
-    <table>
-
-        <tr>
-            <td><span class="property">name</span></td>
-            <td><a href="http://www.w3.org/TR/xmlschema-2/#string">string</a></td>
-            <td class="comment">The name of the entity.</td>
-        </tr>
-
-        <tr>
-            <td><span class="property">description</span></td>
-            <td><a href="http://www.w3.org/TR/xmlschema-2/#string">string</a></td>
-            <td class="comment">The description of the entity.</td>
-        </tr>
-
-        <tr>
-            <td><span class="property">version</span></td>
-            <td><a href="http://www.w3.org/TR/xmlschema-2/#string">string</a></td>
-            <td class="comment">A version number in MAJOR.MINOR.PATCH format where the MINOR and PATCH fields are optional and the fields may have leading zeros (so 01.00.00 is the same as 1.0.0 or 1).
+            <td class="comment">The conversion factor to convert the amount of 1 unit of the source flow into the corresponding quantity of the target flow.
 </td>
         </tr>
 
-        <tr>
-            <td><span class="property">lastChange</span></td>
-            <td><a href="http://www.w3.org/TR/xmlschema-2/#dateTime">dateTime</a></td>
-            <td class="comment">The timestamp when the entity was changed the last time.</td>
-        </tr>
-
     </table>
 
 

diff --git a/docs/FlowMapRef.html b/docs/FlowMapRef.html
@@ -19,7 +19,7 @@
 </head>
 <body style="padding:20px;">
     <h1>Class <a href="#">FlowMapRef</a></h1>
-    <p class="comment">Describes a the source or target flow of a flow mapping in a <span style="color: #7c4dff">FlowMap</span>. Such a flow reference can also optionally specify the unit and flow property (quantity) for which the mapping is valid. If the unit and quantity are not given, the mapping is based on the reference unit of the reference flow property of the respective flow.
+    <p class="comment">Describes a source or target flow in a <span style="color: #7c4dff">FlowMappingEntry</span> of a <span style="color: #7c4dff">FlowMap</span>. Such a flow reference can also optionally specify the unit and flow property (quantity) for which the mapping is valid. If the unit or quantity is not given, the mapping is based on the respective reference unit and reference flow property of the flow.
 </p>
 
     <p>~</p>

diff --git a/yaml/FlowMapEntry.yaml b/yaml/FlowMapEntry.yaml
@@ -1,19 +1,21 @@
 
 class:
   name: FlowMapEntry
-  superClass: RootEntity
+  superClass: Entity
   example: #none yet
-  doc: A mapping from one flow to another.
+  doc: A mapping from a source flow to a target flow.
 
   properties:
     - name: from
       type: FlowMapRef
-      doc: The flow, flow property, and unit of the source flow.
+      doc: Describes the source flow of the mapping.
 
     - name: to
       type: FlowMapRef
-      doc: The flow, flow property, and unit of the target flow.
+      doc: Describes the target of the mapping.
 
     - name: conversionFactor
       type: double
-      doc: The factor to convert the original source flow to the target flow.
+      doc: >
+           The conversion factor to convert the amount of 1 unit of the source
+           flow into the corresponding quantity of the target flow.
diff --git a/yaml/FlowMapRef.yaml b/yaml/FlowMapRef.yaml
@@ -3,11 +3,11 @@ class:
   name: FlowMapRef
   superClass: Entity
   doc: >
-       Describes a the source or target flow of a flow mapping in a `FlowMap`.
+       Describes a source or target flow in a `FlowMappingEntry` of a `FlowMap`.
        Such a flow reference can also optionally specify the unit and flow
-       property (quantity) for which the mapping is valid. If the unit and
-       quantity are not given, the mapping is based on the reference unit of the
-       reference flow property of the respective flow.
+       property (quantity) for which the mapping is valid. If the unit or
+       quantity is not given, the mapping is based on the respective reference
+       unit and reference flow property of the flow.
   
   properties:
     - name: flow