com.zepben.evolve.services.network.NetworkServiceUtils.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/.
 */


@file:JvmName("NetworkServiceUtils")

package com.zepben.evolve.services.network

import com.zepben.evolve.cim.iec61968.assetinfo.*
import com.zepben.evolve.cim.iec61968.assets.AssetOwner
import com.zepben.evolve.cim.iec61968.assets.Pole
import com.zepben.evolve.cim.iec61968.assets.Streetlight
import com.zepben.evolve.cim.iec61968.common.Location
import com.zepben.evolve.cim.iec61968.common.Organisation
import com.zepben.evolve.cim.iec61968.infiec61968.infassetinfo.CurrentTransformerInfo
import com.zepben.evolve.cim.iec61968.infiec61968.infassetinfo.PotentialTransformerInfo
import com.zepben.evolve.cim.iec61968.infiec61968.infassetinfo.RelayInfo
import com.zepben.evolve.cim.iec61968.metering.Meter
import com.zepben.evolve.cim.iec61968.metering.UsagePoint
import com.zepben.evolve.cim.iec61968.operations.OperationalRestriction
import com.zepben.evolve.cim.iec61970.base.auxiliaryequipment.CurrentTransformer
import com.zepben.evolve.cim.iec61970.base.auxiliaryequipment.FaultIndicator
import com.zepben.evolve.cim.iec61970.base.auxiliaryequipment.PotentialTransformer
import com.zepben.evolve.cim.iec61970.base.core.*
import com.zepben.evolve.cim.iec61970.base.equivalents.EquivalentBranch
import com.zepben.evolve.cim.iec61970.base.meas.Accumulator
import com.zepben.evolve.cim.iec61970.base.meas.Analog
import com.zepben.evolve.cim.iec61970.base.meas.Control
import com.zepben.evolve.cim.iec61970.base.meas.Discrete
import com.zepben.evolve.cim.iec61970.base.protection.*
import com.zepben.evolve.cim.iec61970.base.scada.RemoteControl
import com.zepben.evolve.cim.iec61970.base.scada.RemoteSource
import com.zepben.evolve.cim.iec61970.base.wires.*
import com.zepben.evolve.cim.iec61970.base.wires.generation.production.BatteryUnit
import com.zepben.evolve.cim.iec61970.base.wires.generation.production.PhotoVoltaicUnit
import com.zepben.evolve.cim.iec61970.base.wires.generation.production.PowerElectronicsWindUnit
import com.zepben.evolve.cim.iec61970.infiec61970.feeder.Circuit
import com.zepben.evolve.cim.iec61970.infiec61970.feeder.Loop
import com.zepben.evolve.cim.iec61970.infiec61970.feeder.LvFeeder
import com.zepben.evolve.cim.iec61970.infiec61970.wires.generation.production.EvChargingUnit
import com.zepben.evolve.services.customer.CustomerService

