diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d79dae..a53b538 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e ## [Unreleased] +## [0.0.6] - 2024-04-04 + ### Changed - Updated README.md with a getting started section. @@ -103,7 +105,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e -[unreleased]: https://github.com/dnv-opensource/maritime-schema/compare/v0.0.5...HEAD +[unreleased]: https://github.com/dnv-opensource/maritime-schema/compare/v0.0.6...HEAD +[0.0.6]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.5...v0.0.6 [0.0.5]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.4...v0.0.5 [0.0.4]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.3...v0.0.4 [0.0.3]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.2...v0.0.3 diff --git a/docs/schema/caga/input_schema.html b/docs/schema/caga/input_schema.html index 557b635..ae08127 100644 --- a/docs/schema/caga/input_schema.html +++ b/docs/schema/caga/input_schema.html @@ -1,6 +1,6 @@ Test Input Schema

Test Input Schema

Type: object

Title

Type: string Default: null

The title of the traffic situation
Example:

"overtaking_18"

Description

Default: null

A description of the traffic situation

Type: string
Type: null

Example:

"Crossing situation with 3 target vessels in the Oslofjord"
-

Starttime

Default: null

Starting time of the situation in ISO 8601 format YYYY-MM-DDThh:mm:ssZ

Type: stringFormat: date-time
Type: null

Example:

"2024-04-04T09:29:16.243578"
+

Starttime

Default: null

Starting time of the situation in ISO 8601 format YYYY-MM-DDThh:mm:ssZ

Type: stringFormat: date-time
Type: null

Example:

"2024-04-04T15:28:16.125239"

Own Ship data

Type: object

Own Ship data
Example:

{
     "initial": {
         "cog": 284.2,
@@ -58,7 +58,7 @@
     "speedMax": 20.0,
     "width": 30.0
 }
-

Id

Type: stringFormat: uuid

Unique Identifier
Example:

"eea9f050-6253-4d81-bc77-c3f0f198ec03"
+

Id

Type: stringFormat: uuid

Unique Identifier
Example:

"c8067411-76fe-421d-a60e-07b30948fdd3"

Length

Type: number Default: null

Length of the ship in meters

Value must be strictly greater than 0.0


Example:

230.0

Width

Type: number Default: null

Width of the ship in meters

Value must be strictly greater than 0.0


Example:

30.0

Height

Default: null

Height of the ship in meters

Type: number

Value must be strictly greater than 0.0

Type: null

Example:

15.0
@@ -124,7 +124,7 @@
     "speedMax": 20.0,
     "width": 30.0
 }
-

Id

Type: stringFormat: uuid

Unique Identifier
Example:

"eea9f050-6253-4d81-bc77-c3f0f198ec03"
+

Id

Type: stringFormat: uuid

Unique Identifier
Example:

"c8067411-76fe-421d-a60e-07b30948fdd3"

Length

Type: number Default: null

Length of the ship in meters

Value must be strictly greater than 0.0


Example:

230.0

Width

Type: number Default: null

Width of the ship in meters

Value must be strictly greater than 0.0


Example:

30.0

Height

Default: null

Height of the ship in meters

Type: number

Value must be strictly greater than 0.0

Type: null

Example:

15.0
@@ -255,4 +255,4 @@
     "windDirection": 180.0,
     "windSpeed": 10.0
 }
-

Additional Properties of any type are allowed.

Type: object
\ No newline at end of file +

Additional Properties of any type are allowed.

Type: object
\ No newline at end of file diff --git a/docs/schema/caga/output_schema.html b/docs/schema/caga/output_schema.html index 9ab6357..b892567 100644 --- a/docs/schema/caga/output_schema.html +++ b/docs/schema/caga/output_schema.html @@ -1,7 +1,7 @@ - Test Output Schema

Test Output Schema

Type: object

This is a JSON schema for result data originating from Collision and Grounding Avoidance systems

Creationtime

Type: stringFormat: date-time

