More informative toString in model states

Author: altavir

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/DeviceConstructor.kt

@@ -126,17 +126,16 @@ public fun <T : Any> DeviceConstructor.mutableProperty(
 )
 
 /**
- * Create and register a virtual mutable property with optional [callback]
+ * Create and register a virtual mutable property
  */
 public fun <T> DeviceConstructor.virtualProperty(
     metaConverter: MetaConverter<T>,
     initialState: T,
     descriptorBuilder: PropertyDescriptor.() -> Unit = {},
     nameOverride: String? = null,
-    callback: (T) -> Unit = {},
 ): PropertyDelegateProvider<DeviceConstructor, ReadOnlyProperty<DeviceConstructor, MutableDeviceState<T>>> = property(
     metaConverter,
-    MutableDeviceState(initialState, callback),
+    MutableDeviceState(initialState),
     descriptorBuilder,
     nameOverride,
 )

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/DeviceGroup.kt

@@ -315,9 +315,8 @@ public fun <T : Any> DeviceGroup.registerVirtualProperty(
     initialValue: T,
     converter: MetaConverter<T>,
     descriptorBuilder: PropertyDescriptor.() -> Unit = {},
-    callback: (T) -> Unit = {},
 ): MutableDeviceState<T> {
-    val state = MutableDeviceState<T>(initialValue, callback)
+    val state = MutableDeviceState<T>(initialValue)
     registerMutableProperty(name, converter, state, descriptorBuilder)
     return state
 }

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/DeviceState.kt

@@ -80,7 +80,7 @@ public fun <T, R> DeviceState.Companion.map(
 
     override fun subscribe(): Flow<R> = state.subscribe().map(mapper)
 
-    override fun toString(): String = "DeviceState.map(state=${state}, mapper=$mapper)"
+    override fun toString(): String = "DeviceState.map(state=${state.value}, value=$value)"
 }
 
 public fun <T, R> DeviceState<T>.map(mapper: (T) -> R): DeviceStateWithDependencies<R> =
@@ -105,7 +105,7 @@ public fun <T, R> DeviceState.Companion.map(
 
     override fun subscribe(): StateFlow<R> = valueFlow
 
-    override fun toString(): String = "DeviceState.map(state=${state}, mapper=$mapper)"
+    override fun toString(): String = "DeviceState.map(state=${state.value}, value=$value)"
 }
 
 public fun <T, R> DeviceState<T>.map(scope: CoroutineScope, mapper: (T) -> R): DeviceStateWithDependencies<R> =
