com.zepben.evolve.cim.iec61970.base.protection.ProtectionRelaySystem.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.protection

import com.zepben.evolve.cim.iec61970.base.core.Equipment
import com.zepben.evolve.cim.iec61970.infiec61970.protection.ProtectionKind
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

/**
 * A relay system for controlling ProtectedSwitches.
 *
 * @property protectionKind The kind of protection being provided by this protection equipment.
 * @property schemes The schemes implemented by this ProtectionRelaySystem.
 */
class ProtectionRelaySystem @JvmOverloads constructor(mRID: String = "") : Equipment(mRID) {

    var protectionKind: ProtectionKind = ProtectionKind.UNKNOWN
    
    private var _schemes: MutableList? = null

    val schemes: Collection get() = _schemes.asUnmodifiable()

    /**
     * Returns the number of schemes for this [ProtectionRelaySystem]
     */
    fun numSchemes(): Int = _schemes?.size ?: 0

    /**
     * Get a scheme for this [ProtectionRelaySystem] by its mRID.
     *
     * @param mRID The mRID of the [ProtectionRelayScheme]
     * @return The [ProtectionRelayScheme] with the specified [mRID] if it exists, otherwise null
     */
    fun getScheme(mRID: String): ProtectionRelayScheme? = _schemes.getByMRID(mRID)

    /**
     * Add a scheme to this [ProtectionRelaySystem]
     * @param scheme The scheme to add.
     * @return This [ProtectionRelaySystem] for fluent use.
     */
    fun addScheme(
        scheme: ProtectionRelayScheme,
    ): ProtectionRelaySystem {
        if (validateReference(scheme, ::getScheme, "A ProtectionRelayScheme"))
            return this

        _schemes = _schemes ?: mutableListOf()
        _schemes!!.add(scheme)

        return this
    }

    /**
     * Remove a scheme from this [ProtectionRelaySystem].
     * @param scheme The [ProtectionRelayScheme] to remove.
     * @return true if the scheme was removed.
     */
    fun removeScheme(scheme: ProtectionRelayScheme): Boolean {
        val ret = _schemes.safeRemove(scheme)
        if (_schemes.isNullOrEmpty()) _schemes = null
        return ret
    }

    /**
     * Clear [schemes].
     * @return This [ProtectionRelaySystem] for fluent use.
     */
    fun clearSchemes(): ProtectionRelaySystem {
        _schemes = null
        return this
    }

}