zepben.ewb 1.0.0b1__py3-none-any.whl

zepben/ewb/database/sqlite/network/network_service_reader.py

@@ -0,0 +1,265 @@
+#  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/.
+
+__all__ = ["NetworkServiceReader"]
+
+from sqlite3 import Connection
+
+from zepben.ewb.database.sqlite.common.base_service_reader import BaseServiceReader
+from zepben.ewb.database.sqlite.network.network_cim_reader import NetworkCimReader
+from zepben.ewb.database.sqlite.network.network_database_tables import NetworkDatabaseTables
+from zepben.ewb.database.sqlite.tables.associations.table_asset_organisation_roles_assets import TableAssetOrganisationRolesAssets
+from zepben.ewb.database.sqlite.tables.associations.table_assets_power_system_resources import TableAssetsPowerSystemResources
+from zepben.ewb.database.sqlite.tables.associations.table_battery_units_battery_controls import TableBatteryUnitsBatteryControls
+from zepben.ewb.database.sqlite.tables.associations.table_circuits_substations import TableCircuitsSubstations
+from zepben.ewb.database.sqlite.tables.associations.table_circuits_terminals import TableCircuitsTerminals
+from zepben.ewb.database.sqlite.tables.associations.table_end_devices_end_device_functions import TableEndDevicesEndDeviceFunctions
+from zepben.ewb.database.sqlite.tables.associations.table_equipment_equipment_containers import TableEquipmentEquipmentContainers
+from zepben.ewb.database.sqlite.tables.associations.table_equipment_operational_restrictions import TableEquipmentOperationalRestrictions
+from zepben.ewb.database.sqlite.tables.associations.table_equipment_usage_points import TableEquipmentUsagePoints
+from zepben.ewb.database.sqlite.tables.associations.table_loops_substations import TableLoopsSubstations
+from zepben.ewb.database.sqlite.tables.associations.table_protection_relay_functions_protected_switches import TableProtectionRelayFunctionsProtectedSwitches
+from zepben.ewb.database.sqlite.tables.associations.table_protection_relay_functions_sensors import TableProtectionRelayFunctionsSensors
+from zepben.ewb.database.sqlite.tables.associations.table_protection_relay_schemes_protection_relay_functions import \
+    TableProtectionRelaySchemesProtectionRelayFunctions
+from zepben.ewb.database.sqlite.tables.associations.table_synchronous_machines_reactive_capability_curves import \
+    TableSynchronousMachinesReactiveCapabilityCurves
+from zepben.ewb.database.sqlite.tables.associations.table_usage_points_end_devices import TableUsagePointsEndDevices
+from zepben.ewb.database.sqlite.tables.extensions.iec61968.assetinfo.table_reclose_delays import TableRecloseDelays
+from zepben.ewb.database.sqlite.tables.extensions.iec61968.assetinfo.table_relay_info import TableRelayInfo
+from zepben.ewb.database.sqlite.tables.extensions.iec61968.metering.table_pan_demand_response_functions import TablePanDemandResponseFunctions
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.core.table_sites import TableSites
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.feeder.table_loops import TableLoops
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.feeder.table_lv_feeders import TableLvFeeders
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.generation.production.table_ev_charging_units import TableEvChargingUnits
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.protection.table_distance_relays import TableDistanceRelays
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.protection.table_protection_relay_function_thresholds import \
+    TableProtectionRelayFunctionThresholds
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.protection.table_protection_relay_function_time_limits import \
+    TableProtectionRelayFunctionTimeLimits
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.protection.table_protection_relay_schemes import TableProtectionRelaySchemes
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.protection.table_protection_relay_systems import TableProtectionRelaySystems
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.protection.table_voltage_relays import TableVoltageRelays
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.wires.table_battery_controls import TableBatteryControls
+from zepben.ewb.database.sqlite.tables.extensions.iec61970.base.wires.table_power_transformer_end_ratings import TablePowerTransformerEndRatings
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_cable_info import TableCableInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_no_load_tests import TableNoLoadTests
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_open_circuit_tests import TableOpenCircuitTests
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_overhead_wire_info import TableOverheadWireInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_power_transformer_info import TablePowerTransformerInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_short_circuit_tests import TableShortCircuitTests
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_shunt_compensator_info import TableShuntCompensatorInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_switch_info import TableSwitchInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_transformer_end_info import TableTransformerEndInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assetinfo.table_transformer_tank_info import TableTransformerTankInfo
+from zepben.ewb.database.sqlite.tables.iec61968.assets.table_asset_owners import TableAssetOwners
+from zepben.ewb.database.sqlite.tables.iec61968.assets.table_streetlights import TableStreetlights
+from zepben.ewb.database.sqlite.tables.iec61968.common.table_location_street_addresses import TableLocationStreetAddresses
+from zepben.ewb.database.sqlite.tables.iec61968.common.table_locations import TableLocations
+from zepben.ewb.database.sqlite.tables.iec61968.common.table_organisations import TableOrganisations
+from zepben.ewb.database.sqlite.tables.iec61968.common.table_position_points import TablePositionPoints
+from zepben.ewb.database.sqlite.tables.iec61968.infiec61968.infassetinfo.table_current_transformer_info import TableCurrentTransformerInfo
+from zepben.ewb.database.sqlite.tables.iec61968.infiec61968.infassetinfo.table_potential_transformer_info import TablePotentialTransformerInfo
+from zepben.ewb.database.sqlite.tables.iec61968.infiec61968.infassets.table_poles import TablePoles
+from zepben.ewb.database.sqlite.tables.iec61968.metering.table_meters import TableMeters
+from zepben.ewb.database.sqlite.tables.iec61968.metering.table_usage_points import TableUsagePoints
+from zepben.ewb.database.sqlite.tables.iec61968.operations.table_operational_restrictions import TableOperationalRestrictions
+from zepben.ewb.database.sqlite.tables.iec61970.base.auxiliaryequipment.table_current_transformers import TableCurrentTransformers
+from zepben.ewb.database.sqlite.tables.iec61970.base.auxiliaryequipment.table_fault_indicators import TableFaultIndicators
+from zepben.ewb.database.sqlite.tables.iec61970.base.auxiliaryequipment.table_potential_transformers import TablePotentialTransformers
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_base_voltages import TableBaseVoltages
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_connectivity_nodes import TableConnectivityNodes
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_curve_data import TableCurveData
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_feeders import TableFeeders
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_geographical_regions import TableGeographicalRegions
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_sub_geographical_regions import TableSubGeographicalRegions
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_substations import TableSubstations
+from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_terminals import TableTerminals
+from zepben.ewb.database.sqlite.tables.iec61970.base.equivalents.table_equivalent_branches import TableEquivalentBranches
+from zepben.ewb.database.sqlite.tables.iec61970.base.generation.production.table_battery_units import TableBatteryUnits
+from zepben.ewb.database.sqlite.tables.iec61970.base.generation.production.table_photo_voltaic_units import TablePhotoVoltaicUnits
+from zepben.ewb.database.sqlite.tables.iec61970.base.generation.production.table_power_electronics_wind_units import TablePowerElectronicsWindUnits
+from zepben.ewb.database.sqlite.tables.iec61970.base.meas.table_accumulators import TableAccumulators
+from zepben.ewb.database.sqlite.tables.iec61970.base.meas.table_analogs import TableAnalogs
+from zepben.ewb.database.sqlite.tables.iec61970.base.meas.table_controls import TableControls
+from zepben.ewb.database.sqlite.tables.iec61970.base.meas.table_discretes import TableDiscretes
+from zepben.ewb.database.sqlite.tables.iec61970.base.protection.table_current_relays import TableCurrentRelays
+from zepben.ewb.database.sqlite.tables.iec61970.base.scada.table_remote_controls import TableRemoteControls
+from zepben.ewb.database.sqlite.tables.iec61970.base.scada.table_remote_sources import TableRemoteSources
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_ac_line_segments import TableAcLineSegments
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_breakers import TableBreakers
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_busbar_sections import TableBusbarSections
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_clamps import TableClamps
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_cuts import TableCuts
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_disconnectors import TableDisconnectors
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_energy_consumer_phases import TableEnergyConsumerPhases
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_energy_consumers import TableEnergyConsumers
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_energy_source_phases import TableEnergySourcePhases
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_energy_sources import TableEnergySources
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_fuses import TableFuses
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_ground_disconnectors import TableGroundDisconnectors
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_grounding_impedances import TableGroundingImpedances
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_grounds import TableGrounds
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_jumpers import TableJumpers
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_junctions import TableJunctions
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_linear_shunt_compensators import TableLinearShuntCompensators
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_load_break_switches import TableLoadBreakSwitches
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_per_length_phase_impedances import TablePerLengthPhaseImpedances
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_per_length_sequence_impedances import TablePerLengthSequenceImpedances
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_petersen_coils import TablePetersenCoils
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_phase_impedance_data import TablePhaseImpedanceData
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_power_electronics_connection_phases import TablePowerElectronicsConnectionPhases
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_power_electronics_connections import TablePowerElectronicsConnections
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_power_transformer_ends import TablePowerTransformerEnds
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_power_transformers import TablePowerTransformers
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_ratio_tap_changers import TableRatioTapChangers
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_reactive_capability_curves import TableReactiveCapabilityCurves
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_reclosers import TableReclosers
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_series_compensators import TableSeriesCompensators
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_static_var_compensator import TableStaticVarCompensators
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_synchronous_machines import TableSynchronousMachines
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_tap_changer_controls import TableTapChangerControls
+from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_transformer_star_impedances import TableTransformerStarImpedances
+from zepben.ewb.database.sqlite.tables.iec61970.infiec61970.feeder.table_circuits import TableCircuits
+from zepben.ewb.services.network.network_service import NetworkService
+
+
+class NetworkServiceReader(BaseServiceReader):
+    """
+    A class for reading a `NetworkService` from the database.
+
+    :param service: The `NetworkService` to populate from the database.
+    :param database_tables: The tables available in the database.
+    :param connection: A connection to the database.
+
+    :param reader: The `NetworkCimReader` used to load the objects from the database.
+    """
+
+    def __init__(
+        self,
+        service: NetworkService,
+        database_tables: NetworkDatabaseTables,
+        connection: Connection,
+        reader: NetworkCimReader = None
+    ):
+        reader = reader if reader else NetworkCimReader(service)
+        super().__init__(database_tables, connection, reader)
+
+        # This is not strictly necessary, it is just to update the type of the reader. It could be done with a generic
+        # on the base class which looks like it works, but that actually silently breaks code insight and completion
+        self._reader = reader
+
+    def _do_load(self) -> bool:
+        return all([
+            self._load_each(TableCableInfo, self._reader.load_cable_info),
+            self._load_each(TableOverheadWireInfo, self._reader.load_overhead_wire_info),
+            self._load_each(TablePowerTransformerInfo, self._reader.load_power_transformer_info),
+            self._load_each(TableTransformerTankInfo, self._reader.load_transformer_tank_info),
+            self._load_each(TableNoLoadTests, self._reader.load_no_load_test),
+            self._load_each(TableOpenCircuitTests, self._reader.load_open_circuit_test),
+            self._load_each(TableShortCircuitTests, self._reader.load_short_circuit_test),
+            self._load_each(TableShuntCompensatorInfo, self._reader.load_shunt_compensator_info),
+            self._load_each(TableSwitchInfo, self._reader.load_switch_info),
+            self._load_each(TableTransformerEndInfo, self._reader.load_transformer_end_info),
+            self._load_each(TableCurrentTransformerInfo, self._reader.load_current_transformer_info),
+            self._load_each(TablePotentialTransformerInfo, self._reader.load_potential_transformer_info),
+            self._load_each(TableRelayInfo, self._reader.load_relay_info),
+            self._load_each(TableRecloseDelays, self._reader.load_reclose_delay),
+            self._load_each(TableLocations, self._reader.load_location),
+            self._load_each(TableOrganisations, self._reader.load_organisations),
+            self._load_each(TableAssetOwners, self._reader.load_asset_owner),
+            self._load_each(TablePoles, self._reader.load_pole),
+            self._load_each(TableStreetlights, self._reader.load_streetlight),
+            self._load_each(TablePanDemandResponseFunctions, self._reader.load_pan_demand_response_function),
+            self._load_each(TableMeters, self._reader.load_meter),
+            self._load_each(TableEndDevicesEndDeviceFunctions, self._reader.load_end_devices_end_device_functions),
+            self._load_each(TableUsagePoints, self._reader.load_usage_point),
+            self._load_each(TableOperationalRestrictions, self._reader.load_operational_restriction),
+            self._load_each(TableBaseVoltages, self._reader.load_base_voltage),
+            self._load_each(TableConnectivityNodes, self._reader.load_connectivity_node),
+            self._load_each(TableGeographicalRegions, self._reader.load_geographical_region),
+            self._load_each(TableSubGeographicalRegions, self._reader.load_sub_geographical_region),
+            self._load_each(TableSubstations, self._reader.load_substation),
+            self._load_each(TableSites, self._reader.load_site),
+            self._load_each(TablePerLengthPhaseImpedances, self._reader.load_per_length_phase_impedance),
+            self._load_each(TablePhaseImpedanceData, self._reader.load_phase_impedance_data),
+            self._load_each(TablePerLengthSequenceImpedances, self._reader.load_per_length_sequence_impedance),
+            self._load_each(TableEquivalentBranches, self._reader.load_equivalent_branch),
+            self._load_each(TableAcLineSegments, self._reader.load_ac_line_segment),
+            self._load_each(TableBreakers, self._reader.load_breaker),
+            self._load_each(TableLoadBreakSwitches, self._reader.load_load_break_switch),
+            self._load_each(TableBusbarSections, self._reader.load_busbar_section),
+            self._load_each(TableClamps, self._reader.load_clamp),
+            self._load_each(TableCuts, self._reader.load_cut),
+            self._load_each(TableCurrentRelays, self._reader.load_current_relay),
+            self._load_each(TableDistanceRelays, self._reader.load_distance_relay),
+            self._load_each(TableVoltageRelays, self._reader.load_voltage_relay),
+            self._load_each(TableProtectionRelayFunctionThresholds, self._reader.load_protection_relay_function_threshold),
+            self._load_each(TableProtectionRelayFunctionTimeLimits, self._reader.load_protection_relay_function_time_limit),
+            self._load_each(TableProtectionRelaySystems, self._reader.load_protection_relay_system),
+            self._load_each(TableProtectionRelaySchemes, self._reader.load_protection_relay_scheme),
+            self._load_each(TableDisconnectors, self._reader.load_disconnector),
+            self._load_each(TableEnergyConsumers, self._reader.load_energy_consumer),
+            self._load_each(TableEnergyConsumerPhases, self._reader.load_energy_consumer_phase),
+            self._load_each(TableEnergySources, self._reader.load_energy_source),
+            self._load_each(TableEnergySourcePhases, self._reader.load_energy_source_phase),
+            self._load_each(TableFuses, self._reader.load_fuse),
+            self._load_each(TableJumpers, self._reader.load_jumper),
+            self._load_each(TableJunctions, self._reader.load_junction),
+            self._load_each(TableGrounds, self._reader.load_ground),
+            self._load_each(TableGroundDisconnectors, self._reader.load_ground_disconnector),
+            self._load_each(TableSeriesCompensators, self._reader.load_series_compensator),
+            self._load_each(TableStaticVarCompensators, self._reader.load_static_var_compensator),
+            self._load_each(TableLinearShuntCompensators, self._reader.load_linear_shunt_compensator),
+            self._load_each(TablePowerTransformers, self._reader.load_power_transformer),
+            self._load_each(TableReclosers, self._reader.load_recloser),
+            self._load_each(TablePowerElectronicsConnections, self._reader.load_power_electronics_connection),
+            self._load_each(TableReactiveCapabilityCurves, self._reader.load_reactive_capability_curve),
+            self._load_each(TableCurveData, self._reader.load_curve_data),
+            self._load_each(TablePetersenCoils, self._reader.load_petersen_coil),
+            self._load_each(TableGroundingImpedances, self._reader.load_grounding_impedance),
+            self._load_each(TableSynchronousMachines, self._reader.load_synchronous_machine),
+            self._load_each(TableTerminals, self._reader.load_terminal),
+            self._load_each(TableTapChangerControls, self._reader.load_tap_changer_control),
+            self._load_each(TablePowerElectronicsConnectionPhases, self._reader.load_power_electronics_connection_phase),
+            self._load_each(TableBatteryControls, self._reader.load_battery_controls),
+            self._load_each(TableBatteryUnits, self._reader.load_battery_unit),
+            self._load_each(TableBatteryUnitsBatteryControls, self._reader.load_battery_units_battery_controls),
+            self._load_each(TablePhotoVoltaicUnits, self._reader.load_photo_voltaic_unit),
+            self._load_each(TablePowerElectronicsWindUnits, self._reader.load_power_electronics_wind_unit),
+            self._load_each(TableEvChargingUnits, self._reader.load_ev_charging_unit),
+            self._load_each(TableTransformerStarImpedances, self._reader.load_transformer_star_impedance),
+            self._load_each(TablePowerTransformerEnds, self._reader.load_power_transformer_end),
+            self._load_each(TablePowerTransformerEndRatings, self._reader.load_power_transformer_end_rating),
+            self._load_each(TableRatioTapChangers, self._reader.load_ratio_tap_changer),
+            self._load_each(TableCurrentTransformers, self._reader.load_current_transformer),
+            self._load_each(TableFaultIndicators, self._reader.load_fault_indicator),
+            self._load_each(TablePotentialTransformers, self._reader.load_potential_transformer),
+            self._load_each(TableFeeders, self._reader.load_feeder),
+            self._load_each(TableLoops, self._reader.load_loop),
+            self._load_each(TableLvFeeders, self._reader.load_lv_feeder),
+            self._load_each(TableCircuits, self._reader.load_circuit),
+            self._load_each(TablePositionPoints, self._reader.load_position_point),
+            self._load_each(TableLocationStreetAddresses, self._reader.load_location_street_address),
+            self._load_each(TableAssetOrganisationRolesAssets, self._reader.load_asset_organisation_roles_asset),
+            self._load_each(TableAssetsPowerSystemResources, self._reader.load_asset_power_system_resources),
+            self._load_each(TableUsagePointsEndDevices, self._reader.load_usage_points_end_device),
+            self._load_each(TableEquipmentUsagePoints, self._reader.load_equipment_usage_point),
+            self._load_each(TableEquipmentOperationalRestrictions, self._reader.load_equipment_operational_restriction),
+            self._load_each(TableEquipmentEquipmentContainers, self._reader.load_equipment_equipment_container),
+            self._load_each(TableCircuitsSubstations, self._reader.load_circuits_substation),
+            self._load_each(TableCircuitsTerminals, self._reader.load_circuits_terminal),
+            self._load_each(TableLoopsSubstations, self._reader.load_loops_substation),
+            self._load_each(TableProtectionRelayFunctionsProtectedSwitches, self._reader.load_protection_relay_functions_protected_switch),
+            self._load_each(TableProtectionRelayFunctionsSensors, self._reader.load_protection_relay_functions_sensor),
+            self._load_each(TableProtectionRelaySchemesProtectionRelayFunctions, self._reader.load_protection_relay_schemes_protection_relay_function),
+            self._load_each(TableSynchronousMachinesReactiveCapabilityCurves, self._reader.load_synchronous_machines_reactive_capability_curve),
+            self._load_each(TableControls, self._reader.load_control),
+            self._load_each(TableRemoteControls, self._reader.load_remote_control),
+            self._load_each(TableRemoteSources, self._reader.load_remote_source),
+            self._load_each(TableAnalogs, self._reader.load_analog),
+            self._load_each(TableAccumulators, self._reader.load_accumulator),
+            self._load_each(TableDiscretes, self._reader.load_discrete),
+        ])

