CIM15/IEC61970/Informative/InfLocations/LocationGrant.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.Agreement import Agreement
  22
  23 class LocationGrant(Agreement):
  24     """A grant provides a right, as defined by type, for a parcel of land. Note that the association to Location, Asset, Organisation, etc. for the Grant is inherited from Agreement, a type of Document.A grant provides a right, as defined by type, for a parcel of land. Note that the association to Location, Asset, Organisation, etc. for the Grant is inherited from Agreement, a type of Document.
  25     """
  26
  27     def __init__(self, propertyData='', LandProperty=None, *args, **kw_args):
  28         """Initialises a new 'LocationGrant' instance.
  29
  30         @param propertyData: Property related information that describes the Grant's land parcel. For example, it may be a deed book number, deed book page number, and parcel number.
  31         @param LandProperty: Land property this location grant applies to.
  32         """
  33         #: Property related information that describes the Grant's land parcel. For example, it may be a deed book number, deed book page number, and parcel number.
  34         self.propertyData = propertyData
  35
  36         self._LandProperty = None
  37         self.LandProperty = LandProperty
  38
  39         super(LocationGrant, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["propertyData"]
  42     _attr_types = {"propertyData": str}
  43     _defaults = {"propertyData": ''}
  44     _enums = {}
  45     _refs = ["LandProperty"]
  46     _many_refs = []
  47
  48     def getLandProperty(self):
  49         """Land property this location grant applies to.
  50         """
  51         return self._LandProperty
  52
  53     def setLandProperty(self, value):
  54         if self._LandProperty is not None:
  55             filtered = [x for x in self.LandProperty.LocationGrants if x != self]
  56             self._LandProperty._LocationGrants = filtered
  57
  58         self._LandProperty = value
  59         if self._LandProperty is not None:
  60             if self not in self._LandProperty._LocationGrants:
  61                 self._LandProperty._LocationGrants.append(self)
  62
  63     LandProperty = property(getLandProperty, setLandProperty)
  64