Date and Time that this file was created, in ISO 8601 format YYYY-MM-DDThh:mm:ssZ. This should be the simulation end time.
Example:

"2024-04-04T09:29:16.257939"
+ Test Output Schema 
   
 
Test Output Schema
Type: object
 
This is a JSON schema for result data originating from Collision and Grounding Avoidance systems
  
 
 
 
  
 
 
 
 
Creationtime
Type: stringFormat: date-time
 
Date and Time that this file was created, in ISO 8601 format YYYY-MM-DDThh:mm:ssZ. This should be the simulation end time.
  
 
Example:
 
"2024-04-04T15:28:16.148176"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Default: null
 
The traffic situation that was simulated (input file). This should remain unmofidied.
 
  
 
 Type: object
 
 
 
 
  
 
 
 
 
Title
Type: string Default: null
 
The title of the traffic situation
  
 
Example:
 
"overtaking_18"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Description
 Default: null
 
A description of the traffic situation
 
  
 
 Type: string
 
 Type: null
 
 
 
Example:
 
"Crossing situation with 3 target vessels in the Oslofjord"
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Starttime
 Default: null
 
Starting time of the situation in ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: null
 
 
 
Example:
 
"2024-04-04T09:29:16.243578"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Starttime
 Default: null
 
Starting time of the situation in ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: null
 
 
 
Example:
 
"2024-04-04T15:28:16.125239"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Own Ship data
Type: object
 
Own Ship data
  
 
Example:
 
{
     "initial": {
         "cog": 284.2,
@@ -59,7 +59,7 @@
     "speedMax": 20.0,
     "width": 30.0
 }
-
 
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"eea9f050-6253-4d81-bc77-c3f0f198ec03"
+
 
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"c8067411-76fe-421d-a60e-07b30948fdd3"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Length
Type: number Default: null
 
Length of the ship in meters
  
Value must be strictly greater than 0.0
 
 
Example:
 
230.0
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Width
Type: number Default: null
 
Width of the ship in meters
  
Value must be strictly greater than 0.0
 
 
Example:
 
30.0
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Height
 Default: null
 
Height of the ship in meters
 
  
 
 Type: number
 
Value must be strictly greater than 0.0
 
 Type: null
 
 
 
Example:
 
15.0
@@ -125,7 +125,7 @@
     "speedMax": 20.0,
     "width": 30.0
 }
-
 
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"eea9f050-6253-4d81-bc77-c3f0f198ec03"
+
 
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"c8067411-76fe-421d-a60e-07b30948fdd3"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Length
Type: number Default: null
 
Length of the ship in meters
  
Value must be strictly greater than 0.0
 
 
Example:
 
230.0
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Width
Type: number Default: null
 
Width of the ship in meters
  
Value must be strictly greater than 0.0
 
 
Example:
 
30.0
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Height
 Default: null
 
Height of the ship in meters
 
  
 
 Type: number
 
Value must be strictly greater than 0.0
 
 Type: null
 
 
 
Example:
 
15.0
@@ -266,8 +266,8 @@
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: number
 
Time given in seconds to the navigator / system, before the proposed manoeuver is no longer able to be excecuted
  
 
Example:
 
20
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: number
 
Minimum safety depth
  
 
Example:
 
30
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: number
 
If automatic maneuver acceptance is enabled, the new route will be activated after a specified number of seconds
  
 
Example:
 
20
-
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Timeseriesdata
Type: array
 
Time series data from the system
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the predicted value ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T09:29:16.251573"
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Targetships
Type: array
 
list of target ships detected by the CAGA system
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"f253f15f-32b9-4806-87a3-a3d3a20dbb6c"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Timeseriesdata
Type: array
 
Time series data from the system
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the predicted value ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T15:28:16.135180"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Targetships
Type: array
 
list of target ships detected by the CAGA system
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"44febc4b-3376-42d7-9573-1ddfcdea77a2"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: object
 
