CIM15/IEC61968/Customers/ServiceCategory.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.IEC61970.Core.IdentifiedObject import IdentifiedObject
  22
  23 class ServiceCategory(IdentifiedObject):
  24     """Category of service provided to the customer.Category of service provided to the customer.
  25     """
  26
  27     def __init__(self, kind="other", PricingStructures=None, ServiceDeliveryPoints=None, *args, **kw_args):
  28         """Initialises a new 'ServiceCategory' instance.
  29
  30         @param kind: Kind of service. Values are: "other", "refuse", "sewerage", "electricity", "heat", "internet", "rates", "time", "water", "gas", "tvLicence"
  31         @param PricingStructures: All pricing structures applicable to this service category.
  32         @param ServiceDeliveryPoints: All service delivery points that deliver this category of service.
  33         """
  34         #: Kind of service. Values are: "other", "refuse", "sewerage", "electricity", "heat", "internet", "rates", "time", "water", "gas", "tvLicence"
  35         self.kind = kind
  36
  37         self._PricingStructures = []
  38         self.PricingStructures = [] if PricingStructures is None else PricingStructures
  39
  40         self._ServiceDeliveryPoints = []
  41         self.ServiceDeliveryPoints = [] if ServiceDeliveryPoints is None else ServiceDeliveryPoints
  42
  43         super(ServiceCategory, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["kind"]
  46     _attr_types = {"kind": str}
  47     _defaults = {"kind": "other"}
  48     _enums = {"kind": "ServiceKind"}
  49     _refs = ["PricingStructures", "ServiceDeliveryPoints"]
  50     _many_refs = ["PricingStructures", "ServiceDeliveryPoints"]
  51
  52     def getPricingStructures(self):
  53         """All pricing structures applicable to this service category.
  54         """
  55         return self._PricingStructures
  56
  57     def setPricingStructures(self, value):
  58         for x in self._PricingStructures:
  59             x.ServiceCategory = None
  60         for y in value:
  61             y._ServiceCategory = self
  62         self._PricingStructures = value
  63
  64     PricingStructures = property(getPricingStructures, setPricingStructures)
  65
  66     def addPricingStructures(self, *PricingStructures):
  67         for obj in PricingStructures:
  68             obj.ServiceCategory = self
  69
  70     def removePricingStructures(self, *PricingStructures):
  71         for obj in PricingStructures:
  72             obj.ServiceCategory = None
  73
  74     def getServiceDeliveryPoints(self):
  75         """All service delivery points that deliver this category of service.
  76         """
  77         return self._ServiceDeliveryPoints
  78
  79     def setServiceDeliveryPoints(self, value):
  80         for x in self._ServiceDeliveryPoints:
  81             x.ServiceCategory = None
  82         for y in value:
  83             y._ServiceCategory = self
  84         self._ServiceDeliveryPoints = value
  85
  86     ServiceDeliveryPoints = property(getServiceDeliveryPoints, setServiceDeliveryPoints)
  87
  88     def addServiceDeliveryPoints(self, *ServiceDeliveryPoints):
  89         for obj in ServiceDeliveryPoints:
  90             obj.ServiceCategory = self
  91
  92     def removeServiceDeliveryPoints(self, *ServiceDeliveryPoints):
  93         for obj in ServiceDeliveryPoints:
  94             obj.ServiceCategory = None
  95