KSLCore/ksl.modeling.guidedpath.spec/GuidedPathNetworkData

GuidedPathNetworkData

@Serializable

data class GuidedPathNetworkData(var name: String, var links: List<LinkData>, var intersections: List<IntersectionData> = emptyList(), var stationAliases: Map<String, String> = emptyMap())(source)

A complete guide path network as data: everything needed to rebuild an equivalent network, and nothing that belongs to a running model.

Intersections need not be listed. Any intersection a link names is created implicitly with default properties, so a network of point junctions is described by its links alone. List an intersection only to give it a length, a velocity factor, or layout coordinates.

Station aliases are a flat map from alias to intersection name rather than a field on each intersection, so that adding an alias does not require rewriting an intersection record. That matters when the specification is generated by a scenario sweep.

Parameters

name

the network's name

links

the links, at least one

intersections

optional property overrides for named junctions

stationAliases

additional names by which process code may address intersections

Constructors

GuidedPathNetworkData

constructor(name: String, links: List<LinkData>, intersections: List<IntersectionData> = emptyList(), stationAliases: Map<String, String> = emptyMap())

Types

Companion

object Companion

Properties

intersections

var intersections: List<IntersectionData>

links

var links: List<LinkData>

name

var name: String

stationAliases

var stationAliases: Map<String, String>

Functions

toJson

fun toJson(): String

Renders this specification as JSON.