A geographical coordinate
  
 
Example:
 
{
     "latitude": 51.2123,
     "longitude": 11.2313
@@ -285,7 +285,7 @@
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Distancetotarget
Type: number Default: null
 
Calculated distance from the own ship to the target vessel
  
 
Example:
 
1900.2
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Dcpa
 Default: null
 
Calculated closest point of approach
 
  
 
 Type: number
 
 Type: null
 
 
 
Example:
 
100.3
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Tcpa
 Default: null
 
calculated time to closest point of approach in seconds
 
  
 
 Type: number
 
 Type: null
 
 
 
Example:
 
2131
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Predictions
 Default: null
 
List of predicted future values. This can be used to store data like a predicted path for each target vessel. The value field supports both numbers and objects
 
  
 
 Type: object
 
 
 
 
  
 
 
 
Each additional property must conform to the following schema
 Type: array
 No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the predicted value ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T09:29:16.246802"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Predictions
 Default: null
 
List of predicted future values. This can be used to store data like a predicted path for each target vessel. The value field supports both numbers and objects
 
  
 
 Type: object
 
 
 
 
  
 
 
 
Each additional property must conform to the following schema
 Type: array
 No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the predicted value ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T15:28:16.129205"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Value

 
Value of the prediction
 
  
 
 Type: number
 
 Type: object
 
 
 
Examples:
 
{
     "latitude": 57.2343,
     "longitude": 10.3432
@@ -293,21 +293,21 @@
 
 
100
 
 
 
 
 
 
 
 
 
 
 
 
 
 Type: null
 
 
 
Example:
 
[
     {
-        "time": "2024-04-04T09:29:16.247716",
+        "time": "2024-04-04T15:28:16.130246",
         "value": {
             "latitude": 57.2343,
             "longitude": 10.3432
         }
     },
     {
-        "time": "2024-04-04T09:29:16.247731",
+        "time": "2024-04-04T15:28:16.130262",
         "value": {
             "latitude": 57.2343,
             "longitude": 10.3432
         }
     },
     {
-        "time": "2024-04-04T09:29:16.247736",
+        "time": "2024-04-04T15:28:16.130269",
         "value": {
             "latitude": 57.2343,
             "longitude": 10.3432
@@ -333,21 +333,21 @@
         "predictions": {
             "position": [
                 {
-                    "time": "2024-04-04T09:29:16.251611",
+                    "time": "2024-04-04T15:28:16.135228",
                     "value": {
                         "latitude": 57.2343,
                         "longitude": 10.3432
                     }
                 },
                 {
-                    "time": "2024-04-04T09:29:16.251618",
+                    "time": "2024-04-04T15:28:16.135237",
                     "value": {
                         "latitude": 57.2343,
                         "longitude": 10.3432
                     }
                 },
                 {
-                    "time": "2024-04-04T09:29:16.251623",
+                    "time": "2024-04-04T15:28:16.135243",
                     "value": {
                         "latitude": 57.2343,
                         "longitude": 10.3432
@@ -381,21 +381,21 @@
                 "predictions": {
                     "position": [
                         {
-                            "time": "2024-04-04T09:29:16.254298",
+                            "time": "2024-04-04T15:28:16.141020",
                             "value": {
                                 "latitude": 57.2343,
                                 "longitude": 10.3432
                             }
                         },
                         {
-                            "time": "2024-04-04T09:29:16.254304",
+                            "time": "2024-04-04T15:28:16.141044",
                             "value": {
                                 "latitude": 57.2343,
                                 "longitude": 10.3432
                             }
                         },
                         {
-                            "time": "2024-04-04T09:29:16.254308",
+                            "time": "2024-04-04T15:28:16.141064",
                             "value": {
                                 "latitude": 57.2343,
                                 "longitude": 10.3432
@@ -407,10 +407,10 @@
                 "tcpa": 1200.0
             }
         ],
-        "time": "2024-04-04T09:29:16.254285"
+        "time": "2024-04-04T15:28:16.140981"
     }
 ]
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Eventdata
Type: array Default: null
 
Event data from the system
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the event
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T09:29:16.252730"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Eventdata
Type: array Default: null
 
Event data from the system
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the event
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T15:28:16.136594"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Route
Type: array Default: null
 
Planned CAGA Route
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 Type: object
 
A geographical coordinate
  
 
Example:
 
{
     "latitude": 51.2123,
     "longitude": 11.2313
@@ -551,7 +551,7 @@
                 "turnRadius": 500.0
             }
         ],
-        "time": "2024-04-04T09:29:16.254349"
+        "time": "2024-04-04T15:28:16.141188"
     }
 ]
 
 
 
 
 
 
 
 Type: null
 
 
 
Example:
 
{
@@ -628,7 +628,7 @@
                     "turnRadius": 500.0
                 }
             ],
-            "time": "2024-04-04T09:29:16.258054"
+            "time": "2024-04-04T15:28:16.148333"
         }
     ],
     "timeSeriesData": [
@@ -653,21 +653,21 @@
                     "predictions": {
                         "position": [
                             {
-                                "time": "2024-04-04T09:29:16.258028",
+                                "time": "2024-04-04T15:28:16.148295",
                                 "value": {
                                     "latitude": 57.2343,
                                     "longitude": 10.3432
                                 }
                             },
                             {
-                                "time": "2024-04-04T09:29:16.258034",
+                                "time": "2024-04-04T15:28:16.148304",
                                 "value": {
                                     "latitude": 57.2343,
                                     "longitude": 10.3432
                                 }
                             },
                             {
-                                "time": "2024-04-04T09:29:16.258039",
+                                "time": "2024-04-04T15:28:16.148310",
                                 "value": {
                                     "latitude": 57.2343,
                                     "longitude": 10.3432
@@ -679,7 +679,7 @@
                     "tcpa": 1200.0
                 }
             ],
-            "time": "2024-04-04T09:29:16.258016"
+            "time": "2024-04-04T15:28:16.148277"
         }
     ]
 }
@@ -691,8 +691,8 @@
 
 
 
 
 
 
  
 
 
 
 
Name
Type: string
 
The name of the system
  
 
Example:
 
"AutoNavigation-System 1"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Vendor
Type: string
 
The name of the system vendor
  
 
Example:
 
"CompanyABC"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Version
Type: string
 
The software version
  
 
Example:
 
"1.2.3"
-
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Timeseriesdata
Type: array
 
TimeSeries data originating from the Simulator
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the predicted value ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T09:29:16.255666"
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"a42539cc-659c-437f-8583-d7314c9fa571"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Timeseriesdata
Type: array
 
TimeSeries data originating from the Simulator
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the predicted value ISO 8601 format YYYY-MM-DDThh:mm:ssZ
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T15:28:16.144585"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"8e8120b8-b87f-4fae-8632-e17f4c535c73"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: object
 
A geographical coordinate
  
 
Example:
 
{
     "latitude": 51.2123,
     "longitude": 11.2313
@@ -704,7 +704,7 @@
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
ship heading
 Default: null
 
Initial ship heading in degrees
 
  
 
 Type: number
 
Value must be greater or equal to 0.0 and lesser or equal to 360.0
 
 Type: null
 
 
 
Example:
 
45.2
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: enum (of string)
 
AIS Navigational Status
  
 
Must be one of:
 
  • "Under way using engine"
  • "At anchor"
  • "Not under command"
  • "Restricted manoeuverability"
  • "Constrained by her draught"
  • "Moored"
  • "Aground"
  • "Engaged in fishing"
  • "Under way sailing"
  • "Reserved for future amendment of navigational status for HSC"
  • "Reserved for future amendment of navigational status for WIG"
  • "Reserved for future use 1"
  • "Reserved for future use 2"
  • "Reserved for future use 3"
  • "AIS SART is active"
  • "Not defined (default)"
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Acceleration
Type: number Default: null
 
Ship acceleration in ms^-2
  
 
Example:
 
0.01
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Rateofturn
Type: number Default: null
 
Ship rate of turn in deg/s
  
 
Example:
 
1.8
-
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Targetships
Type: array
 No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"a42539cc-659c-437f-8583-d7314c9fa571"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Targetships
Type: array
 No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Id
Type: stringFormat: uuid
 
Unique Identifier
  
 
Example:
 
"8e8120b8-b87f-4fae-8632-e17f4c535c73"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 Type: object
 
A geographical coordinate
  
 
Example:
 
{
     "latitude": 51.2123,
     "longitude": 11.2313
@@ -759,7 +759,7 @@
                 "sog": 10.0
             }
         ],
-        "time": "2024-04-04T09:29:16.256655"
+        "time": "2024-04-04T15:28:16.146312"
     },
     {
         "ownShip": {
@@ -803,10 +803,10 @@
                 "sog": 10.0
             }
         ],
-        "time": "2024-04-04T09:29:16.256694"
+        "time": "2024-04-04T15:28:16.146397"
     }
 ]
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Eventdata
Type: array Default: null
 
