Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Generation / Production / PenstockLossCurve.py
blob591d46cbef68e5cb775f774abf0c3ccc42d91fb7
1 # Copyright (C) 2010-2011 Richard Lincoln
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:
10 # The above copyright notice and this permission notice shall be included in
11 # all copies or substantial portions of the Software.
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.
21 from CIM14.IEC61970.Core.Curve import Curve
23 class PenstockLossCurve(Curve):
24 """Relationship between penstock head loss (in meters) and total discharge through the penstock (in cubic meters per second). One or more turbines may be connected to the same penstock.
25 """
27 def __init__(self, HydroGeneratingUnit=None, *args, **kw_args):
28 """Initialises a new 'PenstockLossCurve' instance.
30 @param HydroGeneratingUnit: A hydro generating unit has a penstock loss curve
31 """
32 self._HydroGeneratingUnit = None
33 self.HydroGeneratingUnit = HydroGeneratingUnit
35 super(PenstockLossCurve, self).__init__(*args, **kw_args)
37 _attrs = []
38 _attr_types = {}
39 _defaults = {}
40 _enums = {}
41 _refs = ["HydroGeneratingUnit"]
42 _many_refs = []
44 def getHydroGeneratingUnit(self):
45 """A hydro generating unit has a penstock loss curve
46 """
47 return self._HydroGeneratingUnit
49 def setHydroGeneratingUnit(self, value):
50 if self._HydroGeneratingUnit is not None:
51 self._HydroGeneratingUnit._PenstockLossCurve = None
53 self._HydroGeneratingUnit = value
54 if self._HydroGeneratingUnit is not None:
55 self._HydroGeneratingUnit.PenstockLossCurve = None
56 self._HydroGeneratingUnit._PenstockLossCurve = self
58 HydroGeneratingUnit = property(getHydroGeneratingUnit, setHydroGeneratingUnit)