Feature/update to latest aspect model loader version (#52)

* Update JS AML version to be based on SAMM 2.1.0

Author: michelu89

README.md

@@ -206,21 +206,22 @@ File _app/shared/types/movement.types.ts_
 
 ```typescript
 export interface Movement {
-    moving: boolean;
-    speedLimitWarning: WarningLevel;
+    isMoving: boolean;
+    speed: number;
+    speedLimitWarning: TrafficLight;
     position: SpatialPosition;
 }
 
-export enum WarningLevel {
+export enum TrafficLight {
     Green = 'green',
     Yellow = 'yellow',
     Red = 'red',
 }
 
 export interface SpatialPosition {
-    x: number;
-    y: number;
-    z: number;
+    latitude: number;
+    longitude: number;
+    altitude?: number;
 }
 ```
 

documentation/js-sdk-guide/modules/tooling-guide/examples/Movement.ttl

@@ -9,76 +9,109 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:1.0.0#> .
-@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:1.0.0#> .
-@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:1.0.0#> .
+@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#> .
+@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#> .
+@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.1.0#> .
+@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.1.0#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-@prefix : <urn:samm:org.eclipse.examples.movement:2.1.0#> .
+@prefix : <urn:samm:org.eclipse.examples:2.1.0#> .
 
 :Movement a samm:Aspect ;
-   samm:preferredName "Movement"@en ;
+   samm:name "Movement" ;
+   samm:preferredName "movement"@en ;
    samm:description "Aspect for movement information"@en ;
-   samm:properties ( :moving :speedLimitWarning :position :startDate :endDate ) ;
-   samm:operations () .
+   samm:properties ( :isMoving :position :speed :speedLimitWarning ) ;
+   samm:operations ( ) ;
+   samm:events ( ) .
 
-:moving a samm:Property ;
-   samm:preferredName "Moving"@en ;
-   samm:description "Flag indicating if the position is changing"@en ;
+:isMoving a samm:Property ;
+   samm:name "isMoving" ;
+   samm:preferredName "is moving"@en ;
+   samm:description "Flag indicating whether the asset is currently moving"@en ;
    samm:characteristic samm-c:Boolean .
 
-:startDate a samm:Property ;
-    samm:preferredName  "Start Date"@en ;
-    samm:description    "Date, when the batch was started"@en ;
-    samm:characteristic samm-c:Timestamp .
-
-:endDate a samm:Property ;
-    samm:preferredName  "End Date"@en ;
-    samm:description    "Date, when the last part of the batch was produced"@en ;
-    samm:characteristic samm-c:Timestamp .
-
-:speedLimitWarning a samm:Property ;
-   samm:preferredName "Speed Limit Warning"@en ;
-   samm:description "Indicates if speed limit is adhered to."@en ;
-   samm:characteristic :WarningLevel .
-
 :position a samm:Property ;
-   samm:preferredName "Position"@en ;
+   samm:name "position" ;
+   samm:preferredName "position"@en ;
    samm:description "Indicates a position"@en ;
    samm:characteristic :SpatialPositionCharacteristic .
 
+:speed a samm:Property ;
+   samm:name "speed" ;
+   samm:preferredName "speed"@en ;
+   samm:description "speed of vehicle"@en ;
+   samm:characteristic :Speed .
+
+:speedLimitWarning a samm:Property ;
+   samm:name "speedLimitWarning" ;
+   samm:preferredName "speed limit warning"@en ;
+   samm:description "Indicates if the speed limit is adhered to."@en ;
+   samm:characteristic :TrafficLight .
+
 :SpatialPositionCharacteristic a samm-c:SingleEntity ;
-   samm:preferredName "Spatial Position Characteristic"@en ;
-   samm:description "Represents a single location in space."@en ;
+   samm:name "SpatialPositionCharacteristic" ;
+   samm:preferredName "spatial position characteristic"@en ;
+   samm:description "Represents a single position in space with optional z coordinate."@en ;
    samm:dataType :SpatialPosition .
 
-:WarningLevel a samm-c:Enumeration ;
-   samm:preferredName "Warning Level"@en ;
+:Speed a samm-c:Measurement ;
+   samm:name "Speed" ;
+   samm:preferredName "speed"@en ;
+   samm:description "Scalar representation of speed of an object in kilometers per hour."@en ;
+   samm:dataType xsd:float ;
+   samm-c:unit unit:kilometrePerHour .
+
+:TrafficLight a samm-c:Enumeration ;
+   samm:name "TrafficLight" ;
+   samm:preferredName "warning level"@en ;
    samm:description "Represents if speed of position change is within specification (green), within tolerance (yellow), or outside specification (red)."@en ;
    samm:dataType xsd:string ;
    samm-c:values ( "green" "yellow" "red" ) .
 
 :SpatialPosition a samm:Entity ;
-   samm:preferredName "Spatial Position"@en ;
-   samm:description "Position in space, described along three axis, with the third axis optional, if all positions are in a plane."@en ;
-   samm:properties ( :x :y :z ) .
+   samm:name "SpatialPosition" ;
+   samm:preferredName "spatial position"@en ;
+   samm:description "Represents latitude, longitude and altitude information in the WGS84 geodetic reference datum"@en ;
+   samm:see <https://www.w3.org/2003/01/geo/> ;
+   samm:properties ( :latitude :longitude [ samm:property :altitude; samm:optional true ] ) .
 
-:x a samm:Property ;
-   samm:preferredName "x"@en ;
-   samm:description "x coordinate in space"@en ;
-   samm:characteristic :Coordinate .
+:latitude a samm:Property ;
+   samm:name "latitude" ;
+   samm:preferredName "latitude"@en ;
+   samm:description "latitude coordinate in space (WGS84)"@en ;
+   samm:see <http://www.w3.org/2003/01/geo/wgs84_pos#lat> ;
+   samm:characteristic :Coordinate ;
+   samm:exampleValue "9.1781"^^xsd:decimal .
 
-:y a samm:Property ;
-   samm:preferredName "y"@en ;
-   samm:description "y coordinate in space"@en ;
-   samm:characteristic :Coordinate .
+:longitude a samm:Property ;
+   samm:name "longitude" ;
+   samm:preferredName "longitude"@en ;
+   samm:description "longitude coordinate in space (WGS84)"@en ;
+   samm:see <http://www.w3.org/2003/01/geo/wgs84_pos#long> ;
+   samm:characteristic :Coordinate ;
+   samm:exampleValue "48.80835"^^xsd:decimal .
 
-:z a samm:Property ;
-   samm:preferredName "z"@en ;
-   samm:description "z coordinate in space"@en ;
-   samm:characteristic :Coordinate .
+:altitude a samm:Property ;
+   samm:name "altitude" ;
+   samm:preferredName "altitude"@en ;
+   samm:description "Elevation above sea level zero"@en ;
+   samm:see <http://www.w3.org/2003/01/geo/wgs84_pos#alt> ;
+   samm:characteristic :MetresAboveMeanSeaLevel ;
+   samm:exampleValue "153"^^xsd:float .
 
 :Coordinate a samm-c:Measurement ;
-   samm:preferredName "Coordinate"@en ;
-   samm:description "Represents a coordinate along an axis in space."@en ;
+   samm:name "Coordinate" ;
+   samm:preferredName "coordinate"@en ;
+   samm:description "Representing the geographical coordinate"@en ;
+   samm:dataType xsd:decimal ;
+   samm-c:unit unit:degreeUnitOfAngle .
+
+:MetresAboveMeanSeaLevel a samm-c:Measurement ;
+   samm:name "MetresAboveMeanSeaLevel" ;
+   samm:preferredName "metres above mean sea level"@en ;
+   samm:description "Signifies the vertical distance in reference to a historic mean sea level as a vertical datum"@en ;
+   samm:see <https://en.wikipedia.org/wiki/Height_above_sea_level> ;
    samm:dataType xsd:float ;
-   samm-c:unit unit:metre .
+   samm-c:unit unit:metre .

documentation/js-sdk-guide/modules/tooling-guide/examples/movement.types.ts

@@ -11,35 +11,36 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/**
- * Aspect for movement information
- */
+export interface MultiLanguageText {
+    /** key defines the locale. Value is the translated text for that locale. */
+    [key: string]: string;
+}
+
+/** Aspect for movement information */
 export interface Movement {
-    /** Flag indicating if the position is changing */
-    moving: boolean;
-    /** Indicates if speed limit is adhered to. */
-    speedLimitWarning: WarningLevel;
+    /** Flag indicating whether the asset is currently moving */
+    isMoving: boolean;
     /** Indicates a position */
     position: SpatialPosition;
+    /** speed of vehicle */
+    speed: number;
+    /** Indicates if the speed limit is adhered to. */
+    speedLimitWarning: TrafficLight;
 }
 
-/**
- * Represents if speed of position change is within specification (green), within tolerance (yellow), or outside specification (red).
- */
-export enum WarningLevel {
+/** Represents latitude, longitude and altitude information in the WGS84 geodetic reference datum */
+export interface SpatialPosition {
+    /** latitude coordinate in space (WGS84) */
+    latitude: number;
+    /** longitude coordinate in space (WGS84) */
+    longitude: number;
+    /** Elevation above sea level zero */
+    altitude?: number;
+}
+
+/** Represents if speed of position change is within specification (green), within tolerance (yellow), or outside specification (red). */
+export enum TrafficLight {
     Green = 'green',
     Yellow = 'yellow',
     Red = 'red',
 }
-
-/**
- * Position in space, described along three axis, with the third axis optional, if all positions are in a plane.
- */
-export interface SpatialPosition {
-    /** x coordinate in space */
-    x: number;
-    /** y coordinate in space */
-    y: number;
-    /** z coordinate in space */
-    z: number;
-}

documentation/js-sdk-guide/modules/tooling-guide/images/aspect.png

@@ -25,7 +25,7 @@ A schematics will be generated using the following command:
 ng generate [collection-name]:[schematics-name]
 
 
-For demonstration purposes, the https://github.com/eclipse-esmf/esmf-aspect-model-editor/blob/main/core/apps/ame/src/assets/aspect-models/org.esmf.examples.movement/1.0.0/Movement.ttl[Movement.ttl,window=_blank,opts=nofollow] Aspect Model will be used.
+For demonstration purposes, the https://github.com/eclipse-esmf/esmf-aspect-model-editor/blob/main/core/apps/ame/src/assets/aspect-models/org.eclipse.examples/1.0.0/Movement.ttl[Movement.ttl,window=_blank,opts=nofollow] Aspect Model will be used.
 Below is a detailed representation of the command-line interface steps which generates a card component using the Movement.ttl Aspect Model file by running the command.
 
 NOTE: Before running any schematics commands make sure you are in the Angular project folder where you want to generate the new component.