Files
satellite-provider/_docs/02_document/modules/common_dtos.md
T
Oleksandr Bezdieniezhnykh 7c37636fdf [AZ-373] Refactor C20: drop MapsVersion from new writes (option a)
- Stop writing "downloaded_YYYY-MM-DD" into tiles.maps_version: new rows
  bind @MapsVersion to NULL via TileService.BuildTileEntity.
- Retain the tiles.maps_version column (coderule.mdc forbids unprompted
  column drops); pre-existing rows keep their values for forensics.
- Remove MapsVersion property from DownloadTileResponse (API wire shape)
  and TileMetadata (internal DTO); OpenAPI schema regenerates from the
  DTO via Swashbuckle.
- Add 3 AC tests in TileServiceTests covering the captured-entity write
  (AC-1) and the DTO/wire-shape removal (AC-2).
- Update integration-test local DTO + console output; refresh docs in
  common_dtos.md, services_tile_service.md, data_model.md.
- Archive AZ-373 task file: todo/ -> done/.

174 unit + 5 smoke pass.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-11 04:05:40 +03:00

3.6 KiB
Raw Blame History

Module: Common/DTO

Purpose

Data transfer objects used across all layers — API requests/responses, inter-service communication, and queue messages.

Public Interface

GeoPoint

Geographic coordinate with tolerance-based equality.

  • Lat (double): latitude, JSON property "lat"
  • Lon (double): longitude, JSON property "lon"
  • Constructor: GeoPoint(), GeoPoint(double lat, double lon)
  • Equality: two points are equal if both coordinates differ by less than 0.00005 (PRECISION_TOLERANCE)
  • Operator overloads: ==, !=

Direction

Result of a directional calculation between two points.

  • Distance (double): distance in meters
  • Azimuth (double): bearing in degrees (0360)

SatTile

Represents a single map tile with its spatial bounds.

  • X, Y (int): tile coordinates in the slippy map scheme
  • Zoom (int): zoom level
  • LeftTop, BottomRight (GeoPoint): computed bounding box corners (via GeoUtils.TileToWorldPos)
  • Url (string): download URL
  • FileName → string: formatted as {X}.{Y}.{Zoom}.jpg

TileMetadata

Metadata about a stored tile (mirrors TileEntity but without DB-specific concerns).

  • Id (Guid), TileZoom, TileX, TileY (int), Latitude, Longitude (double)
  • TileSizeMeters (double), TileSizePixels (int), ImageType (string)
  • Version (int?), FilePath (string)
  • CreatedAt, UpdatedAt (DateTime)

RegionRequest

Queue message for async region processing.

  • Id (Guid), Latitude, Longitude (double), SizeMeters (double)
  • ZoomLevel (int), StitchTiles (bool)

RegionStatus

Response DTO for region status queries.

  • Id (Guid), Status (string), CsvFilePath, SummaryFilePath (string?)
  • TilesDownloaded, TilesReused (int), CreatedAt, UpdatedAt (DateTime)

RoutePoint

Input point in a route creation request.

  • Latitude (double, JSON: "lat"), Longitude (double, JSON: "lon")

RoutePointDto

Output point in a route response (includes computed fields).

  • Latitude, Longitude (double), PointType (string: "start"/"end"/"action"/"intermediate")
  • SequenceNumber, SegmentIndex (int), DistanceFromPrevious (double?)

CreateRouteRequest

API request body for route creation.

  • Id (Guid), Name (string), Description (string?)
  • RegionSizeMeters (double), ZoomLevel (int)
  • Points (List<RoutePoint>), Geofences (Geofences?)
  • RequestMaps (bool), CreateTilesZip (bool)

RouteResponse

API response for route queries.

  • All fields from the route entity plus Points (List<RoutePointDto>)
  • MapsReady (bool), TilesZipPath (string?)

GeofencePolygon

Axis-aligned bounding box defined by NW and SE corners.

  • NorthWest (GeoPoint?), SouthEast (GeoPoint?)

Geofences

Container for multiple geofence polygons.

  • Polygons (List<GeofencePolygon>)

Internal Logic

  • GeoPoint uses a precision tolerance of 0.00005 degrees (~5.5 meters) for equality comparison.
  • SatTile eagerly computes its bounding box corners on construction by calling GeoUtils.TileToWorldPos.

Dependencies

  • GeoPoint, Direction — no imports
  • SatTileSatelliteProvider.Common.Utils.GeoUtils
  • All others — no internal dependencies (or only System.Text.Json.Serialization)

Consumers

  • All services, repositories, and API endpoints consume these DTOs
  • RegionRequest is the message type for IRegionRequestQueue

Data Models

These ARE the data models (DTOs). They map closely to the database entities but are decoupled from the persistence layer.

Configuration

None consumed directly.

External Integrations

None.

Security

None.

Tests

No dedicated DTO tests.