com.zepben.evolve.services.network.equivalents.EquivalentEquipmentDetails.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 2023 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.services.network.equivalents

import com.zepben.evolve.cim.iec61970.base.core.ConductingEquipment
import com.zepben.evolve.cim.iec61970.base.core.ConnectivityNode
import com.zepben.evolve.cim.iec61970.base.equivalents.EquivalentBranch

/**
 * Data class that holds instances used to create any [ConductingEquipment] connected across an [EquivalentBranch].
 *
 * @property edgeEquipment The [ConductingEquipment] at the edge of the included network.
 * @property edgeNode The [ConnectivityNode] extending beyond the included network.
 * @property equivalentBranch The [EquivalentBranch] that was created to represent the external network. This is where the equivalent equipment will be
 *   attached.
 */
data class EquivalentEquipmentDetails(
    val edgeEquipment: ConductingEquipment,
    val edgeNode: ConnectivityNode,
    val equivalentBranch: EquivalentBranch
)