com.zepben.evolve.cim.iec61970.base.protection.ProtectionRelayScheme.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.IdentifiedObject
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 scheme that a group of relay functions implement. For example, typically schemes are primary and secondary, or main and failsafe.
 *
 * @property system The system this scheme belongs to.
 * @property functions The functions operated as part of this protection scheme.
 */
class ProtectionRelayScheme @JvmOverloads constructor(mRID: String = "") : IdentifiedObject(mRID) {

    var system: ProtectionRelaySystem? = null

    private var _functions: MutableList? = null

    val functions: Collection get() = _functions.asUnmodifiable()

    /**
     * Get the number of [ProtectionRelayFunction]s operated as a part of this [ProtectionRelayScheme].
     *
     * @return The number of [ProtectionRelayFunction]s operated as a part of this [ProtectionRelayScheme].
     */
    fun numFunctions(): Int = _functions?.size ?: 0

    /**
     * Get a [ProtectionRelayFunction] operated as a part of this [ProtectionRelayScheme] by its mRID.
     *
     * @param mRID The mRID of the desired [ProtectionRelayFunction]
     * @return The [ProtectionRelayFunction] with the specified [mRID] if it exists, otherwise null
     */
    fun getFunction(mRID: String): ProtectionRelayFunction? = _functions?.getByMRID(mRID)

    /**
     * Associate a [ProtectionRelayFunction] with this [ProtectionRelayScheme].
     *
     * @param function The [ProtectionRelayFunction] to associate with this [ProtectionRelayScheme].
     * @return A reference to this [ProtectionRelayScheme] for fluent use.
     */
    fun addFunction(function: ProtectionRelayFunction): ProtectionRelayScheme {
        if (validateReference(function, ::getFunction, "A ProtectionRelayFunction"))
            return this

        _functions = _functions ?: mutableListOf()
        _functions!!.add(function)

        return this
    }

    /**
     * Disassociate a [ProtectionRelayFunction] from this [ProtectionRelayScheme].
     *
     * @param function The [ProtectionRelayFunction] to disassociate from this [ProtectionRelayScheme].
     * @return true if the [ProtectionRelayFunction] was disassociated.
     */
    fun removeFunction(function: ProtectionRelayFunction): Boolean {
        val ret = _functions.safeRemove(function)
        if (_functions.isNullOrEmpty()) _functions = null
        return ret
    }

    /**
     * Disassociate all [ProtectionRelayFunction]s from this [ProtectionRelayScheme].
     *
     * @return A reference to this [ProtectionRelayScheme] for fluent use.
     */
    fun clearFunctions(): ProtectionRelayScheme {
        _functions = null
        return this
    }

}