core: introduce a switch initialization policy

This initialization policy replaces the default switch configuration: - switches do not all have a default configuration - we may need to make pessimistic or optimistic assumptions, depending on the context
OpenRailAssociation · Nov 29, 2022 · 65200f6 · 65200f6
1 parent a9f8a00
commit 65200f6
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 27 deletions.
diff --git a/core/kt-osrd-sim-infra/src/main/kotlin/fr/sncf/osrd/sim_infra/api/SimInfra.kt b/core/kt-osrd-sim-infra/src/main/kotlin/fr/sncf/osrd/sim_infra/api/SimInfra.kt
@@ -22,7 +22,6 @@ interface MovableElementsInfra {
     val movableElements: StaticIdxSpace<MovableElement>
     fun getMovableElementConfigs(movableElement: MovableElementId): StaticIdxSpace<MovableElementConfig>
     fun getMovableElementDelay(movableElement: MovableElementId): Duration
-    fun getMovableElementDefaultConfig(movableElement: MovableElementId): MovableElementConfigId
     fun getMovableElementConfigName(movableElement: MovableElementId, config: MovableElementConfigId): String
 }
 

diff --git a/core/kt-osrd-sim-infra/src/main/kotlin/fr/sncf/osrd/sim_infra/impl/SimInfraBuilder.kt b/core/kt-osrd-sim-infra/src/main/kotlin/fr/sncf/osrd/sim_infra/impl/SimInfraBuilder.kt
@@ -8,16 +8,13 @@ import kotlin.time.Duration
 class MovableElementDescriptorBuilder @PublishedApi internal constructor (
     private val delay: Duration,
     private val configs: StaticPool<MovableElementConfig, MovableElementConfigDescriptor>,
-    var defaultConfig: MovableElementConfigId?
 ) {
     fun config(name: String): MovableElementConfigId {
         return configs.add(MovableElementConfigDescriptor(name))
     }
 
     @PublishedApi internal fun build(): MovableElementDescriptor {
-        if (defaultConfig == null)
-            throw RuntimeException("invalid MovableElement: there must be a default config")
-        return MovableElementDescriptor(delay, configs, defaultConfig!!)
+        return MovableElementDescriptor(delay, configs)
     }
 }
 
