TrafficSituation

Type: object

This is a schema that describes traffic situations for the maritime domain.

root version

Version

Type: string

maritime-schema version number
Example:

"0.2.0"

root title

Title

Type: string

The title of the traffic situation
Example:

"overtaking_18"

root description

Description

Type: string

A description of the traffic situation
Example:

"Crossing situation with 3 target vessels in the Oslo fjord"

root startTime

Start Time

Type: stringFormat: date-time

Starting time of the situation in ISO 8601 format YYYY-MM-DDThh:mm:ssZ (timezone-aware)
Example:

"2025-01-01T00:00:00Z"

root ownShip

Own Ship

Type: object

Own Ship (OS) data

root ownShip waypoints

Waypoints

Type: array

An array of Waypoint objects. Each waypoint object must have a position property. If no turn radius is provided, it will be assumed to be 0. Additional data can be added to each waypoint leg.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root ownShip waypoints Waypoint

Waypoint

Type: object

root ownShip waypoints Waypoint position

Position

Type: object

A geographical coordinate.
Example:

{
    "lat": 51.2123,
    "lon": 11.2313
}

root ownShip waypoints Waypoint position lon

Lon

Type: number

WGS-84 Longitude

Value must be greater or equal to -180 and lesser or equal to 180


Example:

10.3432

root ownShip waypoints Waypoint position lat

Lat

Type: number

WGS-84 Latitude

Value must be greater or equal to -90 and lesser or equal to 90


Example:

57.2343

Additional Properties of any type are allowed.

root ownShip waypoints Waypoint position additionalProperties
Type: object

root ownShip waypoints Waypoint turnRadius

Turn Radius

Type: number

Orthodrome turn radius in nautical miles as defined in RTZ.
Example:

0.5

root ownShip waypoints Waypoint leg

Leg

Type: object

Leg properties. Assuming the first waypoint is WP0, the items for the first leg (WP0 - WP1) should be defined in WP1.

root ownShip waypoints Waypoint leg starboardXtd

Starboard Xtd

Type: number

Starboard cross-track distance (XTD) in nautical miles as defined in RTZ.

root ownShip waypoints Waypoint leg portsideXtd

Portside Xtd

Type: number

Portside cross-track distance (XTD) in nautical miles as defined in RTZ.

root ownShip waypoints Waypoint leg sog

Sog

Type: number

Planned speed over ground in knots for this leg. If provided, leg.data.sog shall take priority over leg.sog.

root ownShip waypoints Waypoint leg data

Data

Type: object

The data field can be used to store data that is numerical and continuous. One such example is the vessel's speed over ground (SOG). Every data object can have the following 4 attributes:

value: This is the value of the data over the current leg.

interpStart: This is the distance (in nautical miles) before the leg change, where the value will start changing (via interpolation) to the new value in the next leg.

interpEnd: This is the distance (in nautical miles) after the leg change, where the value will finish changing (via interpolation) to the new value in the next leg.

interpMethod: This sets the interpolation (linear, cosine, smoothstep, etc.) that will be used to perform the interpolation.

Each additional property must conform to the following schema

root ownShip waypoints Waypoint leg data DataPoint

DataPoint

Type: object

root ownShip waypoints Waypoint leg data DataPoint value

Value

Type: number

the value of the data at the current waypoint
Example:

12.3

root ownShip waypoints Waypoint leg data DataPoint interpStart

Interp Start

Type: number

distance (in nautical miles) before the start of the next leg, to start interpolating to the next leg's value
Example:

10

root ownShip waypoints Waypoint leg data DataPoint interpEnd

Interp End

Type: number

distance (in nautical miles) after the start of the next leg, to finish interpolating to the next leg's value
Example:

10

root ownShip waypoints Waypoint leg data DataPoint interpMethod

Interp Method


Method used for interpolation

root ownShip waypoints Waypoint leg data DataPoint interpMethod anyOf InterpolationMethod

InterpolationMethod

Type: enum (of string)

Must be one of:

  • "linear"
  • "cosine"
  • "smoothstep"
  • "accelerate"
  • "decelerate"
  • "ordinal"
root ownShip waypoints Waypoint leg data DataPoint interpMethod anyOf item 1
Type: string

Additional Properties of any type are allowed.

root ownShip waypoints Waypoint leg data DataPoint additionalProperties
Type: object

Additional Properties of any type are allowed.

root ownShip waypoints Waypoint leg additionalProperties
Type: object

