KSLCore/ksl.modeling.spatial/SpatialModel/AbstractLocation

AbstractLocation

abstract inner class AbstractLocation(aName: String? = null) : LocationIfc

Represents a location within this spatial model.

Parameters

aName

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

Inheritors

Constructors

AbstractLocation

constructor(aName: String? = null)

Properties

override val id: Int

override var label: String?

abstract val model: SpatialModel

open override val name: String

Functions

open fun distanceTo(location: LocationIfc): Double

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

isLocationEqualTo

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.