R1.2.2

KSLCore/ksl.modeling.spatial/DistancesCIfc

DistancesCIfc

interface DistancesCIfc : JsonSettingsIfc<DistancesData>

A controlled interface for referencing distance models

Inheritors

Properties

abstract var distancesData: DistancesData

The data associated with the schedule

abstract val isEmpty: Boolean

Checks if there are no items on the schedule

open val isNotEmpty: Boolean

abstract val locationNames: Set<String>

The names of the locations.

abstract val locations: Set<LocationIfc>

The locations that have been added to the model.

Functions

abstract fun addDistance(distanceData: DistanceData): Pair<LocationIfc, LocationIfc>

Adds the distance data to the distances model.

open fun addDistances(distances: List<DistanceData>): Map<LocationIfc, LocationIfc>

Adds the distance data to the distances model.

abstract fun changeDistance(fromLocation: String, toLocation: String, distance: Double)

abstract fun changeDistance(fromLocation: LocationIfc, toLocation: LocationIfc, distance: Double)

Changes a distance value between the pair of locations, going from fromLocation to toLocation. The distance must be greater than or equal to 0.0. The pair must already be part of the model.

abstract fun clearDistances()

Clears all distances from the distance model

configureFromJson

open override fun configureFromJson(json: String): DistancesData

Uses the supplied JSON string to configure the distances via DistancesData

abstract fun containsName(name: String): Boolean

currentSettings

open override fun currentSettings(): DistancesData

Returns the current settings in the form of the data type that can be serialized.

abstract fun location(name: String): LocationIfc?

open override fun settingsToJson(): String

Converts the configuration settings to JSON