/**
 * A function that provides an exhaustive `when` style statement for all [IdentifiedObject] leaf types supported by
 * the [NetworkService]. If the provided [identifiedObject] is not supported by the service the [isOther] handler
 * is invoked which by default will throw an [IllegalArgumentException]
 *
 * By using this function, you acknowledge that if any new types are added to the customer service, and thus this
 * function, it will cause a compilation error when updating to the new version. This should reduce errors due to
 * missed handling of new types introduced to the model. As this is intended behaviour it generally will not be
 * considered a breaking change in terms of semantic versioning of this library.
 *
 * If it is not critical that all types within the service are always handled, it is recommended to use a typical
 * `when` statement (Kotlin) or if-else branch (Java) and update new cases as required without breaking your code.
 *
 * @param identifiedObject The identified object to handle.
 * @param isBatteryUnit Handler when the [identifiedObject] is a [BatteryUnit]
 * @param isPhotoVoltaicUnit Handler when the [identifiedObject] is a [PhotoVoltaicUnit]
 * @param isPowerElectronicsWindUnit Handler when the [identifiedObject] is a [PowerElectronicsWindUnit]
 * @param isAcLineSegment Handler when the [identifiedObject] is an [AcLineSegment]
 * @param isAssetOwner Handler when the [identifiedObject] is an [AssetOwner]
 * @param isBaseVoltage Handler when the [identifiedObject] is a [BaseVoltage]
 * @param isBreaker Handler when the [identifiedObject] is a [Breaker]
 * @param isLoadBreakSwitch Handler when the [identifiedObject] is a [LoadBreakSwitch]
 * @param isBusbarSection Handler when the [identifiedObject] is a [BusbarSection]
 * @param isCableInfo Handler when the [identifiedObject] is a [CableInfo]
 * @param isCircuit Handler when the [identifiedObject] is a [Circuit]
 * @param isConnectivityNode Handler when the [identifiedObject] is a [ConnectivityNode]
 * @param isDisconnector Handler when the [identifiedObject] is a [Disconnector]
 * @param isEnergyConsumer Handler when the [identifiedObject] is an [EnergyConsumer]
 * @param isEnergyConsumerPhase Handler when the [identifiedObject] is an [EnergyConsumerPhase]
 * @param isEnergySource Handler when the [identifiedObject] is an [EnergySource]
 * @param isEnergySourcePhase Handler when the [identifiedObject] is an [EnergySourcePhase]
 * @param isFaultIndicator Handler when the [identifiedObject] is a [FaultIndicator]
 * @param isFeeder Handler when the [identifiedObject] is a [Feeder]
 * @param isFuse Handler when the [identifiedObject] is a [Fuse]
 * @param isGeographicalRegion Handler when the [identifiedObject] is a [GeographicalRegion]
 * @param isJumper Handler when the [identifiedObject] is a [Jumper]
 * @param isJunction Handler when the [identifiedObject] is a [Junction]
 * @param isLinearShuntCompensator Handler when the [identifiedObject] is a [LinearShuntCompensator]
 * @param isLocation Handler when the [identifiedObject] is a [Location]
 * @param isLvFeeder Handler when the [identifiedObject] is an [LvFeeder]
 * @param isLoop Handler when the [identifiedObject] is a [Loop]
 * @param isMeter Handler when the [identifiedObject] is a [Meter]
 * @param isOperationalRestriction Handler when the [identifiedObject] is an [OperationalRestriction]
 * @param isOrganisation Handler when the [identifiedObject] is an [Organisation]
 * @param isOverheadWireInfo Handler when the [identifiedObject] is an [OverheadWireInfo]
 * @param isPerLengthSequenceImpedance Handler when the [identifiedObject] is a [PerLengthSequenceImpedance]
 * @param isPole Handler when the [identifiedObject] is a [Pole]
 * @param isPowerElectronicsConnection Handler when the [identifiedObject] is a [PowerElectronicsConnection]
 * @param isPowerElectronicsConnectionPhase Handler when the [identifiedObject] is a [PowerElectronicsConnectionPhase]
 * @param isPowerTransformer Handler when the [identifiedObject] is a [PowerTransformer]
 * @param isPowerTransformerEnd Handler when the [identifiedObject] is a [PowerTransformerEnd]
 * @param isPowerTransformerInfo Handler when the [identifiedObject] is a [PowerTransformerInfo]
 * @param isRatioTapChanger Handler when the [identifiedObject] is a [RatioTapChanger]
 * @param isRecloser Handler when the [identifiedObject] is a [Recloser]
 * @param isSite Handler when the [identifiedObject] is a [Site]
 * @param isStreetlight Handler when the [identifiedObject] is a [Streetlight]
 * @param isSubGeographicalRegion Handler when the [identifiedObject] is a [SubGeographicalRegion]
 * @param isSubstation Handler when the [identifiedObject] is a [Substation]
 * @param isTerminal Handler when the [identifiedObject] is a [Terminal]
 * @param isUsagePoint Handler when the [identifiedObject] is a [UsagePoint]
 * @param isControl Handler when the [identifiedObject] is a [Control]
 * @param isAnalog Handler when the [identifiedObject] is an [Analog]
 * @param isAccumulator Handler when the [identifiedObject] is an [Accumulator]
 * @param isDiscrete Handler when the [identifiedObject] is a [Discrete]
 * @param isRemoteControl Handler when the [identifiedObject] is a [RemoteControl]
 * @param isRemoteSource Handler when the [identifiedObject] is a [RemoteSource]
 * @param isTransformerEndInfo Handler when the [identifiedObject] is a [TransformerEndInfo]
 * @param isTransformerStarImpedance Handler when the [identifiedObject] is a [TransformerStarImpedance]
 * @param isTransformerTankInfo Handler when the [identifiedObject] is a [TransformerTankInfo]
 * @param isNoLoadTest Handler when the [identifiedObject] is a [NoLoadTest]
 * @param isOpenCircuitTest Handler when the [identifiedObject] is an [OpenCircuitTest]
 * @param isShortCircuitTest Handler when the [identifiedObject] is a [ShortCircuitTest]
 * @param isEquivalentBranch Handler when the [identifiedObject] is an [EquivalentBranch]
 * @param isShuntCompensatorInfo Handler when the [identifiedObject] is a [ShuntCompensatorInfo]
 * @param isCurrentTransformerInfo Handler when the [identifiedObject] is a [CurrentTransformerInfo]
 * @param isPotentialTransformerInfo Handler when the [identifiedObject] is a [PotentialTransformerInfo]
 * @param isCurrentTransformer Handler when the [identifiedObject] is a [CurrentTransformer]
 * @param isPotentialTransformer Handler when the [identifiedObject] is a [PotentialTransformer]
 * @param isSwitchInfo Handler when the [identifiedObject] is a [SwitchInfo]
 * @param isRelayInfo Handler when the [identifiedObject] is a [RelayInfo]
 * @param isCurrentRelay Handler when the [identifiedObject] is a [CurrentRelay]
 * @param isEvChargingUnit Handler when the [identifiedObject] is an [EvChargingUnit]
 * @param isTapChangerControl Handler when the [identifiedObject] is a [TapChangerControl]
 * @param isSeriesCompensator Handler when the [identifiedObject] is a [SeriesCompensator]
 * @param isGround Handler when the [identifiedObject] is a [Ground]
 * @param isGroundDisconnector Handler when the [identifiedObject] is a [GroundDisconnector]
 * @param isProtectionRelayScheme Handler when the [identifiedObject] is a [ProtectionRelayScheme]
 * @param isProtectionRelaySystem Handler when the [identifiedObject] is a [ProtectionRelaySystem]
 * @param isVoltageRelay Handler when the [identifiedObject] is a [VoltageRelay]
 * @param isDistanceRelay Handler when the [identifiedObject] is a [DistanceRelay]
 * @param isGroundingImpedance Handler when the [identifiedObject] is a [GroundingImpedance]
 * @param isPetersenCoil Handler when the [identifiedObject] is a [PetersenCoil]
 * @param isReactiveCapabilityCurve Handler when the [identifiedObject] is a [ReactiveCapabilityCurve]
 * @param isSynchronousMachine Handler when the [identifiedObject] is a [SynchronousMachine]
 * @param isOther Handler when the [identifiedObject] is not supported by the [CustomerService].
 */
