CIM14/ENTSOE/Equipment/Core/IdentifiedObject.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 CIM14.ENTSOE.Equipment.Element import Element
  22
  23 class IdentifiedObject(Element):
  24     """This is a root class to provide common naming attributes for all classes needing naming attributes
  25     """
  26
  27     def __init__(self, description='', name='', aliasName='', pathName='', *args, **kw_args):
  28         """Initialises a new 'IdentifiedObject' instance.
  29
  30         @param description: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.
  31         @param name: The name is a free text human readable name of the object. It may be non unique and may not correlate to a naming hierarchy.The name attribute is required except for the following classes:   FossilFuel, HydorPump, LoadResponseCharacteristic, MutualCoupling, ReactiveCapabilityCurve, RegulatingControl, SynchronousMachine, TopologicalIsland, ConductingEquipment, Conductor, ConnectivityNodeContainer, Curve, Equipment, EquipmentContainer, EquivalentEquipment, REgulatingCondEq, TapChanger, BaseVoltage, Terminal, TransformerWinding, RatioTapChanger, PhaseTapChanger, OperationalLimitSet, CurrentLimit, and VoltageLimit.
  32         @param aliasName: The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
  33         @param pathName: The pathname is a system unique name composed from all IdentifiedObject.localNames in a naming hierarchy path from the object to the root.
  34         """
  35         #: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.
  36         self.description = description
  37
  38         #: The name is a free text human readable name of the object. It may be non unique and may not correlate to a naming hierarchy.The name attribute is required except for the following classes:   FossilFuel, HydorPump, LoadResponseCharacteristic, MutualCoupling, ReactiveCapabilityCurve, RegulatingControl, SynchronousMachine, TopologicalIsland, ConductingEquipment, Conductor, ConnectivityNodeContainer, Curve, Equipment, EquipmentContainer, EquivalentEquipment, REgulatingCondEq, TapChanger, BaseVoltage, Terminal, TransformerWinding, RatioTapChanger, PhaseTapChanger, OperationalLimitSet, CurrentLimit, and VoltageLimit.
  39         self.name = name
  40
  41         #: The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
  42         self.aliasName = aliasName
  43
  44         #: The pathname is a system unique name composed from all IdentifiedObject.localNames in a naming hierarchy path from the object to the root.
  45         self.pathName = pathName
  46
  47         super(IdentifiedObject, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["description", "name", "aliasName", "pathName"]
  50     _attr_types = {"description": str, "name": str, "aliasName": str, "pathName": str}
  51     _defaults = {"description": '', "name": '', "aliasName": '', "pathName": ''}
  52     _enums = {}
  53     _refs = []
  54     _many_refs = []
  55