TrafficSituation

class trafficgen.types.TrafficSituation(*, trafficgenVersion: str, schemaVersion: str, title: ~typing.Annotated[str, FieldInfo(annotation=NoneType, required=True, description='The title of the traffic situation', examples=['overtaking_18'])] | None = None, description: ~typing.Annotated[str, FieldInfo(annotation=NoneType, required=True, description='A description of the traffic situation', examples=['Crossing situation with 3 target vessels in the Oslo fjord'])] | None = None, startTime: ~typing.Annotated[~datetime.datetime, FieldInfo(annotation=NoneType, required=True, description='Starting time of the situation in `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`', examples=[datetime.datetime(2025, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)])] | None = None, ownShip: ~trafficgen.types.OwnShip, targetShips: ~typing.Annotated[list[~trafficgen.types.TargetShip], FieldInfo(annotation=NoneType, required=True, description='Target Ship (TGT) data', examples=[[Ship(initial=Initial(position=GeoPosition(lon=57.2343, lat=10.3432), sog=12.3, cog=284.2, heading=283.1, nav_status=<AisNavStatus.UNDER_WAY_USING_ENGINE: 'Under way using engine'>), waypoints=[Waypoint(position=GeoPosition(lon=57.2343, lat=10.3432), turn_radius=1.0, leg=Leg(starboard_xtd=None, portside_xtd=None, sog=None, data=RouteData(sog=DataPoint(value=12.3, interp_start=100.0, interp_end=100.0, interp_method=<InterpolationMethod.LINEAR: 'linear'>))))])]])] | None = None)

Bases: BaseModelConfig

Data type for a traffic situation.

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	!!! abstract "Usage Documentation"
model_dump(*[, mode, include, exclude, ...])	!!! abstract "Usage Documentation"
model_dump_json(*[, indent, ensure_ascii, ...])	!!! abstract "Usage Documentation"
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, extra, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	!!! abstract "Usage Documentation"
model_validate_strings(obj, *[, strict, ...])	Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
update_forward_refs(**localns)
validate(value)

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
trafficgen_version
schema_version
title
description
start_time
own_ship
target_ships

description: Annotated[str, Field(description='A description of the traffic situation', examples=['Crossing situation with 3 target vessels in the Oslo fjord'])] | None

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

own_ship: Annotated[OwnShip, Field(description='Own Ship (OS) data', examples=[create_ship_example()])]

schema_version: Annotated[str, Field(description='Maritime-schema version number', examples=['0.2.0'])]

start_time: Annotated[datetime.datetime, Field(description='Starting time of the situation in `ISO 8601` format `YYYY-MM-DDThh:mm:ssZ`', examples=[datetime.datetime(2025, 1, 1, 0, 0, 0, tzinfo=datetime.UTC)])] | None

target_ships: Annotated[list[TargetShip], Field(description='Target Ship (TGT) data', examples=[[create_ship_example()]])] | None

title: Annotated[str, Field(description='The title of the traffic situation', examples=['overtaking_18'])] | None

trafficgen_version: Annotated[str, Field(description='Ship traffic generator version number', examples=[project_version])]