Additional Properties of any type are allowed.

root ownShip waypoints Waypoint additionalProperties
Type: object

root ownShip static

Static

Type: object

Static ship information which does not change during a scenario.

root ownShip static id

Id

Type: integer

Ship Identifier

Value must be greater or equal to 0 and lesser or equal to 4294967296


Example:

1

root ownShip static mmsi

Mmsi

Type: integer

Maritime Mobile Service Identity (MMSI)

Value must be greater or equal to 100000000 and lesser or equal to 999999999


Example:

123456789

root ownShip static imo

Imo

Type: integer

IMO Number

Value must be greater or equal to 1000000 and lesser or equal to 9999999


Example:

1234567

root ownShip static name

Name

Type: string

Ship name
Example:

"RMS Titanic"

root ownShip static dimensions

Dimensions

Type: object

Key ship dimensions

root ownShip static dimensions length

Length

Type: number

Length of the ship in meters. If a and b are provided, this shall be equal to A + B

Value must be strictly greater than 0


Example:

130.0

root ownShip static dimensions width

Width

Type: number

Width of the ship in meters. If c and d are provided, this shall be equal to C + D

Value must be strictly greater than 0


Example:

30.0

root ownShip static dimensions height

Height

Type: number

Height of the ship in meters

Value must be strictly greater than 0


Example:

15.0

root ownShip static dimensions draught

Draught

Type: number

Draught of the ship in meters

Value must be strictly greater than 0


Example:

15.0

root ownShip static dimensions a

A

Type: number

Distance in meters from CCRP to Bow

Value must be strictly greater than 0


Example:

80

root ownShip static dimensions b

B

Type: number

Distance in meters from CCRP to Stern

Value must be strictly greater than 0


Example:

20

root ownShip static dimensions c

C

Type: number

Distance in meters from CCRP to Port

Value must be strictly greater than 0


Example:

20

root ownShip static dimensions d

D

Type: number

Distance in meters from CCRP to Starboard

Value must be strictly greater than 0


Example:

20

Additional Properties of any type are allowed.

root ownShip static dimensions additionalProperties
Type: object

root ownShip static shipType

Ship Type


General ship type, based on AIS

root ownShip static shipType anyOf AisShipType

AisShipType

Type: enum (of string)

AIS Ship Type (not including cargo type).
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=116.

Must be one of:

  • "Not available"
  • "Wing in ground"
  • "Fishing"
  • "Towing"
  • "Towing large"
  • "Dredging or underwater operations"
  • "Diving operations"
  • "Military operations"
  • "Sailing"
  • "Pleasure craft"
  • "High speed craft"
  • "Pilot vessel"
  • "Search and rescue vessel"
  • "Tug"
  • "Port tender"
  • "Anti-pollution equipment"
  • "Law enforcement"
  • "Medical transport"
  • "Noncombatant"
  • "Passenger"
  • "Cargo"
  • "Tanker"
  • "Other"
root ownShip static shipType anyOf AisShipAndCargoType

AisShipAndCargoType

Type: enum (of string)

Ship Type.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=116.

Must be one of:

  • "Not available"
  • "Wing in ground"
  • "Wing in ground hazardous category A"
  • "Wing in ground hazardous category B"
  • "Wing in ground hazardous category C"
  • "Wing in ground hazardous category D"
  • "Fishing"
  • "Towing"
  • "Towing large"
  • "Dredging or underwater operations"
  • "Diving operations"
  • "Military operations"
  • "Sailing"
  • "Pleasure craft"
  • "High speed craft"
  • "High speed craft hazardous category A"
  • "High speed craft hazardous category B"
  • "High speed craft hazardous category C"
  • "High speed craft hazardous category D"
  • "High speed craft no information"
  • "Pilot vessel"
  • "Search and rescue vessel"
  • "Tug"
  • "Port tender"
  • "Anti-pollution equipment"
  • "Law enforcement"
  • "Medical transport"
  • "Noncombatant"
  • "Passenger"
  • "Passenger hazardous category A"
  • "Passenger hazardous category B"
  • "Passenger hazardous category C"
  • "Passenger hazardous category D"
  • "Passenger no information"
  • "Cargo"
  • "Cargo hazardous category A"
  • "Cargo hazardous category B"
  • "Cargo hazardous category C"
  • "Cargo hazardous category D"
  • "Cargo no information"
  • "Tanker"
  • "Tanker hazardous category A"
  • "Tanker hazardous category B"
  • "Tanker hazardous category C"
  • "Tanker hazardous category D"
  • "Tanker no information"
  • "Other"
  • "Other hazardous category A"
  • "Other hazardous category B"
  • "Other hazardous category C"
  • "Other hazardous category D"
  • "Other no information"
