com.zepben.evolve.cim.iec61968.assetinfo.TransformerTankInfo.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 2021 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.iec61968.assetinfo

import com.zepben.evolve.cim.iec61968.assets.AssetInfo
import com.zepben.evolve.services.common.extensions.asUnmodifiable
import com.zepben.evolve.services.common.extensions.getByMRID
import com.zepben.evolve.services.common.extensions.safeRemove
import com.zepben.evolve.services.common.extensions.validateReference
import com.zepben.evolve.services.network.ResistanceReactance

/**
 * Set of transformer tank data, from an equipment library.
 *
 * @property powerTransformerInfo Power transformer data that this tank description is part of.
 */
class TransformerTankInfo @JvmOverloads constructor(mRID: String = "") : AssetInfo(mRID) {

    var powerTransformerInfo: PowerTransformerInfo? = null

    private var _transformerEndInfos: MutableList? = null

    /**
     * Data for all the ends described by this transformer tank data. The returned collection is read only.
     */
    val transformerEndInfos: List get() = _transformerEndInfos.asUnmodifiable()

    /**
     * Get the number of entries in the [TransformerEndInfo] collection.
     */
    fun numTransformerEndInfos(): Int = _transformerEndInfos?.size ?: 0

    /**
     * Get the [TransformerEndInfo] of this [TransformerTankInfo] represented by [mRID]
     *
     * @param mRID the mRID of the required [TransformerEndInfo]
     * @return The [TransformerEndInfo] with the specified [mRID] if it exists, otherwise null
     */
    fun getTransformerEndInfo(mRID: String): TransformerEndInfo? = _transformerEndInfos.getByMRID(mRID)

    /**
     * Add a [TransformerEndInfo] to this [TransformerTankInfo]
     *
     * @return This [TransformerTankInfo] for fluent use
     */
    fun addTransformerEndInfo(transformerEndInfo: TransformerEndInfo): TransformerTankInfo {
        if (validateReference(transformerEndInfo, ::getTransformerEndInfo, "A TransformerEndInfo"))
            return this

        _transformerEndInfos = _transformerEndInfos ?: mutableListOf()
        _transformerEndInfos!!.add(transformerEndInfo)

        return this
    }

    /**
     * Remove a [TransformerEndInfo] from this [TransformerTankInfo]
     *
     * @param transformerEndInfo The [TransformerEndInfo] to remove
     * @return true if [transformerEndInfo] is removed from the collection
     */
    fun removeTransformerEndInfo(transformerEndInfo: TransformerEndInfo): Boolean {
        val ret = _transformerEndInfos.safeRemove(transformerEndInfo)
        if (_transformerEndInfos.isNullOrEmpty()) _transformerEndInfos = null
        return ret
    }

    /**
     * Clear all [TransformerEndInfo]'s from this [TransformerTankInfo]
     *
     * @return This [TransformerTankInfo] for fluent use
     */
    fun clearTransformerEndInfos(): TransformerTankInfo {
        _transformerEndInfos = null
        return this
    }

    /**
     * Get the [ResistanceReactance] for the specified [endNumber] from the datasheet information.
     */
    fun resistanceReactance(endNumber: Int): ResistanceReactance? =
        transformerEndInfos.firstOrNull { it.endNumber == endNumber }?.resistanceReactance()

}