Merge pull request #14 from tobolar/master

dietmarw · dietmarw · commit d976e2b73b61 · 2016-04-12T09:33:07.000+02:00
Updated for MSL 3.2.2 and changed icons
diff --git a/README.md b/README.md
@@ -14,9 +14,15 @@ This library also contains a proposal for a naming convention covering the whole
 
 ## Current release
 
-Download [VehicleInterfaces v1.2.3 (2015-09-09)](../../releases/tag/v1.2.3)
+Download [VehicleInterfaces v1.2.4 (2016-03-02)](../../releases/tag/v1.2.4)
 
 #### Release notes
+* [Version v1.2.4 (2016-03-02)](../../releases/tag/v1.2.4)
+  * This version is backwards compatible to versions 1.1.x and 1.2.x
+  * Typos in the documentation fixed.
+  * FillPattern graphical annotations corrected in a variety of Icons.
+  * Icon `VehicleInterfaces.Icons.VariantLibrary` marked as obsolete and no more used. Using `Modelica.Icons.VariantsPackage` instead.
+  * Copyright upgraded in `VehicleInterfaces.UsersGuide.License`.
 * [Version v1.2.3 (2015-09-09)](../../releases/tag/v1.2.3)
   * This version is backwards compatible to versions 1.1.x and 1.2.x
   * #3: Typos in the documentation fixed.
diff --git a/VehicleInterfaces/Accessories.mo b/VehicleInterfaces/Accessories.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Accessories "Collection of accessory subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Accessories Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Atmospheres.mo b/VehicleInterfaces/Atmospheres.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Atmospheres "Collection of atmosphere subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Atmosphere Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Brakes.mo b/VehicleInterfaces/Brakes.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Brakes "Collection of brakes subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Brakes Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Chassis.mo b/VehicleInterfaces/Chassis.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Chassis "Collection of chassis subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Chassis Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Controllers.mo b/VehicleInterfaces/Controllers.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Controllers "Collection of controllers subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Controllers Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/DataDictionaries.mo b/VehicleInterfaces/DataDictionaries.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package DataDictionaries "Collection of data dictionary definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Data Dictionary Tutorial"
     extends Modelica.Icons.Information;