root ownShip static shipType anyOf AisShipAndCargoTypeInt

AisShipAndCargoTypeInt

Type: enum (of integer)

AIS Ship Type in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=116.

Must be one of:

  • 0
  • 20
  • 21
  • 22
  • 23
  • 24
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 40
  • 41
  • 42
  • 43
  • 44
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 99

root ownShip static stationType

Station Type


AIS station type

root ownShip static stationType anyOf AisStationType

AisStationType

Type: enum (of string)

AIS Station Type.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=138.

Must be one of:

  • "All mobiles"
  • "Class A mobile"
  • "Class B mobile"
  • "SAR airborne"
  • "Class B SO mobile"
  • "Class B CS shipborne"
  • "Inland waterways"
  • "Regional use 7"
  • "Regional use 8"
  • "Regional use 9"
  • "Base station coverage"
  • "Future use 11"
  • "Future use 12"
  • "Future use 13"
  • "Future use 14"
  • "Future use 15"
root ownShip static stationType anyOf AisStationTypeInt

AisStationTypeInt

Type: enum (of integer)

AIS Station Type in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=138.

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

root ownShip static positionFixingDevice

Position Fixing Device


AIS position fixing device

root ownShip static positionFixingDevice anyOf AisPositionFixingDevice

AisPositionFixingDevice

Type: enum (of string)

AIS Position Fixing Device.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=115.

Must be one of:

  • "Undefined"
  • "GPS"
  • "GLONASS"
  • "Combined GPS/GLONASS"
  • "LORAN-C"
  • "CHAYKA"
  • "Integrated Navigation System"
  • "Surveyed"
  • "Galileo"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Internal GNSS"
root ownShip static positionFixingDevice anyOf AisPositionFixingDeviceInt

AisPositionFixingDeviceInt

Type: enum (of integer)

AIS Position Fixing Device in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=113.

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

root ownShip static pathType

Path Type

Default: "rtz"

root ownShip static pathType anyOf PathType

PathType

Type: enum (of string)

Specifies the control-point model (e.g., RTZ, Bezier) used to define the path for the ship to follow.

Must be one of:

  • "rtz"
  • "bezier"
  • "linear"
root ownShip static pathType anyOf item 1
Type: null

root ownShip static initDelay

Init Delay

Type: number

Delay in seconds before the ship is initialized in the scenario

Value must be greater or equal to 0


Example:

15.0

root ownShip static sogMin

Sog Min

Type: number

Minimum ship speed over ground in knots

Value must be greater or equal to 0


Example:

5.0

root ownShip static sogMax

Sog Max

Type: number

Maximum ship speed over ground in knots

Value must be greater or equal to 0


Example:

15.0

Additional Properties of any type are allowed.

root ownShip static additionalProperties
Type: object

root ownShip initial

Initial

Type: object

Initial pose of the ship at the start of the scenario. If not provided, it will be initialized at the position and course of the first waypoint.

root ownShip initial position

Position

Type: object

Longitude and latitude of the ship.
Example:

{
    "lat": 57.2343,
    "lon": 10.3432
}

root ownShip waypoints Waypoint position lon

Lon

Type: number

WGS-84 Longitude

Value must be greater or equal to -180 and lesser or equal to 180


Example:

10.3432

root ownShip waypoints Waypoint position lat

Lat

Type: number

WGS-84 Latitude

Value must be greater or equal to -90 and lesser or equal to 90


Example:

57.2343

Additional Properties of any type are allowed.

root ownShip waypoints Waypoint position additionalProperties
Type: object

root ownShip initial sog

Sog

Type: number

Ship speed over ground (SOG) in knots

Value must be greater or equal to 0


Example:

10.0

root ownShip initial cog

Cog

Type: number

Ship course over ground (COG) in degrees

Value must be greater or equal to 0 and lesser or equal to 360


Example:

45.0

root ownShip initial heading

Heading

Type: number

Ship heading in degrees

Value must be greater or equal to 0 and lesser or equal to 360


Example:

45.2

root ownShip initial navStatus

Nav Status


AIS Navigational Status

root ownShip initial navStatus anyOf AisNavStatus