@@ -136,7 +136,7 @@ public fun <T, R> DeviceState.Companion.transform(
 
     override fun subscribe(): StateFlow<R> = valueFlow
 
-    override fun toString(): String = "DeviceState.transform(state=${state}, transform=$transform)"
+    override fun toString(): String = "DeviceState.transform(state=${state.value}, value=$value)"
 }
 
 public suspend fun <T, R> DeviceState<T>.transform(
@@ -167,7 +167,8 @@ public fun <T1, T2, R> DeviceState.Companion.combine(
 
     override fun subscribe(): StateFlow<R> = valueFlow
 
-    override fun toString(): String = "DeviceState.combine(state1=$state1, state2=$state2)"
+    override fun toString(): String =
+        "DeviceState.combine(state1=${state1.value}, state2=${state2.value}, value=$value)"
 }
 
 /**
@@ -195,7 +196,8 @@ public fun <T1, T2, T3, R> DeviceState.Companion.combine(
 
     override fun subscribe(): SharedFlow<R> = valueFlow
 
-    override fun toString(): String = "DeviceState.combine(state1=$state1, state2=$state2, state3=$state3)"
+    override fun toString(): String =
+        "DeviceState.combine(state1=${state1.value}, state2=${state2.value}, state3=${state3.value}, value=$value)"
 }
 
 public fun <T1, T2, T3, T4, R> DeviceState.Companion.combine(
@@ -221,7 +223,7 @@ public fun <T1, T2, T3, T4, R> DeviceState.Companion.combine(
     override fun subscribe(): StateFlow<R> = valueFlow
 
     override fun toString(): String =
-        "DeviceState.combine(state1=$state1, state2=$state2, state3=$state3, state4=$state4)"
+        "DeviceState.combine(state1=${state1.value}, state2=${state2.value}, state3=${state3.value}, state4=${state4.value}, value=$value)"
 }
 
 /**
@@ -250,7 +252,14 @@ public fun <T, R> DeviceState.Companion.combine(
 
     override fun subscribe(): StateFlow<R> = valueFlow
 
-    override fun toString(): String = "DeviceState.combine(states=${states.joinToString()})"
+    override fun toString(): String =
+        "DeviceState.combine(states=${
+            states.joinToString(
+                prefix = "[",
+                separator = ", ",
+                postfix = "]"
+            ) { "${it.value}" }
+        }, value=$value)"
 }
 
 /**
@@ -285,7 +294,14 @@ public fun <T, K, R> DeviceState.Companion.combine(
 
     override fun subscribe(): StateFlow<R> = valueFlow
 
-    override fun toString(): String = "DeviceState.associate(states=${states})"
+    override fun toString(): String =
+        "DeviceState.associate(states=${
+            states.entries.joinToString(
+                prefix = "[",
+                separator = ", ",
+                postfix = "]"
+            ) { "${it.key}=${it.value.value}" }
+        }, value=$value)"
 }
 
 /**

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/ExternalDeviceState.kt

@@ -29,7 +29,7 @@ private open class ExternalDeviceState<T>(
 
     override fun subscribe(): StateFlow<T> = flow
 
-    override fun toString(): String = "ExternalState()"
+    override fun toString(): String = "ExternalState(value=$value)"
 }
 
 /**

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/LateBindDeviceState.kt

@@ -47,6 +47,9 @@ public class LateBindDeviceState<T>(
     }
 
 
-    override fun toString(): String =
-        "LateBindDeviceState(initialValue=$initialValue, binding=${binding.takeIf { it.isCompleted }?.getCompleted()})"
+    override fun toString(): String = if (isBound) {
+        "LateBindDeviceState(binding=${binding.getCompleted()})"
+    } else {
+        "LateBindDeviceState(initialValue=$initialValue)"
+    }
 }

controls-constructor/src/commonMain/kotlin/space/kscience/controls/constructor/VirtualDeviceState.kt

@@ -12,13 +12,8 @@ import kotlinx.coroutines.flow.flowOf
  */
 private class VirtualDeviceState<T>(
     initialValue: T,
-    private val callback: (T) -> Unit = {}
 ) : MutableDeviceState<T> {
 
-    init {
-        callback(initialValue)
-    }
-
     private val flow = MutableStateFlow(initialValue)
 
     override fun subscribe(): StateFlow<T> = flow
@@ -27,12 +22,10 @@ private class VirtualDeviceState<T>(
         get() = flow.value
         set(value) {
             flow.value = value
-            callback(value)
         }
 
     override suspend fun emit(value: T) {
         flow.emit(value)
-        callback(value)
     }
 
     override fun toString(): String = "VirtualDeviceState($value)"
@@ -46,8 +39,7 @@ private class VirtualDeviceState<T>(
  */
 public fun <T> MutableDeviceState(
     initialValue: T,
-    callback: (T) -> Unit = {}
-): MutableDeviceState<T> = VirtualDeviceState(initialValue, callback)
+): MutableDeviceState<T> = VirtualDeviceState(initialValue)
 
 
 /**

controls-constructor/src/commonTest/kotlin/space/kscience/controls/constructor/ContinuousFlowTest.kt

@@ -22,6 +22,8 @@ class ContinuousFlowTest {
 
     val epoch = Instant.fromEpochMilliseconds(0L)
 
+    val kilograms = NumericAmountAlgebra<Kilograms>()
+
     val context = Context("test") {
         withVirtualTime(epoch)
     }
@@ -108,13 +110,13 @@ class ContinuousFlowTest {
             joinABC.consumation.printEach(this@runTest, "joinABC.consumation")
 
             assertEquals(Numeric(6.0), joinABC.production.value)
-            assertEquals(2.0,bProducer.production.value.value)
+            assertEquals(2.0, bProducer.production.value.value)
             assertEquals(1.0, joinAB.individualConsumation["a"]?.value?.value)
 
             abcConsumation.value = Numeric(3.0)
 
             assertEquals(Numeric(1.5), joinAB.production.value)
-            assertEquals(1.0,bProducer.production.value.value)
+            assertEquals(1.0, bProducer.production.value.value)
             assertEquals(0.5, joinAB.individualConsumation["a"]?.value?.value)
 
             abcConsumation.value = Numeric(4.0)
@@ -242,6 +244,57 @@ class ContinuousFlowTest {
             assertEquals(2.0, transformer.production.value.value)
             assertEquals(2.0, consumer.consumation.value.value)
             assertEquals(20.0, producer.production.value.value)
+        }
+    }
+
+    @Test
+    fun separation() = runTest {
+        val model = object : ContinuousFlowModel(context) {
+            val production = MutableDeviceState(Numeric<Kilograms>(4.0))
+            val aConsumation = MutableDeviceState(Numeric<Kilograms>(2.0))
+            val bConsumation = MutableDeviceState(Numeric<Kilograms>(2.0))
+            val cConsumation = MutableDeviceState(Numeric<Kilograms>(1.0))
+
+            val producer = producer(production)
+
+            val splitter1 = separator(
+                algebra = kilograms,
+                separationRule = SeparationRule.proportional(kilograms, mapOf("a" to 1.0, "bc" to 1.0))
+            ).apply {
+                connectProducer(producer)
+            }
+
+            val aConsumer = consumer(aConsumation).apply {
+                connectProducer(splitter1.asProducer("a"))
+            }
+
+            val splitter2 = separator(
+                algebra = kilograms,
+                separationRule = SeparationRule.proportional(kilograms, mapOf("b" to 1.0, "c" to 1.0))
+            ).apply {
+                connectProducer(splitter1.asProducer("bc"))
+            }
+
+            val bConsumer = consumer(bConsumation).apply {
+                connectProducer(splitter2.asProducer("b"))
+            }
+
+            val cConsumer = consumer(cConsumation).apply {
+                connectProducer(splitter2.asProducer("c"))
+            }
+        }.runSimulation {
+
+            assertEquals(4.0, producer.production.value.value)
+            assertEquals(2.0, aConsumer.consumation.value.value)
+            assertEquals(1.0, bConsumer.consumation.value.value)
+            assertEquals(1.0, cConsumer.consumation.value.value)
+
+            aConsumation.value = Numeric(1.0)
+
+            assertEquals(2.0, producer.production.value.value)
+            assertEquals(1.0, aConsumer.consumation.value.value)
+            assertEquals(0.5, bConsumer.consumation.value.value)
+            assertEquals(0.5, cConsumer.consumation.value.value)
 
         }
     }