zepben/ewb/database/sqlite/network/network_service_writer.py

@@ -0,0 +1,209 @@
+#  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/.
+
+__all__ = ["NetworkServiceWriter"]
+
+from zepben.ewb.database.sqlite.common.base_service_writer import BaseServiceWriter
+from zepben.ewb.database.sqlite.network.network_cim_writer import NetworkCimWriter
+from zepben.ewb.database.sqlite.network.network_database_tables import NetworkDatabaseTables
+from zepben.ewb.model.cim.extensions.iec61968.assetinfo.relay_info import RelayInfo
+from zepben.ewb.model.cim.extensions.iec61968.metering.pan_demand_reponse_function import PanDemandResponseFunction
+from zepben.ewb.model.cim.extensions.iec61970.base.core.site import Site
+from zepben.ewb.model.cim.extensions.iec61970.base.feeder.loop import Loop
+from zepben.ewb.model.cim.extensions.iec61970.base.feeder.lv_feeder import LvFeeder
+from zepben.ewb.model.cim.extensions.iec61970.base.generation.production.ev_charging_unit import EvChargingUnit
+from zepben.ewb.model.cim.extensions.iec61970.base.protection.distance_relay import DistanceRelay
+from zepben.ewb.model.cim.extensions.iec61970.base.protection.protection_relay_scheme import ProtectionRelayScheme
+from zepben.ewb.model.cim.extensions.iec61970.base.protection.protection_relay_system import ProtectionRelaySystem
+from zepben.ewb.model.cim.extensions.iec61970.base.protection.voltage_relay import VoltageRelay
+from zepben.ewb.model.cim.extensions.iec61970.base.wires.battery_control import BatteryControl
+from zepben.ewb.model.cim.iec61968.assetinfo.cable_info import CableInfo
+from zepben.ewb.model.cim.iec61968.assetinfo.no_load_test import NoLoadTest
+from zepben.ewb.model.cim.iec61968.assetinfo.open_circuit_test import OpenCircuitTest
+from zepben.ewb.model.cim.iec61968.assetinfo.overhead_wire_info import OverheadWireInfo
+from zepben.ewb.model.cim.iec61968.assetinfo.power_transformer_info import PowerTransformerInfo
+from zepben.ewb.model.cim.iec61968.assetinfo.short_circuit_test import ShortCircuitTest
+from zepben.ewb.model.cim.iec61968.assetinfo.shunt_compensator_info import ShuntCompensatorInfo
+from zepben.ewb.model.cim.iec61968.assetinfo.switch_info import SwitchInfo
+from zepben.ewb.model.cim.iec61968.assetinfo.transformer_end_info import TransformerEndInfo
+from zepben.ewb.model.cim.iec61968.assetinfo.transformer_tank_info import TransformerTankInfo
+from zepben.ewb.model.cim.iec61968.assets.asset_owner import AssetOwner
+from zepben.ewb.model.cim.iec61968.assets.streetlight import Streetlight
+from zepben.ewb.model.cim.iec61968.common.location import Location
+from zepben.ewb.model.cim.iec61968.common.organisation import Organisation
+from zepben.ewb.model.cim.iec61968.infiec61968.infassetinfo.current_transformer_info import CurrentTransformerInfo
+from zepben.ewb.model.cim.iec61968.infiec61968.infassetinfo.potential_transformer_info import PotentialTransformerInfo
+from zepben.ewb.model.cim.iec61968.infiec61968.infassets.pole import Pole
+from zepben.ewb.model.cim.iec61968.metering.meter import Meter
+from zepben.ewb.model.cim.iec61968.metering.usage_point import UsagePoint
+from zepben.ewb.model.cim.iec61968.operations.operational_restriction import OperationalRestriction
+from zepben.ewb.model.cim.iec61970.base.auxiliaryequipment.current_transformer import CurrentTransformer
+from zepben.ewb.model.cim.iec61970.base.auxiliaryequipment.fault_indicator import FaultIndicator
+from zepben.ewb.model.cim.iec61970.base.auxiliaryequipment.potential_transformer import PotentialTransformer
+from zepben.ewb.model.cim.iec61970.base.core.base_voltage import BaseVoltage
+from zepben.ewb.model.cim.iec61970.base.core.connectivity_node import ConnectivityNode
+from zepben.ewb.model.cim.iec61970.base.core.feeder import Feeder
+from zepben.ewb.model.cim.iec61970.base.core.geographical_region import GeographicalRegion
+from zepben.ewb.model.cim.iec61970.base.core.sub_geographical_region import SubGeographicalRegion
+from zepben.ewb.model.cim.iec61970.base.core.substation import Substation
+from zepben.ewb.model.cim.iec61970.base.core.terminal import Terminal
+from zepben.ewb.model.cim.iec61970.base.equivalents.equivalent_branch import EquivalentBranch
+from zepben.ewb.model.cim.iec61970.base.generation.production.battery_unit import BatteryUnit
+from zepben.ewb.model.cim.iec61970.base.generation.production.photo_voltaic_unit import PhotoVoltaicUnit
+from zepben.ewb.model.cim.iec61970.base.generation.production.power_electronics_wind_unit import PowerElectronicsWindUnit
+from zepben.ewb.model.cim.iec61970.base.meas.accumulator import Accumulator
+from zepben.ewb.model.cim.iec61970.base.meas.analog import Analog
+from zepben.ewb.model.cim.iec61970.base.meas.control import Control
+from zepben.ewb.model.cim.iec61970.base.meas.discrete import Discrete
+from zepben.ewb.model.cim.iec61970.base.protection.current_relay import CurrentRelay
+from zepben.ewb.model.cim.iec61970.base.scada.remote_control import RemoteControl
+from zepben.ewb.model.cim.iec61970.base.scada.remote_source import RemoteSource
+from zepben.ewb.model.cim.iec61970.base.wires.ac_line_segment import AcLineSegment
+from zepben.ewb.model.cim.iec61970.base.wires.breaker import Breaker
+from zepben.ewb.model.cim.iec61970.base.wires.busbar_section import BusbarSection
+from zepben.ewb.model.cim.iec61970.base.wires.clamp import Clamp
+from zepben.ewb.model.cim.iec61970.base.wires.cut import Cut
+from zepben.ewb.model.cim.iec61970.base.wires.disconnector import Disconnector
+from zepben.ewb.model.cim.iec61970.base.wires.energy_consumer import EnergyConsumer
+from zepben.ewb.model.cim.iec61970.base.wires.energy_consumer_phase import EnergyConsumerPhase
+from zepben.ewb.model.cim.iec61970.base.wires.energy_source import EnergySource
+from zepben.ewb.model.cim.iec61970.base.wires.energy_source_phase import EnergySourcePhase
+from zepben.ewb.model.cim.iec61970.base.wires.fuse import Fuse
+from zepben.ewb.model.cim.iec61970.base.wires.ground import Ground
+from zepben.ewb.model.cim.iec61970.base.wires.ground_disconnector import GroundDisconnector
+from zepben.ewb.model.cim.iec61970.base.wires.grounding_impedance import GroundingImpedance
+from zepben.ewb.model.cim.iec61970.base.wires.jumper import Jumper
+from zepben.ewb.model.cim.iec61970.base.wires.junction import Junction
+from zepben.ewb.model.cim.iec61970.base.wires.linear_shunt_compensator import LinearShuntCompensator
+from zepben.ewb.model.cim.iec61970.base.wires.load_break_switch import LoadBreakSwitch
+from zepben.ewb.model.cim.iec61970.base.wires.per_length_phase_impedance import PerLengthPhaseImpedance
+from zepben.ewb.model.cim.iec61970.base.wires.per_length_sequence_impedance import PerLengthSequenceImpedance
+from zepben.ewb.model.cim.iec61970.base.wires.petersen_coil import PetersenCoil
+from zepben.ewb.model.cim.iec61970.base.wires.power_electronics_connection import PowerElectronicsConnection
+from zepben.ewb.model.cim.iec61970.base.wires.power_electronics_connection_phase import PowerElectronicsConnectionPhase
+from zepben.ewb.model.cim.iec61970.base.wires.power_transformer import PowerTransformer
+from zepben.ewb.model.cim.iec61970.base.wires.power_transformer_end import PowerTransformerEnd
+from zepben.ewb.model.cim.iec61970.base.wires.ratio_tap_changer import RatioTapChanger
+from zepben.ewb.model.cim.iec61970.base.wires.reactive_capability_curve import ReactiveCapabilityCurve
+from zepben.ewb.model.cim.iec61970.base.wires.recloser import Recloser
+from zepben.ewb.model.cim.iec61970.base.wires.series_compensator import SeriesCompensator
+from zepben.ewb.model.cim.iec61970.base.wires.static_var_compensator import StaticVarCompensator
+from zepben.ewb.model.cim.iec61970.base.wires.synchronous_machine import SynchronousMachine
+from zepben.ewb.model.cim.iec61970.base.wires.tap_changer_control import TapChangerControl
+from zepben.ewb.model.cim.iec61970.base.wires.transformer_star_impedance import TransformerStarImpedance
+from zepben.ewb.model.cim.iec61970.infiec61970.feeder.circuit import Circuit
+from zepben.ewb.services.network.network_service import NetworkService
+
+
+class NetworkServiceWriter(BaseServiceWriter):
+    """
+    A class for writing a `NetworkService` into the database.
+
+    :param service: The `NetworkService` to save to the database.
+    :param database_tables: The `NetworkDatabaseTables` to add to the database.
+    """
+
+    def __init__(
+        self,
+        service: NetworkService,
+        database_tables: NetworkDatabaseTables,
+        writer: NetworkCimWriter = None
+    ):
+        writer = writer if writer is not None else NetworkCimWriter(database_tables)
+        super().__init__(service, writer)
+
+        # This is not strictly necessary, it is just to update the type of the writer. It could be done with a generic
+        # on the base class which looks like it works, but that actually silently breaks code insight and completion
+        self._writer = writer
+
+    def _do_save(self) -> bool:
+        return all([
+            self._save_each_object(CableInfo, self._writer.save_cable_info),
+            self._save_each_object(OverheadWireInfo, self._writer.save_overhead_wire_info),
+            self._save_each_object(PowerTransformerInfo, self._writer.save_power_transformer_info),
+            self._save_each_object(TransformerTankInfo, self._writer.save_transformer_tank_info),
+            self._save_each_object(NoLoadTest, self._writer.save_no_load_test),
+            self._save_each_object(OpenCircuitTest, self._writer.save_open_circuit_test),
+            self._save_each_object(ShortCircuitTest, self._writer.save_short_circuit_test),
+            self._save_each_object(ShuntCompensatorInfo, self._writer.save_shunt_compensator_info),
+            self._save_each_object(SwitchInfo, self._writer.save_switch_info),
+            self._save_each_object(TransformerEndInfo, self._writer.save_transformer_end_info),
+            self._save_each_object(AssetOwner, self._writer.save_asset_owner),
+            self._save_each_object(Pole, self._writer.save_pole),
+            self._save_each_object(Streetlight, self._writer.save_streetlight),
+            self._save_each_object(Location, self._writer.save_location),
+            self._save_each_object(Organisation, self._writer.save_organisation),
+            self._save_each_object(Meter, self._writer.save_meter),
+            self._save_each_object(UsagePoint, self._writer.save_usage_point),
+            self._save_each_object(OperationalRestriction, self._writer.save_operational_restriction),
+            self._save_each_object(FaultIndicator, self._writer.save_fault_indicator),
+            self._save_each_object(BaseVoltage, self._writer.save_base_voltage),
+            self._save_each_object(ConnectivityNode, self._writer.save_connectivity_node),
+            self._save_each_object(Feeder, self._writer.save_feeder),
+            self._save_each_object(GeographicalRegion, self._writer.save_geographical_region),
+            self._save_each_object(Site, self._writer.save_site),
+            self._save_each_object(SubGeographicalRegion, self._writer.save_sub_geographical_region),
+            self._save_each_object(Substation, self._writer.save_substation),
+            self._save_each_object(Terminal, self._writer.save_terminal),
+            self._save_each_object(EquivalentBranch, self._writer.save_equivalent_branch),
+            self._save_each_object(BatteryUnit, self._writer.save_battery_unit),
+            self._save_each_object(PhotoVoltaicUnit, self._writer.save_photo_voltaic_unit),
+            self._save_each_object(PowerElectronicsWindUnit, self._writer.save_power_electronics_wind_unit),
+            self._save_each_object(AcLineSegment, self._writer.save_ac_line_segment),
+            self._save_each_object(Breaker, self._writer.save_breaker),
+            self._save_each_object(LoadBreakSwitch, self._writer.save_load_break_switch),
+            self._save_each_object(BusbarSection, self._writer.save_busbar_section),
+            self._save_each_object(Clamp, self._writer.save_clamp),
+            self._save_each_object(Cut, self._writer.save_cut),
+            self._save_each_object(Disconnector, self._writer.save_disconnector),
+            self._save_each_object(EnergyConsumer, self._writer.save_energy_consumer),
+            self._save_each_object(EnergyConsumerPhase, self._writer.save_energy_consumer_phase),
+            self._save_each_object(EnergySource, self._writer.save_energy_source),
+            self._save_each_object(EnergySourcePhase, self._writer.save_energy_source_phase),
+            self._save_each_object(Fuse, self._writer.save_fuse),
+            self._save_each_object(Jumper, self._writer.save_jumper),
+            self._save_each_object(Junction, self._writer.save_junction),
+            self._save_each_object(LinearShuntCompensator, self._writer.save_linear_shunt_compensator),
+            self._save_each_object(PerLengthPhaseImpedance, self._writer.save_per_length_phase_impedance),
+            self._save_each_object(PerLengthSequenceImpedance, self._writer.save_per_length_sequence_impedance),
+            self._save_each_object(PowerElectronicsConnection, self._writer.save_power_electronics_connection),
+            self._save_each_object(PowerElectronicsConnectionPhase, self._writer.save_power_electronics_connection_phase),
+            self._save_each_object(PowerTransformer, self._writer.save_power_transformer),
+            self._save_each_object(PowerTransformerEnd, self._writer.save_power_transformer_end),
+            self._save_each_object(RatioTapChanger, self._writer.save_ratio_tap_changer),
+            self._save_each_object(Recloser, self._writer.save_recloser),
+            self._save_each_object(TransformerStarImpedance, self._writer.save_transformer_star_impedance),
+            self._save_each_object(Circuit, self._writer.save_circuit),
+            self._save_each_object(Loop, self._writer.save_loop),
+            self._save_each_object(LvFeeder, self._writer.save_lv_feeder),
+            self._save_each_object(Analog, self._writer.save_analog),
+            self._save_each_object(Accumulator, self._writer.save_accumulator),
+            self._save_each_object(Discrete, self._writer.save_discrete),
+            self._save_each_object(Control, self._writer.save_control),
+            self._save_each_object(RemoteControl, self._writer.save_remote_control),
+            self._save_each_object(RemoteSource, self._writer.save_remote_source),
+            self._save_each_object(CurrentTransformerInfo, self._writer.save_current_transformer_info),
+            self._save_each_object(PotentialTransformerInfo, self._writer.save_potential_transformer_info),
+            self._save_each_object(CurrentTransformer, self._writer.save_current_transformer),
+            self._save_each_object(PotentialTransformer, self._writer.save_potential_transformer),
+            self._save_each_object(RelayInfo, self._writer.save_relay_info),
+            self._save_each_object(CurrentRelay, self._writer.save_current_relay),
+            self._save_each_object(TapChangerControl, self._writer.save_tap_changer_control),
+            self._save_each_object(EvChargingUnit, self._writer.save_ev_charging_unit),
+            self._save_each_object(DistanceRelay, self._writer.save_distance_relay),
+            self._save_each_object(ProtectionRelayScheme, self._writer.save_protection_relay_scheme),
+            self._save_each_object(ProtectionRelaySystem, self._writer.save_protection_relay_system),
+            self._save_each_object(VoltageRelay, self._writer.save_voltage_relay),
+            self._save_each_object(Ground, self._writer.save_ground),
+            self._save_each_object(GroundDisconnector, self._writer.save_ground_disconnector),
+            self._save_each_object(SeriesCompensator, self._writer.save_series_compensator),
+            self._save_each_object(SynchronousMachine, self._writer.save_synchronous_machine),
+            self._save_each_object(PetersenCoil, self._writer.save_petersen_coil),
+            self._save_each_object(GroundingImpedance, self._writer.save_grounding_impedance),
+            self._save_each_object(ReactiveCapabilityCurve, self._writer.save_reactive_capability_curve),
+            self._save_each_object(PanDemandResponseFunction, self._writer.save_pan_demand_response_function),
+            self._save_each_object(BatteryControl, self._writer.save_battery_control),
+            self._save_each_object(StaticVarCompensator, self._writer.save_static_var_compensator),
+        ])