AisNavStatus

Type: enum (of string)

AIS Navigational Status.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=113.

Must be one of:

  • "Under way using engine"
  • "At anchor"
  • "Not under command"
  • "Restricted maneuverability"
  • "Constrained by her draught"
  • "Moored"
  • "Aground"
  • "Engaged in fishing"
  • "Under way sailing"
  • "Reserved for future amendment DG, HS, MP, C, HSC"
  • "Reserved for future amendment DG, HS, MP, A, WIG"
  • "Power-driven vessel towing astern"
  • "Power-driven vessel pushing ahead or towing alongside"
  • "Reserved for future use"
  • "AIS-SART (active)"
  • "Undefined (default)"
root ownShip initial navStatus anyOf AisNavStatusInt

AisNavStatusInt

Type: enum (of integer)

AIS Navigational Status in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=113.

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

Additional Properties of any type are allowed.

root ownShip initial additionalProperties
Type: object

Additional Properties of any type are allowed.

root ownShip additionalProperties
Type: object

root targetShips

Target Ships

Type: array

Target Ship (TGT) data

 No Additional Items

Each item of this array must be:

root targetShips TargetShip

TargetShip

Type: object

root targetShips TargetShip waypoints

Waypoints

Type: array

An array of Waypoint objects. Each waypoint object must have a position property. If no turn radius is provided, it will be assumed to be 0. Additional data can be added to each waypoint leg.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root targetShips TargetShip waypoints Waypoint

Waypoint

Type: object
Same definition as Waypoint

root targetShips TargetShip static

Static

Type: object

Static ship information which does not change during a scenario.

root ownShip static id

Id

Type: integer

Ship Identifier

Value must be greater or equal to 0 and lesser or equal to 4294967296


Example:

1

root ownShip static mmsi

Mmsi

Type: integer

Maritime Mobile Service Identity (MMSI)

Value must be greater or equal to 100000000 and lesser or equal to 999999999


Example:

123456789

root ownShip static imo

Imo

Type: integer

IMO Number

Value must be greater or equal to 1000000 and lesser or equal to 9999999


Example:

1234567

root ownShip static name

Name

Type: string

Ship name
Example:

"RMS Titanic"

root ownShip static dimensions

Dimensions

Type: object

Key ship dimensions

root ownShip static dimensions length

Length

Type: number

Length of the ship in meters. If a and b are provided, this shall be equal to A + B

Value must be strictly greater than 0


Example:

130.0

root ownShip static dimensions width

Width

Type: number

Width of the ship in meters. If c and d are provided, this shall be equal to C + D

Value must be strictly greater than 0


Example:

30.0

root ownShip static dimensions height

Height

Type: number

Height of the ship in meters

Value must be strictly greater than 0


Example:

15.0

root ownShip static dimensions draught

Draught

Type: number

Draught of the ship in meters

Value must be strictly greater than 0


Example:

15.0

root ownShip static dimensions a

A

Type: number

Distance in meters from CCRP to Bow

Value must be strictly greater than 0


Example:

80

root ownShip static dimensions b

B

Type: number

Distance in meters from CCRP to Stern

Value must be strictly greater than 0


Example:

20

root ownShip static dimensions c

C

Type: number

Distance in meters from CCRP to Port

Value must be strictly greater than 0


Example:

20

root ownShip static dimensions d

D

Type: number

Distance in meters from CCRP to Starboard

Value must be strictly greater than 0


Example:

20

Additional Properties of any type are allowed.

root ownShip static dimensions additionalProperties
Type: object

root ownShip static shipType

Ship Type


General ship type, based on AIS

root ownShip static shipType anyOf AisShipType

AisShipType

Type: enum (of string)

AIS Ship Type (not including cargo type).
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=116.

Must be one of:

  • "Not available"
  • "Wing in ground"
  • "Fishing"
  • "Towing"
  • "Towing large"
  • "Dredging or underwater operations"
  • "Diving operations"
  • "Military operations"
  • "Sailing"
  • "Pleasure craft"
  • "High speed craft"
  • "Pilot vessel"
  • "Search and rescue vessel"
  • "Tug"
  • "Port tender"
  • "Anti-pollution equipment"
  • "Law enforcement"
  • "Medical transport"
  • "Noncombatant"
  • "Passenger"
  • "Cargo"
  • "Tanker"
  • "Other"
root ownShip static shipType anyOf AisShipAndCargoType

AisShipAndCargoType

