summaryrefslogtreecommitdiff
path: root/opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt
diff options
context:
space:
mode:
authorAlessio Leonardo Tomei <122273875+T0mexX@users.noreply.github.com>2024-08-22 14:40:57 +0200
committerGitHub <noreply@github.com>2024-08-22 14:40:57 +0200
commit4f98fb2bf8204f6af52cd6eeb3313d21c6ca95bc (patch)
treea9a67ce01615cfccfc787573626ae8c9f2ff740c /opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt
parentb2877899b9479458dba5e7dcba2891f1248b5d6d (diff)
Added Unit of measurament system with new deserialization (#242)
Diffstat (limited to 'opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt')
-rw-r--r--opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt102
1 files changed, 102 insertions, 0 deletions
diff --git a/opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt b/opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt
new file mode 100644
index 00000000..fc9f6bf4
--- /dev/null
+++ b/opendc-common/src/main/kotlin/org/opendc/common/units/Power.kt
@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2024 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+@file:OptIn(InternalUse::class)
+
+package org.opendc.common.units
+
+import kotlinx.serialization.Serializable
+import org.opendc.common.annotations.InternalUse
+import org.opendc.common.units.Time.Companion.toTime
+import org.opendc.common.utils.fmt
+import org.opendc.common.utils.ifNeg0thenPos0
+import java.time.Duration
+import kotlin.text.RegexOption.IGNORE_CASE
+
+/**
+ * Represents power values.
+ * @see[Unit]
+ */
+@JvmInline
+@Serializable(with = Power.Companion.PowerSerializer::class)
+public value class Power private constructor(
+ // In Watts.
+ override val value: Double,
+) : Unit<Power> {
+ @InternalUse
+ override fun new(value: Double): Power = Power(value.ifNeg0thenPos0())
+
+ public fun toWatts(): Double = value
+
+ public fun toKWatts(): Double = value / 1000.0
+
+ override fun toString(): String = fmtValue()
+
+ override fun fmtValue(fmt: String): String =
+ if (value >= 1000.0) {
+ "${toKWatts().fmt(fmt)} KWatts"
+ } else {
+ "${toWatts().fmt(fmt)} Watts"
+ }
+
+ public operator fun times(time: Time): Energy = Energy.ofWh(toWatts() * time.toHours())
+
+ public operator fun times(duration: Duration): Energy = this * duration.toTime()
+
+ public companion object {
+ @JvmStatic
+ public val ZERO: Power = Power(.0)
+
+ @JvmStatic
+ @JvmName("ofWatts")
+ public fun ofWatts(watts: Number): Power = Power(watts.toDouble())
+
+ @JvmStatic
+ @JvmName("ofKWatts")
+ public fun ofKWatts(kWatts: Number): Power = Power(kWatts.toDouble() * 1000.0)
+
+ /**
+ * Serializer for [Power] value class. It needs to be a compile
+ * time constant in order to be used as serializer automatically,
+ * hence `object :` instead of class instantiation.
+ *
+ * ```json
+ * // e.g.
+ * "power-draw": "4 watts"
+ * "power-draw": " 1 KWatt "
+ * // etc.
+ * ```
+ */
+ internal object PowerSerializer : UnitSerializer<Power>(
+ ifNumber = {
+ LOG.warn(
+ "deserialization of number with no unit of measure, assuming it is in Watts." +
+ "Keep in mind that you can also specify the value as '$it W'",
+ )
+ ofWatts(it.toDouble())
+ },
+ serializerFun = { this.encodeString(it.toString()) },
+ ifMatches("$NUM_GROUP$WATTS", IGNORE_CASE) { ofWatts(json.decNumFromStr(groupValues[1])) },
+ ifMatches("$NUM_GROUP$KILO$WATTS", IGNORE_CASE) { ofKWatts(json.decNumFromStr(groupValues[1])) },
+ )
+ }
+}