def get_terminal_by_mrid(self, mrid: str) -> Terminal:
"""
Get the `zepben.evolve.iec61970.base.core.terminal.Terminal` for this `ConductingEquipment` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.cim.iec61970.base.core.terminal.Terminal`
Returns The `zepben.evolve.cim.iec61970.base.core.terminal.Terminal` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._terminals, mrid)
def get_sub_geographical_region(self, mrid: str) -> SubGeographicalRegion:
"""
Get the `SubGeographicalRegion` for this `GeographicalRegion` identified by `mrid`
`mrid` The mRID of the required `SubGeographicalRegion`
Returns The `SubGeographicalRegion` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._sub_geographical_regions, mrid)
def get_agreement(self, mrid: str) -> CustomerAgreement:
"""
Get the `zepben.evolve.cim.iec61968.customers.customer_agreement.CustomerAgreement` for this `Customer` identified by `mrid`.
`mrid` the mRID of the required `customer_agreement.CustomerAgreement`
Returns the `zepben.evolve.cim.iec61968.customers.customer_agreement.CustomerAgreement` with the specified `mrid`.
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._customer_agreements, mrid)
def get_feeder(self, mrid: str) -> Substation:
"""
Get the `zepben.evolve.cim.iec61970.base.core.equipment_container.Feeder` for this `Substation` identified by `mrid`
`mrid` The mRID of the required `zepben.evolve.cim.iec61970.base.core.equipment_container.Feeder`
Returns The `zepben.evolve.cim.iec61970.base.core.equipment_container.Feeder` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._normal_energized_feeders, mrid)
def get_substation(self, mrid: str) -> Substation:
"""
Get the `zepben.evolve.iec61970.base.core.substation.Substation` for this `SubGeographicalRegion` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.iec61970.base.core.substation.Substation`
Returns The `zepben.evolve.iec61970.base.core.substation.Substation` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._substations, mrid)
def get_pricing_structure(self, mrid: str) -> PricingStructure:
"""
Get the `zepben.evolve.cim.iec61968.customers.pricing_structure.PricingStructure` for this `CustomerAgreement` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.cim.iec61968.customers.pricing_structure.PricingStructure`
Returns the `zepben.evolve.cim.iec61968.customers.pricing_structure.PricingStructure` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._pricing_structures, mrid)
def get_circuit(self, mrid: str) -> Substation:
"""
Get the `zepben.evolve.cim.infiec61970.feeder.circuit.Circuit` for this `Substation` identified by `mrid`
`mrid` The mRID of the required `zepben.evolve.cim.infiec61970.feeder.circuit.Circuit`
Returns The `zepben.evolve.cim.infiec61970.feeder.circuit.Circuit` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._circuits, mrid)
def get_equipment(self, mrid: str) -> Equipment:
"""
Get the `zepben.evolve.cim.iec61970.base.core.equipment.Equipment` for this `UsagePoint` identified by `mrid`
`mrid` The mRID of the required `zepben.evolve.cim.iec61970.base.core.equipment.Equipment`
Returns The `zepben.evolve.cim.iec61970.base.core.equipment.Equipment` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._equipment, mrid)
def get_end_device(self, mrid: str) -> EndDevice:
"""
Get the `EndDevice` for this `UsagePoint` identified by `mrid`
`mrid` The mRID of the required `zepben.evolve.cim.iec61968.metering.metering.EndDevice`
Returns The `zepben.evolve.cim.iec61968.metering.metering.EndDevice` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._end_devices, mrid)
def get_tariff(self, mrid: str) -> Tariff:
"""
Get the `zepben.evolve.cim.iec61968.customers.tariff.Tariff` for this `PricingStructure` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.cim.iec61968.customers.tariff.Tariff`
Returns The `zepben.evolve.cim.iec61968.customers.tariff.Tariff` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._tariffs, mrid)
def get_phase(self, mrid: str) -> EnergySource:
"""
Get the `zepben.evolve.cim.iec61970.base.wires.energy_source_phase.EnergySourcePhase` for this `EnergySource` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.cim.iec61970.base.wires.energy_source_phase.EnergySourcePhase`
Returns The `zepben.evolve.cim.iec61970.base.wires.energy_source_phase.EnergySourcePhase` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._energy_source_phases, mrid)
def get_streetlight(self, mrid: str) -> Streetlight:
"""
Get the `zepben.evolve.cim.iec61968.assets.streetlight.Streetlight` for this asset identified by `mrid`.
`mrid` the mRID of the required `zepben.evolve.cim.iec61968.assets.streetlight.Streetlight`
Returns The `zepben.evolve.cim.iec61968.assets.streetlight.Streetlight` with the specified `mrid`.
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._streetlights, mrid)
def get_restriction(self, mrid: str) -> OperationalRestriction:
"""
Get the `zepben.evolve.cim.iec61968.operations.operational_restriction.OperationalRestriction` for this `Equipment` identified by `mrid`
`mrid` The mRID of the required `zepben.evolve.cim.iec61968.operations.operational_restriction.OperationalRestriction`
Returns The `zepben.evolve.cim.iec61968.operations.operational_restriction.OperationalRestriction` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._operational_restrictions, mrid)
def get_energizing_substation(self, mrid: str) -> Loop:
"""
Get the `zepben.evolve.cim.iec61970.base.core.substation.Substation` for this `Loop` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.cim.iec61970.base.core.substation.Substation`
Returns The `zepben.evolve.cim.iec61970.base.core.substation.Substation` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._energizing_substations, mrid)
def get_phase(self, mrid: str) -> EnergyConsumer:
"""
Get the `EnergyConsumerPhase` for this `EnergyConsumer` identified by `mrid`
`mrid` The mRID of the required `EnergyConsumerPhase`
Returns The `EnergyConsumerPhase` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._energy_consumer_phases, mrid)
def get_usage_point(self, mrid: str) -> UsagePoint:
"""
Get the `UsagePoint` for this `EndDevice` identified by `mrid`
`mrid` the mRID of the required `zepben.evolve.cim.iec61968.metering.metering.UsagePoint`
Returns The `zepben.evolve.cim.iec61968.metering.metering.UsagePoint` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._usage_points, mrid)
def get_end_by_mrid(self, mrid: str) -> PowerTransformerEnd:
"""
Get the `PowerTransformerEnd` for this `PowerTransformer` identified by `mrid`
`mrid` the mRID of the required `PowerTransformerEnd`
Returns The `PowerTransformerEnd` with the specified `mrid` if it exists
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._power_transformer_ends, mrid)
def get_organisation_role(self, mrid: str) -> AssetOrganisationRole:
"""
Get the `AssetOrganisationRole` for this asset identified by `mrid`.
`mrid` the mRID of the required `zepben.evolve.cim.iec61968.assets.asset_organisation_role.AssetOrganisationRole`
Returns The `zepben.evolve.cim.iec61968.assets.asset_organisation_role.AssetOrganisationRole` with the specified `mrid`.
Raises `KeyError` if `mrid` wasn't present.
"""
return get_by_mrid(self._organisation_roles, mrid)