@@ -43,7 +40,7 @@ class SimInfraBuilder @PublishedApi internal constructor(
     )
 
     inline fun movableElement(delay: Duration, init: MovableElementDescriptorBuilder.() -> Unit): MovableElementId {
-        val movableElementBuilder = MovableElementDescriptorBuilder(delay, StaticPool(), null)
+        val movableElementBuilder = MovableElementDescriptorBuilder(delay, StaticPool())
         movableElementBuilder.init()
         val movableElement = movableElementBuilder.build()
         return movableElementPool.add(movableElement)

diff --git a/core/kt-osrd-sim-infra/src/main/kotlin/fr/sncf/osrd/sim_infra/impl/SimInfraImpl.kt b/core/kt-osrd-sim-infra/src/main/kotlin/fr/sncf/osrd/sim_infra/impl/SimInfraImpl.kt
@@ -11,7 +11,6 @@ value class MovableElementConfigDescriptor(val name: String)
 class MovableElementDescriptor(
     val delay: Duration,
     val configs: StaticPool<MovableElementConfig, MovableElementConfigDescriptor>,
-    val defaultConfig: StaticIdx<MovableElementConfig>
 )
 
 @JvmInline
@@ -66,10 +65,6 @@ class SimInfraImpl(
         return movableElementPool[movableElement].delay
     }
 
-    override fun getMovableElementDefaultConfig(movableElement: MovableElementId): MovableElementConfigId {
-        return movableElementPool[movableElement].defaultConfig
-    }
-
     override fun getMovableElementConfigName(
         movableElement: MovableElementId,
         config: MovableElementConfigId

diff --git a/core/kt-osrd-sim/src/main/kotlin/fr/sncf/osrd/sim/api/Sim.kt b/core/kt-osrd-sim/src/main/kotlin/fr/sncf/osrd/sim/api/Sim.kt
@@ -9,8 +9,14 @@ import kotlin.contracts.contract
 
 // region MOVABLE ELEMENTS
 
+/** Defines how movable elements are initialized */
+enum class MovableElementInitPolicy {
+    OPTIMISTIC,
+    PESSIMISTIC,
+}
+
 interface MovableElementSim {
-    fun watchMovableElement(movable: MovableElementId): StateFlow<MovableElementConfigId>
+    fun watchMovableElement(movable: MovableElementId): StateFlow<MovableElementConfigId?>
     suspend fun move(movable: MovableElementId, config: MovableElementConfigId)
     suspend fun lockMovableElement(movable: MovableElementId)
     suspend fun unlockMovableElement(movable: MovableElementId)

diff --git a/core/kt-osrd-sim/src/main/kotlin/fr/sncf/osrd/sim/impl/MovableElements.kt b/core/kt-osrd-sim/src/main/kotlin/fr/sncf/osrd/sim/impl/MovableElements.kt
@@ -1,5 +1,6 @@
 package fr.sncf.osrd.sim.impl
 
+import fr.sncf.osrd.sim.api.MovableElementInitPolicy
 import fr.sncf.osrd.sim_infra.api.*
 import fr.sncf.osrd.sim.api.MovableElementSim
 import fr.sncf.osrd.utils.indexing.get
@@ -10,18 +11,21 @@ import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.sync.Mutex
 
 
-fun movableElementSim(infra: MovableElementsInfra): MovableElementSim {
-    return MovableElementSimImpl(infra)
+fun movableElementSim(infra: MovableElementsInfra, initPolicy: MovableElementInitPolicy): MovableElementSim {
+    return MovableElementSimImpl(infra, initPolicy)
 }
 
-internal class MovableElementSimImpl(private val infra: MovableElementsInfra) : MovableElementSim {
-    private val states = infra.movableElements.map { id ->
-        MutableStateFlow(infra.getMovableElementDefaultConfig(id))
+internal class MovableElementSimImpl(
+    private val infra: MovableElementsInfra,
+    private val initPolicy: MovableElementInitPolicy,
+) : MovableElementSim {
+    private val states: List<MutableStateFlow<MovableElementConfigId?>> = infra.movableElements.map { id ->
+        MutableStateFlow(null)
     }
 
     private val locks = infra.movableElements.map { Mutex() }
 
-    override fun watchMovableElement(movable: MovableElementId): StateFlow<MovableElementConfigId> {
+    override fun watchMovableElement(movable: MovableElementId): StateFlow<MovableElementConfigId?> {
         return states[movable.index]
     }
 
@@ -32,7 +36,10 @@ internal class MovableElementSimImpl(private val infra: MovableElementsInfra) :
     override suspend fun move(movable: MovableElementId, config: MovableElementConfigId) {
         assert(locks[movable.index].isLocked) { "cannot move a non-locked movable element" }
         states[movable.index].update { prevConfig ->
-            if (prevConfig != config)
+            if (prevConfig == null) {
+                if (initPolicy == MovableElementInitPolicy.PESSIMISTIC)
+                    delay(infra.getMovableElementDelay(movable))
+            } else if (prevConfig != config)
                 delay(infra.getMovableElementDelay(movable))
             config
         }

diff --git a/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestLocation.kt b/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestLocation.kt
@@ -19,8 +19,8 @@ class TestLocation {
         // setup test data
         val infra = simInfra {
             // create a test switch
-            val switchA = movableElement(delay = 42L.milliseconds) {
-                defaultConfig = config("a")
+            val switchA = movableElement(delay = 42L.milliseconds, MovableElementInitPolicy.OPTIMISTIC) {
+                config("a")
                 config("b")
             }
 

diff --git a/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestMovableElement.kt b/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestMovableElement.kt
@@ -2,6 +2,7 @@ package fr.sncf.osrd.sim
 
 import fr.sncf.osrd.sim.impl.MovableElementSimImpl
 import fr.sncf.osrd.sim.api.withLock
+import fr.sncf.osrd.sim_infra.api.MovableElementInitPolicy
 import fr.sncf.osrd.sim_infra.impl.simInfra
 import kotlinx.coroutines.async
 import kotlinx.coroutines.delay
@@ -16,8 +17,8 @@ class TestMovableElements {
     fun lockMoveTest() = runTest {
         // setup test data
         val infra = simInfra {
-            movableElement(delay = 42L.milliseconds) {
-                defaultConfig = config("a")
+            movableElement(delay = 42L.milliseconds, MovableElementInitPolicy.OPTIMISTIC) {
+                config("a")
                 config("b")
             }
         }

diff --git a/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestReservation.kt b/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestReservation.kt
@@ -5,6 +5,7 @@ import fr.sncf.osrd.sim.api.ZoneReservation
 import fr.sncf.osrd.sim.api.ZoneReservationStatus.*
 import fr.sncf.osrd.sim.api.ZoneState
 import fr.sncf.osrd.sim.impl.*
+import fr.sncf.osrd.sim_infra.api.MovableElementInitPolicy
 import fr.sncf.osrd.sim_infra.api.ZonePath
 import fr.sncf.osrd.sim_infra.api.normal
 import fr.sncf.osrd.sim_infra.api.reverse
@@ -38,8 +39,8 @@ class TestReservation {
 
         // region build the test infrastructure
         val builder = SimInfraBuilder()
-        val switch = builder.movableElement(delay = 42L.milliseconds) {
-            defaultConfig = config("a")
+        val switch = builder.movableElement(delay = 42L.milliseconds, MovableElementInitPolicy.OPTIMISTIC) {
+            config("a")
             config("b")
         }
 

diff --git a/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestRouting.kt b/core/kt-osrd-sim/src/test/kotlin/fr/sncf/osrd/sim/TestRouting.kt
@@ -2,6 +2,7 @@ package fr.sncf.osrd.sim
 
 import fr.sncf.osrd.sim.api.Train
 import fr.sncf.osrd.sim.impl.*
+import fr.sncf.osrd.sim_infra.api.MovableElementInitPolicy
 import fr.sncf.osrd.sim_infra.api.ZonePath
 import fr.sncf.osrd.sim_infra.api.normal
 import fr.sncf.osrd.sim_infra.api.reverse
@@ -38,8 +39,8 @@ class TestRouting {
         // region build the test infrastructure
         val builder = SimInfraBuilder()
         // region switches
-        val switch = builder.movableElement(delay = 10L.milliseconds) {
-            defaultConfig = config("xy")
+        val switch = builder.movableElement(delay = 10L.milliseconds, MovableElementInitPolicy.OPTIMISTIC) {
+            config("xy")
             config("vy")
         }