ShipStatic

class trafficgen.types.ShipStatic(*, id: Annotated[int, Ge(ge=0), Le(le=4294967296)], mmsi: Annotated[int, FieldInfo(annotation=NoneType, required=True, description='Maritime Mobile Service Identity (MMSI)', examples=[123456789], metadata=[Ge(ge=100000000), Le(le=999999999)])] | None = None, imo: Annotated[int, FieldInfo(annotation=NoneType, required=True, description='IMO Number', examples=[1234567], metadata=[Ge(ge=1000000), Le(le=9999999)])] | None = None, name: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Ship name', examples=['RMS Titanic'])] | None = None, dimensions: Annotated[Dimensions, FieldInfo(annotation=NoneType, required=True, description='Key ship dimensions')] | None = None, shipType: Annotated[AisShipType, FieldInfo(annotation=NoneType, required=True, description='General ship type, based on AIS')] | None = None, pathType: Annotated[PathType, FieldInfo(annotation=NoneType, required=True, description='Specifies the control-point model (e.g., Bezier, RTZ) used to define the path for the ship to follow.')] | None = PathType.RTZ, sogMin: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Minimum ship speed over ground in knots', examples=[5.0], metadata=[Ge(ge=0)])] | None = None, sogMax: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Maximum ship speed over ground in knots', examples=[15.0], metadata=[Ge(ge=0)])] | None = None, **extra_data: Any)

Bases: BaseModelConfig

Static ship data that will not change during the scenario.

__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.
coerce_id_to_int(value)	Ensure ship id is converted to int when imported from JSON.
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.
id
mmsi
imo
name
dimensions
ship_type
path_type
sog_min
sog_max

classmethod coerce_id_to_int(value: Any) → int

Ensure ship id is converted to int when imported from JSON.

dimensions: Annotated[Dimensions, Field(description='Key ship dimensions')] | None

id: Annotated[int, Field(ge=0, le=2 ** 32, description='Ship Identifier', examples=[1])]

imo: Annotated[int, Field(ge=1000000, le=9999999, description='IMO Number', examples=[1234567])] | None

mmsi: Annotated[int, Field(ge=100000000, le=999999999, description='Maritime Mobile Service Identity (MMSI)', examples=[123456789])] | None

model_config = {'alias_generator': <function to_camel>, 'extra': 'allow', '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].

name: Annotated[str, Field(description='Ship name', examples=['RMS Titanic'])] | None

path_type: Annotated[PathType, Field(description='Specifies the control-point model (e.g., Bezier, RTZ) used to define the path for the ship to follow.')] | None

ship_type: Annotated[AisShipType, Field(description='General ship type, based on AIS')] | None

sog_max: Annotated[float, Field(ge=0, description='Maximum ship speed over ground in knots', examples=[15.0])] | None

sog_min: Annotated[float, Field(ge=0, description='Minimum ship speed over ground in knots', examples=[5.0])] | None