OwnShip

class trafficgen.types.OwnShip(*, initial: ~typing.Annotated[~trafficgen.types.Initial, FieldInfo(annotation=NoneType, required=True, description='Initial pose of the ship. If `waypoints` are provided,then these should correspond to the pose of the ship at the starting waypoint', examples=[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'>)])] | None = None, waypoints: ~typing.Annotated[list[~trafficgen.types.Waypoint], FieldInfo(annotation=NoneType, required=True, description='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.', examples=[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, static: ~trafficgen.types.ShipStatic)

Bases: Ship

Data type for the own ship.

__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.
static
initial
waypoints

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].

static: Annotated[ShipStatic, Field(description=static_description, examples=[create_ship_static_example()])]