zepben/ewb/database/sqlite/tables/__init__.py

@@ -0,0 +1,4 @@
+#  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/.

zepben/ewb/database/sqlite/tables/associations/__init__.py

@@ -0,0 +1,4 @@
+#  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/.

zepben/ewb/database/sqlite/tables/associations/loop_substation_relationship.py

@@ -0,0 +1,17 @@
+#  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/.
+
+__all__ = ["LoopSubstationRelationship"]
+
+from enum import Enum
+
+
+class LoopSubstationRelationship(Enum):
+    SUBSTATION_ENERGIZES_LOOP = 0
+    LOOP_ENERGIZES_SUBSTATION = 1
+
+    @property
+    def short_name(self):
+        return str(self)[27:]

zepben/ewb/database/sqlite/tables/associations/table_asset_organisation_roles_assets.py

@@ -0,0 +1,40 @@
+#  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/.
+
+__all__ = ["TableAssetOrganisationRolesAssets"]
+
+from typing import List, Generator
+
+from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sqlite.tables.sqlite_table import SqliteTable
+
+
+class TableAssetOrganisationRolesAssets(SqliteTable):
+    """
+    A class representing the association between AssetOrganisationRoles and Assets.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.asset_organisation_role_mrid: Column = self._create_column("asset_organisation_role_mrid", "TEXT", Nullable.NOT_NULL)
+        """A column storing the mRID of AssetOrganisationRoles."""
+
+        self.asset_mrid: Column = self._create_column("asset_mrid", "TEXT", Nullable.NOT_NULL)
+        """A column storing the mRID of Assets."""
+
+    @property
+    def name(self) -> str:
+        return "asset_organisation_roles_assets"
+
+    @property
+    def unique_index_columns(self) -> Generator[List[Column], None, None]:
+        yield from super().unique_index_columns
+        yield [self.asset_organisation_role_mrid, self.asset_mrid]
+
+    @property
+    def non_unique_index_columns(self) -> Generator[List[Column], None, None]:
+        yield from super().non_unique_index_columns
+        yield [self.asset_organisation_role_mrid]
+        yield [self.asset_mrid]

zepben/ewb/database/sqlite/tables/associations/table_assets_power_system_resources.py

@@ -0,0 +1,41 @@
+#  Copyright 2025 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/.
+
+__all__ = ["TableAssetsPowerSystemResources"]
+
+from typing import List, Generator
+
+from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sqlite.tables.sqlite_table import SqliteTable
+
+
+class TableAssetsPowerSystemResources(SqliteTable):
+    """
+    A class representing the association between AssetOrganisationRoles and Assets.
+    """
+
+    def __init__(self):
+        super().__init__()
+
+        self.asset_mrid: Column = self._create_column("asset_mrid", "TEXT", Nullable.NOT_NULL)
+        """A column storing the mRID of Assets."""
+
+        self.power_system_resource_mrid: Column = self._create_column("power_system_resource_mrid", "TEXT", Nullable.NOT_NULL)
+        """A column storing the mRID of PowerSystemResources."""
+
+    @property
+    def name(self) -> str:
+        return "assets_power_system_resources"
+
+    @property
+    def unique_index_columns(self) -> Generator[List[Column], None, None]:
+        yield from super().unique_index_columns
+        yield [self.asset_mrid, self.power_system_resource_mrid]
+
+    @property
+    def non_unique_index_columns(self) -> Generator[List[Column], None, None]:
+        yield from super().non_unique_index_columns
+        yield [self.asset_mrid]
+        yield [self.power_system_resource_mrid]

zepben/ewb/database/sqlite/tables/associations/table_battery_units_battery_controls.py

@@ -0,0 +1,40 @@
+#  Copyright 2025 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/.
+
+__all__ = ["TableBatteryUnitsBatteryControls"]
+
+from typing import List, Generator
+
+from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sqlite.tables.sqlite_table import SqliteTable
+
+
+class TableBatteryUnitsBatteryControls(SqliteTable):
+    """
+    A class representing the association between BatteryUnits and BatteryControls.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.battery_unit_mrid: Column = self._create_column("battery_unit_mrid", "TEXT", Nullable.NOT_NULL)
+        """A column storing the mRID of BatteryUnits."""
+
+        self.battery_control_mrid: Column = self._create_column("battery_control_mrid", "TEXT", Nullable.NOT_NULL)
+        """A column storing the mRID of BatteryControls."""
+
+    @property
+    def name(self) -> str:
+        return "battery_units_battery_controls"
+
+    @property
+    def unique_index_columns(self) -> Generator[List[Column], None, None]:
+        yield from super().unique_index_columns
+        yield [self.battery_unit_mrid, self.battery_control_mrid]
+
+    @property
+    def non_unique_index_columns(self) -> Generator[List[Column], None, None]:
+        yield from super().non_unique_index_columns
+        yield [self.battery_unit_mrid]
+        yield [self.battery_control_mrid]