CIM15/IEC61970/Informative/InfCustomers/PowerQualityPricing.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 # IN THE SOFTWARE.
  20
  21 from CIM15.IEC61968.Common.Document import Document
  22
  23 class PowerQualityPricing(Document):
  24     """Pricing can be based on power quality.Pricing can be based on power quality.
  25     """
  26
  27     def __init__(self, normalLowVoltLimit=0.0, valueUninterruptedServiceEnergy=0.0, voltLimitViolCost=0.0, normalHighVoltLimit=0.0, emergencyHighVoltLimit=0.0, emergencyLowVoltLimit=0.0, powerFactorMin=0.0, voltImbalanceViolCost=0.0, valueUninterruptedServiceP=0.0, *args, **kw_args):
  28         """Initialises a new 'PowerQualityPricing' instance.
  29
  30         @param normalLowVoltLimit: Normal low voltage limit.
  31         @param valueUninterruptedServiceEnergy: Value of uninterrupted service (Cost per energy).
  32         @param voltLimitViolCost: Voltage limit violation cost (Cost per unit Voltage).
  33         @param normalHighVoltLimit: Normal high voltage limit.
  34         @param emergencyHighVoltLimit: Emergency high voltage limit.
  35         @param emergencyLowVoltLimit: Emergency low voltage limit.
  36         @param powerFactorMin: Threshold minimum power factor for this PricingStructure, specified in instances where a special charge is levied if the actual power factor for a Service falls below the value specified here.
  37         @param voltImbalanceViolCost: Voltage imbalance violation cost (Cost per unit Voltage).
  38         @param valueUninterruptedServiceP: Value of uninterrupted service (Cost per active power).
  39         """
  40         #: Normal low voltage limit.
  41         self.normalLowVoltLimit = normalLowVoltLimit
  42
  43         #: Value of uninterrupted service (Cost per energy).
  44         self.valueUninterruptedServiceEnergy = valueUninterruptedServiceEnergy
  45
  46         #: Voltage limit violation cost (Cost per unit Voltage).
  47         self.voltLimitViolCost = voltLimitViolCost
  48
  49         #: Normal high voltage limit.
  50         self.normalHighVoltLimit = normalHighVoltLimit
  51
  52         #: Emergency high voltage limit.
  53         self.emergencyHighVoltLimit = emergencyHighVoltLimit
  54
  55         #: Emergency low voltage limit.
  56         self.emergencyLowVoltLimit = emergencyLowVoltLimit
  57
  58         #: Threshold minimum power factor for this PricingStructure, specified in instances where a special charge is levied if the actual power factor for a Service falls below the value specified here.
  59         self.powerFactorMin = powerFactorMin
  60
  61         #: Voltage imbalance violation cost (Cost per unit Voltage).
  62         self.voltImbalanceViolCost = voltImbalanceViolCost
  63
  64         #: Value of uninterrupted service (Cost per active power).
  65         self.valueUninterruptedServiceP = valueUninterruptedServiceP
  66
  67         super(PowerQualityPricing, self).__init__(*args, **kw_args)
  68
  69     _attrs = ["normalLowVoltLimit", "valueUninterruptedServiceEnergy", "voltLimitViolCost", "normalHighVoltLimit", "emergencyHighVoltLimit", "emergencyLowVoltLimit", "powerFactorMin", "voltImbalanceViolCost", "valueUninterruptedServiceP"]
  70     _attr_types = {"normalLowVoltLimit": float, "valueUninterruptedServiceEnergy": float, "voltLimitViolCost": float, "normalHighVoltLimit": float, "emergencyHighVoltLimit": float, "emergencyLowVoltLimit": float, "powerFactorMin": float, "voltImbalanceViolCost": float, "valueUninterruptedServiceP": float}
  71     _defaults = {"normalLowVoltLimit": 0.0, "valueUninterruptedServiceEnergy": 0.0, "voltLimitViolCost": 0.0, "normalHighVoltLimit": 0.0, "emergencyHighVoltLimit": 0.0, "emergencyLowVoltLimit": 0.0, "powerFactorMin": 0.0, "voltImbalanceViolCost": 0.0, "valueUninterruptedServiceP": 0.0}
  72     _enums = {}
  73     _refs = []
  74     _many_refs = []
  75