Type: enum (of string)

Ship Type.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=116.

Must be one of:

  • "Not available"
  • "Wing in ground"
  • "Wing in ground hazardous category A"
  • "Wing in ground hazardous category B"
  • "Wing in ground hazardous category C"
  • "Wing in ground hazardous category D"
  • "Fishing"
  • "Towing"
  • "Towing large"
  • "Dredging or underwater operations"
  • "Diving operations"
  • "Military operations"
  • "Sailing"
  • "Pleasure craft"
  • "High speed craft"
  • "High speed craft hazardous category A"
  • "High speed craft hazardous category B"
  • "High speed craft hazardous category C"
  • "High speed craft hazardous category D"
  • "High speed craft no information"
  • "Pilot vessel"
  • "Search and rescue vessel"
  • "Tug"
  • "Port tender"
  • "Anti-pollution equipment"
  • "Law enforcement"
  • "Medical transport"
  • "Noncombatant"
  • "Passenger"
  • "Passenger hazardous category A"
  • "Passenger hazardous category B"
  • "Passenger hazardous category C"
  • "Passenger hazardous category D"
  • "Passenger no information"
  • "Cargo"
  • "Cargo hazardous category A"
  • "Cargo hazardous category B"
  • "Cargo hazardous category C"
  • "Cargo hazardous category D"
  • "Cargo no information"
  • "Tanker"
  • "Tanker hazardous category A"
  • "Tanker hazardous category B"
  • "Tanker hazardous category C"
  • "Tanker hazardous category D"
  • "Tanker no information"
  • "Other"
  • "Other hazardous category A"
  • "Other hazardous category B"
  • "Other hazardous category C"
  • "Other hazardous category D"
  • "Other no information"
root ownShip static shipType anyOf AisShipAndCargoTypeInt

AisShipAndCargoTypeInt

Type: enum (of integer)

AIS Ship Type in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=116.

Must be one of:

  • 0
  • 20
  • 21
  • 22
  • 23
  • 24
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 40
  • 41
  • 42
  • 43
  • 44
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 99

root ownShip static stationType

Station Type


AIS station type

root ownShip static stationType anyOf AisStationType

AisStationType

Type: enum (of string)

AIS Station Type.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=138.

Must be one of:

  • "All mobiles"
  • "Class A mobile"
  • "Class B mobile"
  • "SAR airborne"
  • "Class B SO mobile"
  • "Class B CS shipborne"
  • "Inland waterways"
  • "Regional use 7"
  • "Regional use 8"
  • "Regional use 9"
  • "Base station coverage"
  • "Future use 11"
  • "Future use 12"
  • "Future use 13"
  • "Future use 14"
  • "Future use 15"
root ownShip static stationType anyOf AisStationTypeInt

AisStationTypeInt

Type: enum (of integer)

AIS Station Type in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=138.

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

root ownShip static positionFixingDevice

Position Fixing Device


AIS position fixing device

root ownShip static positionFixingDevice anyOf AisPositionFixingDevice

AisPositionFixingDevice

Type: enum (of string)

AIS Position Fixing Device.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=115.

Must be one of:

  • "Undefined"
  • "GPS"
  • "GLONASS"
  • "Combined GPS/GLONASS"
  • "LORAN-C"
  • "CHAYKA"
  • "Integrated Navigation System"
  • "Surveyed"
  • "Galileo"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Not used"
  • "Internal GNSS"
root ownShip static positionFixingDevice anyOf AisPositionFixingDeviceInt

AisPositionFixingDeviceInt

Type: enum (of integer)

AIS Position Fixing Device in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=113.

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

root ownShip static pathType

Path Type

Default: "rtz"

root ownShip static pathType anyOf PathType

PathType

Type: enum (of string)

Specifies the control-point model (e.g., RTZ, Bezier) used to define the path for the ship to follow.

Must be one of:

  • "rtz"
  • "bezier"
  • "linear"
root ownShip static pathType anyOf item 1
Type: null

root ownShip static initDelay

Init Delay

Type: number

Delay in seconds before the ship is initialized in the scenario

Value must be greater or equal to 0


Example:

15.0

root ownShip static sogMin

Sog Min

Type: number

Minimum ship speed over ground in knots

Value must be greater or equal to 0


Example:

5.0

root ownShip static sogMax

Sog Max

Type: number

Maximum ship speed over ground in knots

Value must be greater or equal to 0


Example:

15.0

