KSLCore/ksl.modeling.spatial/SpatialElement

SpatialElement

class SpatialElement(val modelElement: ModelElement, initLocation: LocationIfc = modelElement.spatialModel.defaultLocation, aName: String? = null, val observableComponent: ObservableComponent<SpatialElementIfc> = ObservableComponent()) : ObservableIfc<SpatialElementIfc> , SpatialElementIfc

Creates a spatial element associated with the spatial model at the location. A spatial element is something associated with a spatial model that has a location.

Constructors

constructor(modelElement: ModelElement, initLocation: LocationIfc = modelElement.spatialModel.defaultLocation, aName: String? = null, observableComponent: ObservableComponent<SpatialElementIfc> = ObservableComponent())

Properties

currentLocation

open override var currentLocation: LocationIfc

initialLocation

open override var initialLocation: LocationIfc

open override var isMoving: Boolean

open override var isTracked: Boolean

open override val modelElement: ModelElement

observableComponent

open override val observableComponent: ObservableComponent<SpatialElementIfc>

previousLocation

open override var previousLocation: LocationIfc

open override val spatialID: Int

open override val spatialModel: SpatialModel

open override val spatialName: String

open override var status: SpatialModel.Status

Functions

open override fun attachObserver(observer: ObserverIfc<SpatialElementIfc>)

Allows the adding (attaching) of an observer to the observable

open override fun countObservers(): Int

Returns how many observers are currently attached to the observable

detachAllObservers

open override fun detachAllObservers()

Detaches all the observers from the observable

open override fun detachObserver(observer: ObserverIfc<SpatialElementIfc>)

Allows the deletion (removing) of an observer from the observable

open fun distanceTo(location: LocationIfc): Double

open fun distanceTo(element: SpatialElementIfc): Double

initializeSpatialElement

open override fun initializeSpatialElement()

open override fun isAttached(observer: ObserverIfc<SpatialElementIfc>): Boolean

Returns true if the observer is already attached

isLocationEqualTo

open fun isLocationEqualTo(location: LocationIfc): Boolean

open fun isLocationEqualTo(element: SpatialElementIfc): Boolean