Event data from the simulator
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the event
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T09:29:16.253771"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 
Eventdata
Type: array Default: null
 
Event data from the simulator
  No Additional Items
Each item of this array must be:
 
 
 Type: object
 
 
 
 
  
 
 
 
 
Time

 
Date and Time of the event
 
  
 
 Type: stringFormat: date-time
 
 Type: integer
 
 
 
Example:
 
"2024-04-04T15:28:16.139551"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
 
 
 
 
 
 
 
 Type: null
 
 
 
Example:
 
{
     "configuration": {
         "name": "AutoNavigation-System 1",
@@ -857,7 +857,7 @@
                     "sog": 10.0
                 }
             ],
-            "time": "2024-04-04T09:29:16.258221"
+            "time": "2024-04-04T15:28:16.148436"
         },
         {
             "ownShip": {
@@ -901,8 +901,8 @@
                     "sog": 10.0
                 }
             ],
-            "time": "2024-04-04T09:29:16.258254"
+            "time": "2024-04-04T15:28:16.148473"
         }
     ]
 }
-
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 Type: object
 
 
 
 
  
\ No newline at end of file
+

Additional Properties of any type are allowed.

Type: object
\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 720d012..61610b4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,7 +23,7 @@ author = "Minos Hemrich, Tom Arne Pedersen, Claas Rostock" # The full version, including alpha/beta/rc tags -release = "0.0.5" +release = "0.0.6" # -- General configuration --------------------------------------------------- diff --git a/examples/output_schema_file.json b/examples/output_schema_file.json index bd4cf43..70df722 100644 --- a/examples/output_schema_file.json +++ b/examples/output_schema_file.json @@ -1,5 +1,5 @@ { - "creationTime": "2024-04-04T09:05:32.273560", + "creationTime": "2024-04-04T12:07:44.988092", "trafficSituation": { "title": "example situation", "description": "an example traffic situation generated using the python package maritime-schema", @@ -56,10 +56,10 @@ }, "timeSeriesData": [ { - "time": "2024-04-04T09:05:32.273459", + "time": "2024-04-04T12:07:44.987960", "targetShips": [ { - "id": "30193e48-3e3d-4a2d-a473-84674c90d906", + "id": "9c6a955b-2b90-4707-a660-d3bdf58e1f7a", "position": { "latitude": 1.23, "longitude": 1.24 @@ -81,10 +81,10 @@ } }, { - "time": "2024-04-04T09:05:33.273461", + "time": "2024-04-04T12:07:45.987963", "targetShips": [ { - "id": "2525a2f1-6b2a-4e0e-908c-c759aae11488", + "id": "e2742314-23ec-41d2-b970-8306cb5d7f4f", "position": { "latitude": 1.231, "longitude": 1.242 @@ -108,7 +108,7 @@ ], "eventData": [ { - "time": "2024-04-04T09:05:32.273432", + "time": "2024-04-04T12:07:44.987924", "route": [ { "position": { diff --git a/examples/traffic_situation.json b/examples/traffic_situation.json index acfabac..67fc4ad 100644 --- a/examples/traffic_situation.json +++ b/examples/traffic_situation.json @@ -1,10 +1,10 @@ { "title": "example situation", "description": "an example traffic situation generated using the python package maritime-schema", - "startTime": "2024-04-03T14:13:21.756135", + "startTime": "2024-04-04T12:07:50.332617", "ownShip": { "static": { - "id": "14c94b5f-00ee-4c30-97c9-507862915076", + "id": "98561680-57a2-4c40-b0dc-018a8e68d7fc", "length": 200.0, "width": 30.0, "height": 10.0, diff --git a/pyproject.toml b/pyproject.toml index c9e0b77..09e9532 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "maritime-schema" -version = "0.0.5" +version = "0.0.6" description = "Python data classes and JSON schemata for maritime traffic scenarios." readme = "README.md" requires-python = ">= 3.9" diff --git a/schema/caga/input_schema.json b/schema/caga/input_schema.json index fa3d61a..f085e7f 100644 --- a/schema/caga/input_schema.json +++ b/schema/caga/input_schema.json @@ -461,7 +461,7 @@ "id": { "description": "Unique Identifier", "examples": [ - "eea9f050-6253-4d81-bc77-c3f0f198ec03" + "c8067411-76fe-421d-a60e-07b30948fdd3" ], "format": "uuid", "title": "Id", @@ -795,7 +795,7 @@ "default": null, "description": "Starting time of the situation in `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`", "examples": [ - "2024-04-04T09:29:16.243578" + "2024-04-04T15:28:16.125239" ], "title": "Starttime" }, diff --git a/schema/caga/output_schema.json b/schema/caga/output_schema.json index 1084ff6..a0fbf59 100644 --- a/schema/caga/output_schema.json +++ b/schema/caga/output_schema.json @@ -111,21 +111,21 @@ "predictions": { "position": [ { - "time": "2024-04-04T09:29:16.254298", + "time": "2024-04-04T15:28:16.141020", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.254304", + "time": "2024-04-04T15:28:16.141044", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.254308", + "time": "2024-04-04T15:28:16.141064", "value": { "latitude": 57.2343, "longitude": 10.3432 @@ -137,7 +137,7 @@ "tcpa": 1200.0 } ], - "time": "2024-04-04T09:29:16.254285" + "time": "2024-04-04T15:28:16.140981" } ] ], @@ -219,7 +219,7 @@ "turnRadius": 500.0 } ], - "time": "2024-04-04T09:29:16.254349" + "time": "2024-04-04T15:28:16.141188" } ] ], @@ -252,7 +252,7 @@ ], "description": "Date and Time of the event", "examples": [ - "2024-04-04T09:29:16.252730" + "2024-04-04T15:28:16.136594" ], "title": "Time" }, @@ -366,7 +366,7 @@ ], "description": "Date and Time of the predicted value `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`", "examples": [ - "2024-04-04T09:29:16.251573" + "2024-04-04T15:28:16.135180" ], "title": "Time" }, @@ -392,21 +392,21 @@ "predictions": { "position": [ { - "time": "2024-04-04T09:29:16.251611", + "time": "2024-04-04T15:28:16.135228", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.251618", + "time": "2024-04-04T15:28:16.135237", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.251623", + "time": "2024-04-04T15:28:16.135243", "value": { "latitude": 57.2343, "longitude": 10.3432 @@ -522,7 +522,7 @@ "id": { "description": "Unique Identifier", "examples": [ - "f253f15f-32b9-4806-87a3-a3d3a20dbb6c" + "44febc4b-3376-42d7-9573-1ddfcdea77a2" ], "format": "uuid", "title": "Id", @@ -679,21 +679,21 @@ "examples": [ [ { - "time": "2024-04-04T09:29:16.247716", + "time": "2024-04-04T15:28:16.130246", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.247731", + "time": "2024-04-04T15:28:16.130262", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.247736", + "time": "2024-04-04T15:28:16.130269", "value": { "latitude": 57.2343, "longitude": 10.3432 @@ -1093,7 +1093,7 @@ ], "description": "Date and Time of the predicted value `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`", "examples": [ - "2024-04-04T09:29:16.246802" + "2024-04-04T15:28:16.129205" ], "title": "Time" }, @@ -1129,7 +1129,7 @@ "id": { "description": "Unique Identifier", "examples": [ - "eea9f050-6253-4d81-bc77-c3f0f198ec03" + "c8067411-76fe-421d-a60e-07b30948fdd3" ], "format": "uuid", "title": "Id", @@ -1266,7 +1266,7 @@ "id": { "description": "Unique Identifier", "examples": [ - "a42539cc-659c-437f-8583-d7314c9fa571" + "8e8120b8-b87f-4fae-8632-e17f4c535c73" ], "format": "uuid", "title": "Id", @@ -1423,7 +1423,7 @@ "sog": 10.0 } ], - "time": "2024-04-04T09:29:16.256655" + "time": "2024-04-04T15:28:16.146312" }, { "ownShip": { @@ -1467,7 +1467,7 @@ "sog": 10.0 } ], - "time": "2024-04-04T09:29:16.256694" + "time": "2024-04-04T15:28:16.146397" } ] ], @@ -1508,7 +1508,7 @@ ], "description": "Date and Time of the predicted value `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`", "examples": [ - "2024-04-04T09:29:16.255666" + "2024-04-04T15:28:16.144585" ], "title": "Time" }, @@ -1546,7 +1546,7 @@ ], "description": "Date and Time of the event", "examples": [ - "2024-04-04T09:29:16.253771" + "2024-04-04T15:28:16.139551" ], "title": "Time" } @@ -1725,7 +1725,7 @@ "default": null, "description": "Starting time of the situation in `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`", "examples": [ - "2024-04-04T09:29:16.243578" + "2024-04-04T15:28:16.125239" ], "title": "Starttime" }, @@ -1959,7 +1959,7 @@ "creationTime": { "description": "Date and Time that this file was created, in `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`. This should be the simulation end time.", "examples": [ - "2024-04-04T09:29:16.257939" + "2024-04-04T15:28:16.148176" ], "format": "date-time", "title": "Creationtime", @@ -2063,7 +2063,7 @@ "turnRadius": 500.0 } ], - "time": "2024-04-04T09:29:16.258054" + "time": "2024-04-04T15:28:16.148333" } ], "timeSeriesData": [ @@ -2088,21 +2088,21 @@ "predictions": { "position": [ { - "time": "2024-04-04T09:29:16.258028", + "time": "2024-04-04T15:28:16.148295", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.258034", + "time": "2024-04-04T15:28:16.148304", "value": { "latitude": 57.2343, "longitude": 10.3432 } }, { - "time": "2024-04-04T09:29:16.258039", + "time": "2024-04-04T15:28:16.148310", "value": { "latitude": 57.2343, "longitude": 10.3432 @@ -2114,7 +2114,7 @@ "tcpa": 1200.0 } ], - "time": "2024-04-04T09:29:16.258016" + "time": "2024-04-04T15:28:16.148277" } ] } @@ -2182,7 +2182,7 @@ "sog": 10.0 } ], - "time": "2024-04-04T09:29:16.258221" + "time": "2024-04-04T15:28:16.148436" }, { "ownShip": { @@ -2226,7 +2226,7 @@ "sog": 10.0 } ], - "time": "2024-04-04T09:29:16.258254" + "time": "2024-04-04T15:28:16.148473" } ] }