Dimensions

class trafficgen.types.Dimensions(*, length: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Length of the ship in meters', examples=[130.0], metadata=[Gt(gt=0)])] | None = None, width: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Width of the ship in meters', examples=[30.0], metadata=[Gt(gt=0)])] | None = None, height: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Height of the ship in meters', examples=[15.0], metadata=[Gt(gt=0)])] | None = None, draught: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Draught of the ship in meters', examples=[15.0], metadata=[Gt(gt=0)])] | None = None, a: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Distance in meters from CCRP to Bow', examples=[80], metadata=[Gt(gt=0)])] | None = None, b: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Distance in meters from CCRP to Stern', examples=[20], metadata=[Gt(gt=0)])] | None = None, c: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Distance in meters from CCRP to Port', examples=[20], metadata=[Gt(gt=0)])] | None = None, d: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Distance in meters from CCRP to Starboard', examples=[20], metadata=[Gt(gt=0)])] | None = None)

Bases: BaseModelConfig

Key Ship Dimensions.

              Bow
              (a)
               ^
              /┆\
             / ┆ \
            /  ┆  \
           /   ┆   \
          /    ┆    \
         │     ┆     │
         │     ┆     │
         │     ┆     │
         │     ┆     │
Port (c) │╌╌╌╌╌♦╌╌╌╌╌│ (d) Starboard
         │     ┆     │
         │     ┆     │
         │     ┆     │
         └─────┴─────┘
              (b)
             Stern

            ♦ = CCRP

__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.
length
width
height
draught
a
b
c
d

a: Annotated[float, Field(gt=0, description='Distance in meters from CCRP to Bow', examples=[80])] | None

b: Annotated[float, Field(gt=0, description='Distance in meters from CCRP to Stern', examples=[20])] | None

c: Annotated[float, Field(gt=0, description='Distance in meters from CCRP to Port', examples=[20])] | None

d: Annotated[float, Field(gt=0, description='Distance in meters from CCRP to Starboard', examples=[20])] | None

draught: Annotated[float, Field(gt=0, description='Draught of the ship in meters', examples=[15.0])] | None

height: Annotated[float, Field(gt=0, description='Height of the ship in meters', examples=[15.0])] | None

length: Annotated[float, Field(gt=0, description='Length of the ship in meters', examples=[130.0])] | 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].

width: Annotated[float, Field(gt=0, description='Width of the ship in meters', examples=[30.0])] | None