com.zepben.evolve.cim.iec61970.base.wires.SinglePhaseKind.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation
SDK for interaction with the evolve platform
There is a newer version: 0.24.0rc1
/*
 * Copyright 2024 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.cim.iec61970.base.wires

import com.zepben.evolve.cim.iec61970.base.core.PhaseCode
import com.zepben.evolve.cim.iec61970.base.wires.SinglePhaseKind.*

/**
 * Enumeration of single phase identifiers. Allows designation of single phases for both transmission and distribution equipment, circuits and loads.
 *
 * @property NONE no phase specified.
 * @property A Phase A.
 * @property B Phase B.
 * @property C Phase C.
 * @property N Neutral.
 * @property X An unknown primary phase.
 * @property Y An unknown primary phase.
 * @property s1 Secondary phase 1.
 * @property s2 Secondary phase 2.
 * @property INVALID Invalid phase. Caused by trying to energise with multiple phases simultaneously.
 */
@Suppress("EnumEntryName")
enum class SinglePhaseKind(val value: Int, val maskIndex: Int) {

    /**
     * no phase specified.
     */
    NONE(0, -1),

    /**
     * Phase A.
     */
    A(1, 0),

    /**
     * Phase B.
     */
    B(2, 1),

    /**
     * Phase C.
     */
    C(3, 2),

    /**
     * Neutral.
     */
    N(4, 3),

    /**
     * An unknown primary phase.
     */
    X(5, 0),

    /**
     * An unknown primary phase.
     */
    Y(6, 1),

    /**
     * Secondary phase 1.
     */
    s1(7, 0),

    /**
     * Secondary phase 2.
     */
    s2(8, 1),

    /**
     * Invalid phase. Caused by trying to energise with multiple phases simultaneously.
     */
    INVALID(9, -1);

    companion object {
        private val phasesByValues: List = enumValues().sortedBy { it.value }

        @JvmStatic
        fun get(value: Int): SinglePhaseKind {
            return if (value < 0 || value >= INVALID.value) INVALID else phasesByValues[value]
        }
    }

    val bitMask: Int = if (maskIndex >= 0) 1 shl maskIndex else 0

    operator fun plus(phase: SinglePhaseKind): PhaseCode = PhaseCode.fromSinglePhases(setOf(this) + phase)
    operator fun plus(phaseCode: PhaseCode): PhaseCode = PhaseCode.fromSinglePhases(setOf(this) + phaseCode.singlePhases)
    operator fun minus(phase: SinglePhaseKind): PhaseCode = PhaseCode.fromSinglePhases(setOf(this) - phase)
    operator fun minus(phaseCode: PhaseCode): PhaseCode = PhaseCode.fromSinglePhases(setOf(this) - phaseCode.singlePhases.toSet())

    @Deprecated("Use `value` (or `getValue()` in java) instead.", ReplaceWith("value"))
    fun value(): Int {
        return value
    }

    @Deprecated("Use `maskIndex` (or `getMaskIndex()` in java) instead.", ReplaceWith("maskIndex"))
    fun maskIndex(): Int {
        return maskIndex
    }

    @Deprecated("Use `bitMask` (or `getBitMask()` in java) instead.", ReplaceWith("bitMask"))
    fun bitMask(): Int {
        return bitMask
    }

}