Trees       Indices       Help   
PyCIM
Package CIM14 :: Package CPSM :: Package Topology :: Package Core :: Module Terminal' :: Class Terminal
[hide private]
[frames] | no frames]

Class Terminal

                    object --+        
                             |        
              Element'.Element --+    
                                 |    
IdentifiedObject'.IdentifiedObject --+
                                     |
                                    Terminal

An electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called 'connectivity nodes'.

Instance Methods [hide private]
 
__init__(self, connected=False, TopologicalNode=None, *args, **kw_args)
Initialises a new 'Terminal' instance.
 
getTopologicalNode(self)
The topological node associated with the terminal.
 
setTopologicalNode(self, value)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'connected': <type 'bool'>}
  _attrs = ['connected']
  _defaults = {'connected': False}
  _refs = ['TopologicalNode']

Inherited from Element'.Element (private): _enums, _many_refs

Properties [hide private]
  TopologicalNode
The topological node associated with the terminal.

Inherited from object: __class__

Method Details [hide private]

__init__(self, connected=False, TopologicalNode=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Terminal' instance.

Parameters:
  • connected - The connected status is related to a bus-branch model and the TopologicalNode-Terminal relation. True implies the Terminal is connected to the related TopologicalNode and false implies it is not. In a bus-branch model the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the TopologicalNode-Terminal relation. A valid case is that ConductingEquipment can be connected in one end and open in the other. In particular for an ACLineSegment where the charging can be significant this is a relevant case.
  • TopologicalNode - The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unneccesary to model connedtivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would proably not be used.
Overrides: object.__init__

getTopologicalNode(self)

 

The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unneccesary to model connedtivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would proably not be used.


Property Details [hide private]

TopologicalNode

The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unneccesary to model connedtivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would proably not be used.

Get Method:
getTopologicalNode(self) - The topological node associated with the terminal.
Set Method:
setTopologicalNode(self, value)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Jul 2 18:27:36 2011 http://epydoc.sourceforge.net