Initial

class trafficgen.types.Initial(*, position: Annotated[GeoPosition, FieldInfo(annotation=NoneType, required=True, description='Initial lon and lat of the ship.', examples=[GeoPosition(lon=57.2343, lat=10.3432)])] | None = None, sog: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Initial ship  (SOG) ground in knots', examples=[10.0], metadata=[Ge(ge=0)])] | None = None, cog: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Initial ship course over ground (COG) in degrees', examples=[45.0], metadata=[Ge(ge=0), Le(le=360)])] | None = None, heading: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Initial ship heading in degrees', examples=[45.2], metadata=[Ge(ge=0), Le(le=360)])] | None = None, navStatus: Annotated[AisNavStatus, FieldInfo(annotation=NoneType, required=True, description='AIS Navigational Status')] | None = None)

Bases: BaseModelConfig

Data type for initial data for a 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.
position
sog
cog
heading
nav_status

cog: Annotated[float, Field(ge=0, le=360, description='Initial ship course over ground (COG) in degrees', examples=[45.0])] | None

heading: Annotated[float, Field(ge=0, le=360, description='Initial ship heading in degrees', examples=[45.2])] | 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].

nav_status: Annotated[AisNavStatus, Field(description='AIS Navigational Status')] | None

position: Annotated[GeoPosition, Field(description='Initial lon and lat of the ship.', examples=[create_position_example()])] | None

sog: Annotated[float, Field(ge=0, description='Initial ship  (SOG) ground in knots', examples=[10.0])] | None