Additional Properties of any type are allowed.

root ownShip static additionalProperties
Type: object

root targetShips TargetShip initial

Initial

Type: object

Initial pose of the ship at the start of the scenario. If not provided, it will be initialized at the position and course of the first waypoint.

root ownShip initial position

Position

Type: object

Longitude and latitude of the ship.
Example:

{
    "lat": 57.2343,
    "lon": 10.3432
}

root ownShip waypoints Waypoint position lon

Lon

Type: number

WGS-84 Longitude

Value must be greater or equal to -180 and lesser or equal to 180


Example:

10.3432

root ownShip waypoints Waypoint position lat

Lat

Type: number

WGS-84 Latitude

Value must be greater or equal to -90 and lesser or equal to 90


Example:

57.2343

Additional Properties of any type are allowed.

root ownShip waypoints Waypoint position additionalProperties
Type: object

root ownShip initial sog

Sog

Type: number

Ship speed over ground (SOG) in knots

Value must be greater or equal to 0


Example:

10.0

root ownShip initial cog

Cog

Type: number

Ship course over ground (COG) in degrees

Value must be greater or equal to 0 and lesser or equal to 360


Example:

45.0

root ownShip initial heading

Heading

Type: number

Ship heading in degrees

Value must be greater or equal to 0 and lesser or equal to 360


Example:

45.2

root ownShip initial navStatus

Nav Status


AIS Navigational Status

root ownShip initial navStatus anyOf AisNavStatus

AisNavStatus

Type: enum (of string)

AIS Navigational Status.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=113.

Must be one of:

  • "Under way using engine"
  • "At anchor"
  • "Not under command"
  • "Restricted maneuverability"
  • "Constrained by her draught"
  • "Moored"
  • "Aground"
  • "Engaged in fishing"
  • "Under way sailing"
  • "Reserved for future amendment DG, HS, MP, C, HSC"
  • "Reserved for future amendment DG, HS, MP, A, WIG"
  • "Power-driven vessel towing astern"
  • "Power-driven vessel pushing ahead or towing alongside"
  • "Reserved for future use"
  • "AIS-SART (active)"
  • "Undefined (default)"
root ownShip initial navStatus anyOf AisNavStatusInt

AisNavStatusInt

Type: enum (of integer)

AIS Navigational Status in Integer form.
Source: https://www.itu.int/dms_pubrec/itu-r/rec/m/R-REC-M.1371-5-201402-I!!PDF-E.pdf#page=113.

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

Additional Properties of any type are allowed.

root ownShip initial additionalProperties
Type: object

Additional Properties of any type are allowed.

root targetShips TargetShip additionalProperties
Type: object

root environment

Environment

Type: object

Environmental parameters

root environment windSpeed

Wind Speed

Type: number

The wind speed in m/s

Value must be greater or equal to 0


Example:

10.0

root environment windDirection

Wind Direction

Type: number

The direction the wind is coming from, in degrees.

Value must be greater or equal to 0 and lesser or equal to 360


Example:

180.0

root environment currentSpeed

Current Speed

Type: number

The water current speed in m/s

Value must be greater or equal to 0


Example:

1.0

root environment currentDirection

Current Direction

Type: number

The direction the water current is flowing towards, in degrees.

Value must be greater or equal to 0 and lesser or equal to 360


Example:

90.0

root environment waveSpectrum

Wave Spectrum

Type: enum (of string)

The wave spectrum

Must be one of:

  • "JONSWAP"
  • "Pierson-Moskowitz"
  • "Bretschneider"

Example:

"JONSWAP"

root environment significantWaveHeight

Significant Wave Height

Type: number

The significant wave height in meters
Example:

3.0

root environment wavePeriod

Wave Period

Type: number

The peak wave period in seconds
Example:

12.0

root environment waveDirection

Wave Direction

Type: number

The direction the waves are coming from, in degrees (meteorological convention)

Value must be greater or equal to 0 and lesser or equal to 360


Example:

270.0

root environment visibility

Visibility

Type: number

The visibility in nautical miles
Example:

5.0

root environment conditions

Conditions

Type: enum (of string)

The overall weather conditions

Must be one of:

  • "Clear"
  • "Cloudy"
  • "Foggy"
  • "Rainy"
  • "Snowy"

Example:

"Clear"

Additional Properties of any type are allowed.

root environment additionalProperties
Type: object

Additional Properties of any type are allowed.

root additionalProperties
Type: object