com.zepben.evolve.cim.iec61970.base.wires.TapChanger.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 2020 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.PowerSystemResource

/**
 * Mechanism for changing transformer winding tap positions.
 *
 * @property controlEnabled Specifies the regulation status of the equipment.  True is regulating, false is not regulating.
 * @property tapChangerControl The regulating control scheme in which this tap changer participates.
 * @property highStep Highest possible tap step position, advance from neutral. The attribute shall be greater than lowStep.
 * @property lowStep Lowest possible tap step position, retard from neutral.
 * @property neutralStep The neutral tap step position for this winding.
 *                       The attribute shall be equal or greater than lowStep and equal or less than highStep.
 * @property neutralU Voltage at which the winding operates at the neutral tap setting.
 * @property normalStep The tap step position used in "normal" network operation for this winding. For a "Fixed" tap changer indicates the current physical tap setting.
 *                      The attribute shall be equal or greater than lowStep and equal or less than highStep.
 * @property step Tap changer position.
 *                Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables.
 *                The reasons for continuous value are to support study cases where no discrete tap changers has yet been designed,
 *                a solutions where a narrow voltage band force the tap step to oscillate or accommodate for a continuous solution as input.
 *                The attribute shall be equal or greater than lowStep and equal or less than highStep.
 */
abstract class TapChanger(mRID: String = "") : PowerSystemResource(mRID) {

    var controlEnabled: Boolean = true

    var tapChangerControl: TapChangerControl? = null

    var highStep: Int? = null
        set(value) {
            check((value == null) || (value > (lowStep ?: Int.MIN_VALUE))) { "high step [$value] must be greater than low step [$lowStep]." }
            field = value
        }

    var lowStep: Int? = null
        set(value) {
            check((value == null) || (value < (highStep ?: Int.MAX_VALUE))) { "low step [$value] must be lower than high step [$highStep]." }
            field = value
        }

    var neutralStep: Int? = null
        set(value) {
            check(isInRange(value)) { "neutral step [$value] must be between high step [$highStep] and low step [$lowStep]." }
            field = value
        }

    var neutralU: Int? = null

    var normalStep: Int? = null
        set(value) {
            check(isInRange(value)) { "normal step [$value] must be between high step [$highStep] and low step [$lowStep]." }
            field = value
        }

    var step: Double? = null
        set(value) {
            check(isInRange(value)) { "step [$value] must be between high step [$highStep] and low step [$lowStep]." }
            field = value
        }

    private fun isInRange(value: Int?): Boolean =
        (value == null) || ((value >= (lowStep ?: Int.MIN_VALUE)) && (value <= (highStep ?: Int.MAX_VALUE)))

    private fun isInRange(value: Double?): Boolean =
        (value == null) || ((value >= (lowStep ?: Int.MIN_VALUE)) && (value <= (highStep ?: Int.MAX_VALUE)))

}