@JvmOverloads
inline fun  whenNetworkServiceObject(
    identifiedObject: IdentifiedObject,
    isBatteryUnit: (BatteryUnit) -> R,
    isPhotoVoltaicUnit: (PhotoVoltaicUnit) -> R,
    isPowerElectronicsWindUnit: (PowerElectronicsWindUnit) -> R,
    isAcLineSegment: (AcLineSegment) -> R,
    isAssetOwner: (AssetOwner) -> R,
    isBaseVoltage: (BaseVoltage) -> R,
    isBreaker: (Breaker) -> R,
    isLoadBreakSwitch: (LoadBreakSwitch) -> R,
    isBusbarSection: (BusbarSection) -> R,
    isCableInfo: (CableInfo) -> R,
    isCircuit: (Circuit) -> R,
    isConnectivityNode: (ConnectivityNode) -> R,
    isDisconnector: (Disconnector) -> R,
    isEnergyConsumer: (EnergyConsumer) -> R,
    isEnergyConsumerPhase: (EnergyConsumerPhase) -> R,
    isEnergySource: (EnergySource) -> R,
    isEnergySourcePhase: (EnergySourcePhase) -> R,
    isFaultIndicator: (FaultIndicator) -> R,
    isFeeder: (Feeder) -> R,
    isFuse: (Fuse) -> R,
    isGeographicalRegion: (GeographicalRegion) -> R,
    isJumper: (Jumper) -> R,
    isJunction: (Junction) -> R,
    isLinearShuntCompensator: (LinearShuntCompensator) -> R,
    isLocation: (Location) -> R,
    isLoop: (Loop) -> R,
    isLvFeeder: (LvFeeder) -> R,
    isMeter: (Meter) -> R,
    isOperationalRestriction: (OperationalRestriction) -> R,
    isOrganisation: (Organisation) -> R,
    isOverheadWireInfo: (OverheadWireInfo) -> R,
    isPerLengthSequenceImpedance: (PerLengthSequenceImpedance) -> R,
    isPole: (Pole) -> R,
    isPowerElectronicsConnection: (PowerElectronicsConnection) -> R,
    isPowerElectronicsConnectionPhase: (PowerElectronicsConnectionPhase) -> R,
    isPowerTransformer: (PowerTransformer) -> R,
    isPowerTransformerEnd: (PowerTransformerEnd) -> R,
    isPowerTransformerInfo: (PowerTransformerInfo) -> R,
    isRatioTapChanger: (RatioTapChanger) -> R,
    isRecloser: (Recloser) -> R,
    isSite: (Site) -> R,
    isStreetlight: (Streetlight) -> R,
    isSubGeographicalRegion: (SubGeographicalRegion) -> R,
    isSubstation: (Substation) -> R,
    isTerminal: (Terminal) -> R,
    isUsagePoint: (UsagePoint) -> R,
    isControl: (Control) -> R,
    isAnalog: (Analog) -> R,
    isAccumulator: (Accumulator) -> R,
    isDiscrete: (Discrete) -> R,
    isRemoteControl: (RemoteControl) -> R,
    isRemoteSource: (RemoteSource) -> R,
    isTransformerEndInfo: (TransformerEndInfo) -> R,
    isTransformerStarImpedance: (TransformerStarImpedance) -> R,
    isTransformerTankInfo: (TransformerTankInfo) -> R,
    isNoLoadTest: (NoLoadTest) -> R,
    isOpenCircuitTest: (OpenCircuitTest) -> R,
    isShortCircuitTest: (ShortCircuitTest) -> R,
    isEquivalentBranch: (EquivalentBranch) -> R,
    isShuntCompensatorInfo: (ShuntCompensatorInfo) -> R,
    isCurrentTransformerInfo: (CurrentTransformerInfo) -> R,
    isPotentialTransformerInfo: (PotentialTransformerInfo) -> R,
    isCurrentTransformer: (CurrentTransformer) -> R,
    isPotentialTransformer: (PotentialTransformer) -> R,
    isSwitchInfo: (SwitchInfo) -> R,
    isRelayInfo: (RelayInfo) -> R,
    isCurrentRelay: (CurrentRelay) -> R,
    isEvChargingUnit: (EvChargingUnit) -> R,
    isTapChangerControl: (TapChangerControl) -> R,
    isSeriesCompensator: (SeriesCompensator) -> R,
    isGround: (Ground) -> R,
    isGroundDisconnector: (GroundDisconnector) -> R,
    isProtectionRelayScheme: (ProtectionRelayScheme) -> R,
    isProtectionRelaySystem: (ProtectionRelaySystem) -> R,
    isVoltageRelay: (VoltageRelay) -> R,
    isDistanceRelay: (DistanceRelay) -> R,
    isGroundingImpedance: (GroundingImpedance) -> R,
    isPetersenCoil: (PetersenCoil) -> R,
    isReactiveCapabilityCurve: (ReactiveCapabilityCurve) -> R,
    isSynchronousMachine: (SynchronousMachine) -> R,
    isOther: (IdentifiedObject) -> R = { idObj: IdentifiedObject ->
        throw IllegalArgumentException("Identified object type ${idObj::class} is not supported by the network service")
    }
): R = when (identifiedObject) {
    is BatteryUnit -> isBatteryUnit(identifiedObject)
    is PhotoVoltaicUnit -> isPhotoVoltaicUnit(identifiedObject)
    is PowerElectronicsWindUnit -> isPowerElectronicsWindUnit(identifiedObject)
    is AcLineSegment -> isAcLineSegment(identifiedObject)
    is AssetOwner -> isAssetOwner(identifiedObject)
    is BaseVoltage -> isBaseVoltage(identifiedObject)
    is Breaker -> isBreaker(identifiedObject)
    is LoadBreakSwitch -> isLoadBreakSwitch(identifiedObject)
    is BusbarSection -> isBusbarSection(identifiedObject)
    is CableInfo -> isCableInfo(identifiedObject)
    is Circuit -> isCircuit(identifiedObject)
    is ConnectivityNode -> isConnectivityNode(identifiedObject)
    is Disconnector -> isDisconnector(identifiedObject)
    is EnergyConsumer -> isEnergyConsumer(identifiedObject)
    is EnergyConsumerPhase -> isEnergyConsumerPhase(identifiedObject)
    is EnergySource -> isEnergySource(identifiedObject)
    is EnergySourcePhase -> isEnergySourcePhase(identifiedObject)
    is FaultIndicator -> isFaultIndicator(identifiedObject)
    is Feeder -> isFeeder(identifiedObject)
    is Fuse -> isFuse(identifiedObject)
    is GeographicalRegion -> isGeographicalRegion(identifiedObject)
    is Jumper -> isJumper(identifiedObject)
    is Junction -> isJunction(identifiedObject)
    is LinearShuntCompensator -> isLinearShuntCompensator(identifiedObject)
    is Location -> isLocation(identifiedObject)
    is Loop -> isLoop(identifiedObject)
    is LvFeeder -> isLvFeeder(identifiedObject)
    is Meter -> isMeter(identifiedObject)
    is OperationalRestriction -> isOperationalRestriction(identifiedObject)
    is Organisation -> isOrganisation(identifiedObject)
    is OverheadWireInfo -> isOverheadWireInfo(identifiedObject)
    is PerLengthSequenceImpedance -> isPerLengthSequenceImpedance(identifiedObject)
    is Pole -> isPole(identifiedObject)
    is PowerElectronicsConnection -> isPowerElectronicsConnection(identifiedObject)
    is PowerElectronicsConnectionPhase -> isPowerElectronicsConnectionPhase(identifiedObject)
    is PowerTransformer -> isPowerTransformer(identifiedObject)
    is PowerTransformerEnd -> isPowerTransformerEnd(identifiedObject)
    is PowerTransformerInfo -> isPowerTransformerInfo(identifiedObject)
    is RatioTapChanger -> isRatioTapChanger(identifiedObject)
    is Recloser -> isRecloser(identifiedObject)
    is Site -> isSite(identifiedObject)
    is Streetlight -> isStreetlight(identifiedObject)
    is SubGeographicalRegion -> isSubGeographicalRegion(identifiedObject)
    is Substation -> isSubstation(identifiedObject)
    is Terminal -> isTerminal(identifiedObject)
    is UsagePoint -> isUsagePoint(identifiedObject)
    is Control -> isControl(identifiedObject)
    is Analog -> isAnalog(identifiedObject)
    is Accumulator -> isAccumulator(identifiedObject)
    is Discrete -> isDiscrete(identifiedObject)
    is RemoteControl -> isRemoteControl(identifiedObject)
    is RemoteSource -> isRemoteSource(identifiedObject)
    is TransformerEndInfo -> isTransformerEndInfo(identifiedObject)
    is TransformerStarImpedance -> isTransformerStarImpedance(identifiedObject)
    is TransformerTankInfo -> isTransformerTankInfo(identifiedObject)
    is NoLoadTest -> isNoLoadTest(identifiedObject)
    is OpenCircuitTest -> isOpenCircuitTest(identifiedObject)
    is ShortCircuitTest -> isShortCircuitTest(identifiedObject)
    is EquivalentBranch -> isEquivalentBranch(identifiedObject)
    is ShuntCompensatorInfo -> isShuntCompensatorInfo(identifiedObject)
    is CurrentTransformerInfo -> isCurrentTransformerInfo(identifiedObject)
    is PotentialTransformerInfo -> isPotentialTransformerInfo(identifiedObject)
    is CurrentTransformer -> isCurrentTransformer(identifiedObject)
    is PotentialTransformer -> isPotentialTransformer(identifiedObject)
    is SwitchInfo -> isSwitchInfo(identifiedObject)
    is RelayInfo -> isRelayInfo(identifiedObject)
    is CurrentRelay -> isCurrentRelay(identifiedObject)
    is EvChargingUnit -> isEvChargingUnit(identifiedObject)
    is TapChangerControl -> isTapChangerControl(identifiedObject)
    is SeriesCompensator -> isSeriesCompensator(identifiedObject)
    is Ground -> isGround(identifiedObject)
    is GroundDisconnector -> isGroundDisconnector(identifiedObject)
    is ProtectionRelayScheme -> isProtectionRelayScheme(identifiedObject)
    is ProtectionRelaySystem -> isProtectionRelaySystem(identifiedObject)
    is VoltageRelay -> isVoltageRelay(identifiedObject)
    is DistanceRelay -> isDistanceRelay(identifiedObject)
    is GroundingImpedance -> isGroundingImpedance(identifiedObject)
    is PetersenCoil -> isPetersenCoil(identifiedObject)
    is ReactiveCapabilityCurve -> isReactiveCapabilityCurve(identifiedObject)
    is SynchronousMachine -> isSynchronousMachine(identifiedObject)
    else -> isOther(identifiedObject)
}