Merge pull request #70 from open-simulation-platform/release/0.12.0

Release/0.12.0

CONTRIBUTING.md

@@ -25,7 +25,16 @@ will be included in this repository with guidelines once concluded.
 Workflow
 --------
 This repository uses the [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) 
-workflow
+workflow. In short, it means the following:
+
+**Branch types**
+* `master`  - Only contains release commits.
+* `develop` - All development happens on this branch.
+* `feature` - Branches from `develop` and are merged back into `develop`.
+* `release` - Branches from `develop`. Final touches before releasing. When ready to release, merge into `master` and 
+back into `develop`.
+* `hotfix` - Branches from `master`. When hotfix is ready, merge back into `master` for new hotfix release and into 
+`develop`.
 
 
 Creating new releases

README.md

@@ -1,6 +1,6 @@
 Description
 ===========
-Supports version 1.0 of [OSP-IS](https://www.opensimulationplatform.com/assets/osp-is.pdf)
+Supports version 1.0 of [OSP-IS](https://opensimulationplatform.com/specification)
 
 This is a java project consisting of a java library, and a command line interface tool to validate FMUs and simulation
 configurations against OSP-IS.
@@ -46,4 +46,4 @@ $ cd osp-validator
 $ mvn clean package
 ```
 
-`<module-dir>/target` will contain the compiled artifacts.
+`<module-dir>/target` will contain the compiled artifacts.

osp-model-description/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.11.0</version>
+    <version>0.12.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 

osp-system-structure/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.11.0</version>
+    <version>0.12.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 

osp-validator-api/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.11.0</version>
+    <version>0.12.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 

osp-validator-cli/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.11.0</version>
+    <version>0.12.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 

osp-validator-cli/src/main/resources/example/CraneController_OspModelDescription.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<OspModelDescription xmlns="https://open-simulation-platform.com/OspModelDescription/1.0.0" version="1.0">
+  <VariableGroups>
+    <Generic name="actuator_limits">
+      <Variable ref="Act_Limits[1]"/>
+      <Variable ref="Act_Limits[2]"/>
+      <Variable ref="Act_Limits[3]"/>
+    </Generic>
+    <LinearMechanicalPort name="linear_mechanical_port">
+      <Force name="force">
+        <Variable ref="p_Crane.e[1]"/>
+        <Variable ref="p_Crane.e[2]"/>
+        <Variable ref="p_Crane.e[3]"/>
+      </Force>
+      <LinearVelocity name="linear_velocity">
+        <Variable ref="p_Crane.f[1]"/>
+        <Variable ref="p_Crane.f[2]"/>
+        <Variable ref="p_Crane.f[3]"/>
+      </LinearVelocity>
+    </LinearMechanicalPort>
+  </VariableGroups>
+</OspModelDescription>

osp-validator-cli/src/main/resources/example/KnuckleBoomCrane_OspModelDescription.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<OspModelDescription xmlns="https://open-simulation-platform.com/OspModelDescription/1.0.0" version="1.0">
+  <UnitDefinitions>
+    <Unit name="a">
+      <BaseUnit kg="1"/>
+    </Unit>
+    <Unit name="b">
+      <BaseUnit kg="2"/>
+    </Unit>
+  </UnitDefinitions>
+  <VariableGroups>
+    <Generic name="actuator_limits">
+      <Variable ref="Act_Limits[1]"/>
+      <Variable ref="Act_Limits[2]"/>
+      <Variable ref="Act_Limits[3]"/>
+    </Generic>
+    <LinearMechanicalPort name="linear_mechanical_port">
+      <Force name="force">
+        <Variable ref="p_Crane.e[1]"/>
+        <Variable ref="p_Crane.e[2]"/>
+        <Variable ref="p_Crane.e[3]"/>
+      </Force>
+      <LinearVelocity name="linear_velocity">
+        <Variable ref="p_Crane.f[1]"/>
+        <Variable ref="p_Crane.f[2]"/>
+        <Variable ref="p_Crane.f[3]"/>
+      </LinearVelocity>
+    </LinearMechanicalPort>
+  </VariableGroups>
+</OspModelDescription>

osp-validator-cli/src/main/resources/example/OspSystemStructure_Crane.xml

@@ -0,0 +1,16 @@
+<OspSystemStructure version="0.1" xmlns="http://opensimulationplatform.com/MSMI/OSPSystemStructure">
+  <Simulators>
+    <Simulator name="crane_controller" source="CraneController.fmu" stepSize="1.051732E7"/>
+    <Simulator name="knuckle_boom_crane" source="KnuckleBoomCrane.fmu" stepSize="1.051732E7"/>
+  </Simulators>
+  <Connections>
+    <VariableConnection>
+      <Variable simulator="crane_controller" name="Act_Limits[1]"/>
+      <Variable simulator="knuckle_boom_crane" name="Act_Limits[1]"/>
+    </VariableConnection>
+    <VariableGroupConnection>
+      <VariableGroup simulator="crane_controller" name="linear_mechanical_port"/>
+      <VariableGroup simulator="knuckle_boom_crane" name="linear_mechanical_port"/>
+    </VariableGroupConnection>
+  </Connections>
+</OspSystemStructure>

osp-validator-cli/src/test/java/com/opensimulationplatform/cli/ExampleTest.java

@@ -0,0 +1,33 @@
+package com.opensimulationplatform.cli;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.contrib.java.lang.system.ExpectedSystemExit;
+
+public class ExampleTest {
+
+  @Rule
+  public final ExpectedSystemExit exit = ExpectedSystemExit.none();
+
+  @Test
+  public void canValidateOspSystemStructure() {
+    exit.expectSystemExitWithStatus(0);
+    Main.main(new String[]{"osp-system-structure", "-file", "./src/main/resources/example/OspSystemStructure_Crane.xml"});
+  }
+
+  @Test
+  public void canValidateKnuckleBoomCraneOspModelDescription() {
+    exit.expectSystemExitWithStatus(0);
+    Main.main(new String[]{"osp-model-description",
+        "-file", "./src/main/resources/example/KnuckleBoomCrane_OspModelDescription.xml",
+        "-fmu", "./src/main/resources/example/KnuckleBoomCrane.fmu"});
+  }
+
+  @Test
+  public void canValidateCraneControllerOspModelDescription() {
+    exit.expectSystemExitWithStatus(0);
+    Main.main(new String[]{"osp-model-description",
+        "-file", "./src/main/resources/example/CraneController_OspModelDescription.xml",
+        "-fmu", "./src/main/resources/example/CraneController.fmu"});
+  }
+}

osp-validator-core/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.11.0</version>
+    <version>0.12.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 
@@ -27,11 +27,6 @@
   </repositories>
 
   <dependencies>
-    <dependency>
-      <groupId>com.fasterxml.jackson.core</groupId>
-      <artifactId>jackson-databind</artifactId>
-      <version>2.9.8</version>
-    </dependency>
     <dependency>
       <groupId>net.sourceforge.owlapi</groupId>
       <artifactId>owlapi-distribution</artifactId>

osp-validator-gen/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <artifactId>osp-validator</artifactId>
     <groupId>com.opensimulationplatform</groupId>
-    <version>0.11.0</version>
+    <version>0.12.0</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 

pom.xml

@@ -13,7 +13,7 @@
   <groupId>com.opensimulationplatform</groupId>
   <artifactId>osp-validator</artifactId>
   <packaging>pom</packaging>
-  <version>0.11.0</version>
+  <version>0.12.0</version>
   <modules>
     <module>osp-validator-gen</module>
     <module>osp-validator-core</module>