trafficgen.types

Domain specific data types used in trafficgen.

Functions

create_data_point_example()

Create a DataPoint class.

create_initial_example()

Create a (Ship) Initial class.

create_own_ship_example()

Create a OwnShip class.

create_position_example()

Create a position class.

create_ship_example()

Create a Ship class.

create_ship_static_example()

Create a ShipStatic class.

create_target_example()

Create a TargetShip class.

create_waypoint_example()

Create a Waypoint class.

to_camel(string)

Return a camel case formated string from snake case string.

Classes

AisNavStatus(*values)

AIS Navigational Status.

AisShipType(*values)

AIS Ship Type (not including cargo type).

BaseModelConfig()

Enables the alias_generator for all cases.

DataPoint(*[, value, interpStart, ...])

Data type for storing data which is numerical and continuos.

Dimensions(*[, length, width, height, ...])

Key Ship Dimensions.

Encounter(*, desiredEncounterType[, beta, ...])

Data type for an encounter.

EncounterClassification(*, theta13Criteria, ...)

Data type for the encounter classification.

EncounterRelativeSpeed(*, overtakingStandOn, ...)

Data type for relative speed between two ships in an encounter.

EncounterSettings(*, classification, ...)

Data type for encounter settings.

EncounterType(*values)

Enumeration of encounter types.

GeoPosition(*, lon, lat, **extra_data)

Data type for a geographical position.

Initial(*[, position, sog, cog, heading, ...])

Data type for initial data for a ship .

InterpolationMethod(*values)

Specifies the interpolation method used to interpolate between two values.

Leg(*[, starboardXtd, portsideXtd, sog, data])

Data type for a leg.

OwnShip(*, initial, FieldInfo[, sog, cog, ...])

Data type for the own ship.

OwnShipInitial(*, initial[, waypoints])

Data type for initial data for the own ship used for generating a situation.

PathType(*values)

Specifies the control-point model used to define the path for the ship to follow.

Position(*, x, y)

Data type for ship position.

RouteData(*[, sog])

Data type for data along a route.

Ship(*, initial, FieldInfo[, sog, cog, ...])

Data type for a ship.

ShipStatic(*, id[, mmsi, imo, name, ...])

Static ship data that will not change during the scenario.

SituationInput(*, title, description[, ...])

Data type for inputs needed for generating a situations.

SituationInputJson(*, trafficSituations, ...)

Data type for generating traffic situations from JSON payloads.

StringIntEnumMixin(new_class_name, /, names, *)

A mixin class for Enums that allows both integers and strings to specify a type.

TargetShip(*, initial, FieldInfo[, sog, ...])

Data type for the target ship.

TrafficSituation(*, trafficgenVersion, ...)

Data type for a traffic situation.

Waypoint(*, position[, turnRadius, leg])

Data type for a waypoint.
trafficgen.types.create_data_point_example() → DataPoint

Create a DataPoint class.

trafficgen.types.create_initial_example() → Initial

Create a (Ship) Initial class.

trafficgen.types.create_own_ship_example() → OwnShip

Create a OwnShip class.

trafficgen.types.create_position_example() → GeoPosition

Create a position class.

trafficgen.types.create_ship_example() → Ship

Create a Ship class.

trafficgen.types.create_ship_static_example() → ShipStatic

Create a ShipStatic class.

trafficgen.types.create_target_example() → TargetShip

Create a TargetShip class.

trafficgen.types.create_waypoint_example() → Waypoint

Create a Waypoint class.

trafficgen.types.to_camel(string: str) → str

Return a camel case formated string from snake case string.