app/io.schiar.fridgnet.model

Package-level declarations

Types

enum AdministrativeLevel : Enum<AdministrativeLevel>

Represents the administrative level of an AdministrativeUnit, using a simplified format common in countries like the USA.

AdministrativeUnit

data class AdministrativeUnit(val name: String, val administrativeLevel: AdministrativeLevel, var cartographicBoundary: CartographicBoundary? = null, val subAdministrativeUnits: IdentitySet<AdministrativeUnit> = IdentitySet(), val images: MutableSet<Image> = mutableSetOf())

Represents an administrative unit with its properties and relationships.

AdministrativeUnitName

data class AdministrativeUnitName(val id: Long = 0, val locality: String?, val subAdminArea: String?, val adminArea: String?, val countryName: String?)

Represents the name of an administrative unit, providing flexibility for different regional structures.

BoundingBox

data class BoundingBox(val southwest: GeoLocation, val northeast: GeoLocation)

The bounding box is the delimited area of something, it could be the map the user is seeing or the square area of a region of a cartographic boundary.

CartographicBoundary

data class CartographicBoundary(val id: Long = 0, val administrativeUnitName: AdministrativeUnitName, val regions: List<Region>, val boundingBox: BoundingBox, val zIndex: Float, val administrativeLevel: AdministrativeLevel)

Represents a cartographic boundary on a map, typically the outline of an administrative unit.

GeoLocation

data class GeoLocation(val id: Long = 0, val latitude: Double, val longitude: Double)

Represents the geographic location of a point on a map using a spherical coordinate system.

Image

data class Image(val uri: String, val byteArray: ByteArray, val date: Long, val geoLocation: GeoLocation)

Represents an image used in the map screens.

Polygon

data class Polygon(val id: Long = 0, val geoLocations: List<GeoLocation>)

Represents a polygon displayed on a map.

Region

data class Region(val id: Long = 0, val polygon: Polygon, val holes: List<Polygon>, val active: Boolean = true, val boundingBox: BoundingBox, val zIndex: Float)

Represents a region on a map.

Functions

mergeToBoundingBox

fun Collection<Image>.mergeToBoundingBox(): BoundingBox?

Calculates a bounding box that encompasses the geo locations of all images in the collection.