@@ -95,7 +95,7 @@ Empty data dictionary model. Using this empty model in overall vehicle architect
         index=-1,
         extent={{-6,3},{-6,3}}));
     annotation (
-                         Documentation(info="<html>
+      Documentation(info="<html>
  <p>A simple data dictionary example that creates a new signal called <b>v_veh</b> within the <b>chassisBus</b> sub-bus of the control bus.</p>
 </html>"));
   end MinimalExample;
diff --git a/VehicleInterfaces/Drivelines.mo b/VehicleInterfaces/Drivelines.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Drivelines "Collection of drivelines subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Driveline Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/DriverEnvironments.mo b/VehicleInterfaces/DriverEnvironments.mo
@@ -1,7 +1,7 @@
 within VehicleInterfaces;
 package DriverEnvironments
   "Collection of driver environment subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Driver Environment Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Drivers.mo b/VehicleInterfaces/Drivers.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Drivers "Collection of driver subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Drivers Tutorial"
     extends Modelica.Icons.Information;
@@ -78,7 +78,7 @@ package Drivers "Collection of driver subsystem definitions"
         clutchPedal "Clutch pedal" annotation (Dialog);
       Integer gear
         "Selected gear for manual transmission (>0:forward gear, <0:rear gear)"
-                                                                                           annotation (Dialog);
+        annotation (Dialog);
       Boolean clutchLocked "Clutch locked flag" annotation (Dialog);
 
       annotation (Documentation(info="<html>
diff --git a/VehicleInterfaces/ElectricDrives.mo b/VehicleInterfaces/ElectricDrives.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package ElectricDrives "Collection of electric drive subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Electric Drives Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/EnergyStorage.mo b/VehicleInterfaces/EnergyStorage.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package EnergyStorage "Collection of energy storage subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Energy Storage Device Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Engines.mo b/VehicleInterfaces/Engines.mo
@@ -1,6 +1,7 @@
 within VehicleInterfaces;
 package Engines "Collection of combustion engine subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
+
   class Tutorial "Engines Tutorial"
     extends Modelica.Icons.Information;
 
diff --git a/VehicleInterfaces/Icons.mo b/VehicleInterfaces/Icons.mo
@@ -1,16 +1,20 @@
 within VehicleInterfaces;
 package Icons "Collection of icons"
-  extends Modelica.Icons.Package;
+  extends Modelica.Icons.IconsPackage;
 
   partial package VariantLibrary
-    "Icon for a package which contains several variants of one assembly or component"
+    "This icon will be removed in future library versions, use Modelica.Icons.VariantsPackage instead"
     extends Modelica.Icons.VariantsPackage;
+    extends Modelica.Icons.ObsoleteModel;
 
     annotation (
       Documentation(info="<html>
 <p>
-This partial package is intended to design a <em>default icon for a package class</em> which contains several <em>variants</em> of one assembly or component.
+<b>Obsolete</b> partial package intended to design a <em>default icon for a package class</em> which contains several <em>variants</em> of one assembly or component.
 </p>
+
+<h4>Note</h4>
+<p>This icon will be removed in future versions of the VehicleInterfaces Library. Instead, the icon <a href=\"modelica://Modelica.Icons.BasesPackage\">BasesPackage</a> shall be used.</p>
 </html>"));
   end VariantLibrary;
 
@@ -759,150 +763,58 @@ This partial class is intended to design a default icon for a <em>data dictionar
             lineColor={0,0,0},
             fillColor={255,255,255},
             fillPattern=FillPattern.Solid),
-          Polygon(
-            points={{-51,46},{-51,30},{15,-10},{15,6},{-51,46}},
+          Ellipse(
+            extent={{-64,50},{-48,34}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
+            fillPattern=FillPattern.Sphere,
             fillColor={215,215,215}),
-          Polygon(
-            points={{-48,45},{-52,46},{15,5},{19,5},{-48,45}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={0,0,0}),
-          Polygon(
-            points={{-58,34},{-55,31},{11,-9},{8,-6},{-58,34}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={0,0,0}),
-          Polygon(
-            points={{-52,46},{-54,45},{12,5},{14,6},{-52,46}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={95,95,95}),
-          Polygon(
-            points={{-58,35},{-58,34},{9,-7},{8,-5},{-58,35}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={95,95,95}),
-          Polygon(
-            points={{-54,45},{-56,44},{10,4},{12,5},{-54,45}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={135,135,135}),
-          Polygon(
-            points={{-59,37},{-58,35},{8,-5},{7,-3},{-59,37}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={135,135,135}),
-          Polygon(
-            points={{-56,44},{-58,42},{8,2},{10,4},{-56,44}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={175,175,175}),
-          Polygon(
-            points={{-59,39},{-59,37},{7,-3},{7,-1},{-59,39}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={175,175,175}),
-          Polygon(
-            points={{-58,42},{-59,39},{7,-1},{8,2},{-58,42}},
+          Rectangle(
+            extent={{-40.7541,7.9458},{40.7541,-7.9458}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={215,215,215}),
+            fillPattern=FillPattern.HorizontalCylinder,
+            fillColor={215,215,215},
+            origin={-21.1593,21.1992},
+            rotation=-31),
           Rectangle(
-            extent={{-88,8},{2,-6}},
+            extent={{-91,10},{-1,-10}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
             fillPattern=FillPattern.HorizontalCylinder,
             fillColor={215,215,215}),
+          Text(
+            extent={{-100,-55},{100,-95}},
+            lineColor={0,0,255},
+            fillColor={255,255,0},
+            fillPattern=FillPattern.Solid,
+            textString="%name"),
           Ellipse(
-            extent={{-6,18},{38,-22}},
+            extent={{-12,25},{38,-25}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
             fillPattern=FillPattern.Sphere,
             fillColor={215,215,215}),
-          Polygon(
-            points={{16,6},{16,-10},{82,-50},{82,-34},{16,6}},
+          Ellipse(
+            extent={{6,8},{22,-8}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
+            fillPattern=FillPattern.Sphere,
             fillColor={215,215,215}),
-          Polygon(
-            points={{19,5},{15,6},{82,-35},{86,-35},{19,5}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={0,0,0}),
-          Polygon(
-            points={{9,-6},{12,-9},{78,-49},{75,-46},{9,-6}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={0,0,0}),
-          Polygon(
-            points={{15,6},{13,5},{79,-35},{81,-34},{15,6}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={95,95,95}),
-          Polygon(
-            points={{9,-5},{9,-6},{76,-47},{75,-45},{9,-5}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={95,95,95}),
-          Polygon(
-            points={{13,5},{11,4},{77,-36},{79,-35},{13,5}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={135,135,135}),
-          Polygon(
-            points={{8,-3},{9,-5},{75,-45},{74,-43},{8,-3}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={135,135,135}),
-          Polygon(
-            points={{11,4},{9,2},{75,-38},{77,-36},{11,4}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={175,175,175}),
-          Polygon(
-            points={{8,-1},{8,-3},{74,-43},{74,-41},{8,-1}},
-            lineColor={0,0,0},
-            pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={175,175,175}),
-          Polygon(
-            points={{9,2},{8,-1},{74,-41},{75,-38},{9,2}},
+          Rectangle(
+            extent={{-40.7541,7.9458},{40.7541,-7.9458}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
-            fillPattern=FillPattern.Solid,
-            fillColor={215,215,215}),
+            fillPattern=FillPattern.HorizontalCylinder,
+            fillColor={215,215,215},
+            origin={48.8407,-20.8008},
+            rotation=-31),
           Ellipse(
-            extent={{74,-34},{90,-50}},
+            extent={{76,-34},{92,-50}},
             lineColor={0,0,0},
             pattern=LinePattern.None,
             fillPattern=FillPattern.Sphere,
-            fillColor={215,215,215}),
-          Text(
-            extent={{-100,-55},{100,-95}},
-            lineColor={0,0,255},
-            fillColor={255,255,0},
-            fillPattern=FillPattern.Solid,
-            textString="%name")}),
+            fillColor={215,215,215})}),
       Documentation(info="<html>
 <p>
 This partial class is intended to design a default icon for a <em>driveline assembly</em>.
@@ -1234,10 +1146,13 @@ This partial class is intended to design a default icon for a <em>road</em>.
             points={{-40,25},{40,25},{50,15},{40,-20},{30,-25},{-30,-25},{-40,
                 -20},{-50,15},{-40,25}},
             lineColor={0,0,0},
-            lineThickness=0.5)}),
+            lineThickness=0.5,
+            smooth=Smooth.Bezier)}),
       Documentation(info="<html>
 <p>
 This icon is designed for a <b>sub-bus</b> in a signal connector.
+It contains just an additional polygon as a graphical element in Diagram in order
+to highlight such a particular sub-bus.
 </p>
 </html>"));
   end SignalSubBusWithExplicitSignals;
diff --git a/VehicleInterfaces/PowertrainMounts.mo b/VehicleInterfaces/PowertrainMounts.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package PowertrainMounts "Collection of powertrain mounts subsystem definition"
-  extends Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Powertrain Mounts Tutorial"
     extends Modelica.Icons.Information;
diff --git a/VehicleInterfaces/Resources/Documentation/VehicleInterfaces.pdf b/VehicleInterfaces/Resources/Documentation/VehicleInterfaces.pdf
diff --git a/VehicleInterfaces/Roads.mo b/VehicleInterfaces/Roads.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Roads "Collection of road definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
 
   class Tutorial "Roads Tutorial"
     extends Modelica.Icons.Information;
@@ -479,7 +479,7 @@ of the functions.
       outer VehicleInterfaces.Roads.Interfaces.Base road;
 
       encapsulated function roadSurfaceCharacteristic
-      import  Modelica;
+      import Modelica;
       import VehicleInterfaces;
         extends
           Modelica.Mechanics.MultiBody.Interfaces.partialSurfaceCharacteristic(            final multiColoredSurface=false);
diff --git a/VehicleInterfaces/Transmissions.mo b/VehicleInterfaces/Transmissions.mo
@@ -1,6 +1,7 @@
 within VehicleInterfaces;
 package Transmissions "Collection of transmission subsystem definitions"
-  extends VehicleInterfaces.Icons.VariantLibrary;
+  extends Modelica.Icons.VariantsPackage;
+
   class Tutorial "Transmissions Tutorial"
     extends Modelica.Icons.Information;
 
diff --git a/VehicleInterfaces/Types.mo b/VehicleInterfaces/Types.mo
@@ -1,6 +1,6 @@
 within VehicleInterfaces;
 package Types "Collection of type definitions"
-  extends Modelica.Icons.Package;
+  extends Modelica.Icons.TypesPackage;
 
   type NormalizedReal = Modelica.Icons.TypeReal (
       final quantity="",
diff --git a/VehicleInterfaces/UsersGuide.mo b/VehicleInterfaces/UsersGuide.mo
diff --git a/VehicleInterfaces/libraryinfo.mos b/VehicleInterfaces/libraryinfo.mos
diff --git a/VehicleInterfaces/package.mo b/VehicleInterfaces/package.mo
