CIM14/CDPSM/Balanced/IEC61968/AssetModels/CableInfo.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.CDPSM.Balanced.IEC61968.AssetModels.ConductorInfo import ConductorInfo
  22
  23 class CableInfo(ConductorInfo):
  24     """Cable data.
  25     """
  26
  27     def __init__(self, nominalTemperature=0.0, diameterOverScreen=0.0, sheathAsNeutral=False, diameterOverJacket=0.0, diameterOverCore=0.0, constructionKind="solid", outerJacketKind="insulating", isStrandFill=False, shieldMaterial="other", diameterOverInsulation=0.0, *args, **kw_args):
  28         """Initialises a new 'CableInfo' instance.
  29
  30         @param nominalTemperature: Maximum nominal design operating temperature.
  31         @param diameterOverScreen: Diameter over the outer screen; should be the shield's inside diameter..
  32         @param sheathAsNeutral: True if sheath / shield is used as a neutral (i.e., bonded).
  33         @param diameterOverJacket: Diameter over the outermost jacketing layer.
  34         @param diameterOverCore: Diameter over the core, including any semi-con screen; should be the insulating layer's inside diameter.
  35         @param constructionKind: Kind of construction of this cable. Values are: "solid", "stranded", "other", "segmental", "compacted", "sector", "compressed"
  36         @param outerJacketKind: Kind of outer jacket of this cable. Values are: "insulating", "other", "semiconducting", "polyethylene", "none", "linearLowDensityPolyethylene", "pvc"
  37         @param isStrandFill: True if wire strands are extruded in a way to fill the voids in the cable.
  38         @param shieldMaterial: Material of the shield. Values are: "other", "lead", "steel", "aluminum", "copper"
  39         @param diameterOverInsulation: Diameter over the insulating layer, excluding outer screen.
  40         """
  41         #: Maximum nominal design operating temperature.
  42         self.nominalTemperature = nominalTemperature
  43
  44         #: Diameter over the outer screen; should be the shield's inside diameter..
  45         self.diameterOverScreen = diameterOverScreen
  46
  47         #: True if sheath / shield is used as a neutral (i.e., bonded).
  48         self.sheathAsNeutral = sheathAsNeutral
  49
  50         #: Diameter over the outermost jacketing layer.
  51         self.diameterOverJacket = diameterOverJacket
  52
  53         #: Diameter over the core, including any semi-con screen; should be the insulating layer's inside diameter.
  54         self.diameterOverCore = diameterOverCore
  55
  56         #: Kind of construction of this cable. Values are: "solid", "stranded", "other", "segmental", "compacted", "sector", "compressed"
  57         self.constructionKind = constructionKind
  58
  59         #: Kind of outer jacket of this cable. Values are: "insulating", "other", "semiconducting", "polyethylene", "none", "linearLowDensityPolyethylene", "pvc"
  60         self.outerJacketKind = outerJacketKind
  61
  62         #: True if wire strands are extruded in a way to fill the voids in the cable.
  63         self.isStrandFill = isStrandFill
  64
  65         #: Material of the shield. Values are: "other", "lead", "steel", "aluminum", "copper"
  66         self.shieldMaterial = shieldMaterial
  67
  68         #: Diameter over the insulating layer, excluding outer screen.
  69         self.diameterOverInsulation = diameterOverInsulation
  70
  71         super(CableInfo, self).__init__(*args, **kw_args)
  72
  73     _attrs = ["nominalTemperature", "diameterOverScreen", "sheathAsNeutral", "diameterOverJacket", "diameterOverCore", "constructionKind", "outerJacketKind", "isStrandFill", "shieldMaterial", "diameterOverInsulation"]
  74     _attr_types = {"nominalTemperature": float, "diameterOverScreen": float, "sheathAsNeutral": bool, "diameterOverJacket": float, "diameterOverCore": float, "constructionKind": str, "outerJacketKind": str, "isStrandFill": bool, "shieldMaterial": str, "diameterOverInsulation": float}
  75     _defaults = {"nominalTemperature": 0.0, "diameterOverScreen": 0.0, "sheathAsNeutral": False, "diameterOverJacket": 0.0, "diameterOverCore": 0.0, "constructionKind": "solid", "outerJacketKind": "insulating", "isStrandFill": False, "shieldMaterial": "other", "diameterOverInsulation": 0.0}
  76     _enums = {"constructionKind": "CableConstructionKind", "outerJacketKind": "CableOuterJacketKind", "shieldMaterial": "CableShieldMaterialKind"}
  77     _refs = []
  78     _many_refs = []
  79