KSLCore/ksl.modeling.spatial/RectangularGridSpatialModel2D/GridPoint

GridPoint

inner class GridPoint(val x: Double, val y: Double, aName: String? = null) : SpatialModel.AbstractLocation

Represents a location within this spatial model.

Parameters

aName

the name of the location, will be assigned based on ID_id if null

Constructors

Link copied to clipboard
constructor(x: Double, y: Double, aName: String? = null)

Properties

Link copied to clipboard
override val id: Int
Link copied to clipboard
override var label: String?
Link copied to clipboard
open override val name: String
Link copied to clipboard
open override val spatialModel: SpatialModel
Link copied to clipboard
val x: Double
Link copied to clipboard
val y: Double

Functions

Link copied to clipboard
open fun distanceTo(location: LocationIfc): Double

Computes the distance between the current location and location based on the spatial model's distance metric

Link copied to clipboard
open fun isLocationEqualTo(location: LocationIfc): Boolean

Returns true if location is the same as this location within the underlying spatial model. This is not object reference equality, but rather whether the locations within the underlying spatial model can be considered spatially (equivalent) according to the model.

Link copied to clipboard
open override fun toString(): String