Trees       Indices       Help   
PyCIM
Package CIM15 :: Package IEC61970 :: 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'.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, phases='s12N', connected=False, sequenceNumber=0, BushingInfo=None, TieFlow=None, HasSecond_MutualCoupling=None, OperationalLimitSet=None, Measurements=None, ConductingEquipment=None, RegulatingControl=None, HasFirst_MutualCoupling=None, AuxiliaryEquipment=None, TransformerEnd=None, ConnectivityNode=None, BranchGroupTerminal=None, BusNameMarker=None, SvPowerFlow=None, TopologicalNode=None, *args, **kw_args)
Initialises a new 'Terminal' instance.
 
addAuxiliaryEquipment(self, *AuxiliaryEquipment)
 
addBranchGroupTerminal(self, *BranchGroupTerminal)
 
addHasFirst_MutualCoupling(self, *HasFirst_MutualCoupling)
 
addHasSecond_MutualCoupling(self, *HasSecond_MutualCoupling)
 
addMeasurements(self, *Measurements)
 
addOperationalLimitSet(self, *OperationalLimitSet)
 
addRegulatingControl(self, *RegulatingControl)
 
addTieFlow(self, *TieFlow)
 
addTransformerEnd(self, *TransformerEnd)
 
getAuxiliaryEquipment(self)
 
getBranchGroupTerminal(self)
The directed branch group terminals for which the terminal is monitored.
 
getBusNameMarker(self)
The BusNameMarker used to name the bus (TopologicalNode) with the Terminal having the BusNameMarker.
 
getBushingInfo(self)
 
getConductingEquipment(self)
ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes
 
getConnectivityNode(self)
Terminals interconnect with zero impedance at a node.
 
getHasFirst_MutualCoupling(self)
Mutual couplings associated with the branch as the first branch.
 
getHasSecond_MutualCoupling(self)
Mutual couplings with the branch associated as the first branch.
 
getMeasurements(self)
One or more measurements may be associated with a terminal in the network.
 
getOperationalLimitSet(self)
The operatinal limits sets that applie specifically to this terminal.
 
getRegulatingControl(self)
The terminal is regulated by a control.
 
getSvPowerFlow(self)
The power flow state associated with the terminal.
 
getTieFlow(self)
The control area tie flows to which this terminal associates.
 
getTopologicalNode(self)
The topological node associated with the terminal.
 
getTransformerEnd(self)
All transformer ends connected at this external terminal.
 
removeAuxiliaryEquipment(self, *AuxiliaryEquipment)
 
removeBranchGroupTerminal(self, *BranchGroupTerminal)
 
removeHasFirst_MutualCoupling(self, *HasFirst_MutualCoupling)
 
removeHasSecond_MutualCoupling(self, *HasSecond_MutualCoupling)
 
removeMeasurements(self, *Measurements)
 
removeOperationalLimitSet(self, *OperationalLimitSet)
 
removeRegulatingControl(self, *RegulatingControl)
 
removeTieFlow(self, *TieFlow)
 
removeTransformerEnd(self, *TransformerEnd)
 
setAuxiliaryEquipment(self, value)
 
setBranchGroupTerminal(self, value)
 
setBusNameMarker(self, value)
 
setBushingInfo(self, value)
 
setConductingEquipment(self, value)
 
setConnectivityNode(self, value)
 
setHasFirst_MutualCoupling(self, value)
 
setHasSecond_MutualCoupling(self, value)
 
setMeasurements(self, value)
 
setOperationalLimitSet(self, value)
 
setRegulatingControl(self, value)
 
setSvPowerFlow(self, value)
 
setTieFlow(self, value)
 
setTopologicalNode(self, value)
 
setTransformerEnd(self, value)

Inherited from IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

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'>, 'phases': <type 'st...
  _attrs = ['phases', 'connected', 'sequenceNumber']
  _defaults = {'connected': False, 'phases': 's12N', 'sequenceNu...
  _enums = {'phases': 'PhaseCode'}
  _many_refs = ['TieFlow', 'HasSecond_MutualCoupling', 'Operatio...
  _refs = ['BushingInfo', 'TieFlow', 'HasSecond_MutualCoupling',...
Properties [hide private]
  AuxiliaryEquipment
  BranchGroupTerminal
The directed branch group terminals for which the terminal is monitored.
  BusNameMarker
The BusNameMarker used to name the bus (TopologicalNode) with the Terminal having the BusNameMarker.
  BushingInfo
  ConductingEquipment
ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes
  ConnectivityNode
Terminals interconnect with zero impedance at a node.
  HasFirst_MutualCoupling
Mutual couplings associated with the branch as the first branch.
  HasSecond_MutualCoupling
Mutual couplings with the branch associated as the first branch.
  Measurements
One or more measurements may be associated with a terminal in the network.
  OperationalLimitSet
The operatinal limits sets that applie specifically to this terminal.
  RegulatingControl
The terminal is regulated by a control.
  SvPowerFlow
The power flow state associated with the terminal.
  TieFlow
The control area tie flows to which this terminal associates.
  TopologicalNode
The topological node associated with the terminal.
  TransformerEnd
All transformer ends connected at this external terminal.

Inherited from IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, phases='s12N', connected=False, sequenceNumber=0, BushingInfo=None, TieFlow=None, HasSecond_MutualCoupling=None, OperationalLimitSet=None, Measurements=None, ConductingEquipment=None, RegulatingControl=None, HasFirst_MutualCoupling=None, AuxiliaryEquipment=None, TransformerEnd=None, ConnectivityNode=None, BranchGroupTerminal=None, BusNameMarker=None, SvPowerFlow=None, TopologicalNode=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'Terminal' instance.

Parameters:
  • phases - Represents the normal network phasing condition. Values are: "s12N", "BN", "BC", "ABN", "s2N", "N", "ACN", "BCN", "ABCN", "AC", "s1N", "AN", "B", "AB", "C", "A", "CN", "ABC"
  • 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.
  • sequenceNumber - The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the 'starting point' for a two terminal branch. In the case of class TransformerWinding only one terminal is used so its sequenceNumber must be 1.
  • BushingInfo
  • TieFlow - The control area tie flows to which this terminal associates.
  • HasSecond_MutualCoupling - Mutual couplings with the branch associated as the first branch.
  • OperationalLimitSet - The operatinal limits sets that applie specifically to this terminal. Other operational limits sets may apply to this terminal through the association to Equipment.
  • Measurements - One or more measurements may be associated with a terminal in the network. Measurement-Terminal defines where the measurement is placed in the network topology. Some Measurements represent quantities related to a particular sensor position, e.g. a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. The sensing position is captured by the Measurement - Terminal association that makes it possible to place the sensing position at a well defined place. The place is defined by the connection of the Terminal to ConductingEquipment.
  • ConductingEquipment - ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes
  • RegulatingControl - The terminal is regulated by a control.
  • HasFirst_MutualCoupling - Mutual couplings associated with the branch as the first branch.
  • AuxiliaryEquipment
  • TransformerEnd - All transformer ends connected at this external terminal.
  • ConnectivityNode - Terminals interconnect with zero impedance at a node. Measurements on a node apply to all of its terminals.
  • BranchGroupTerminal - The directed branch group terminals for which the terminal is monitored.
  • BusNameMarker - The BusNameMarker used to name the bus (TopologicalNode) with the Terminal having the BusNameMarker. A bus typically have multiple Terminals connected and in of normal topologies Terminals with different BusNameMarker may be connected to the bus. In such cases the BusNameMarker can be arbitrarily selected.
  • SvPowerFlow - The power flow state associated with the terminal.
  • 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__

getBusNameMarker(self)

 

The BusNameMarker used to name the bus (TopologicalNode) with the Terminal having the BusNameMarker. A bus typically have multiple Terminals connected and in of normal topologies Terminals with different BusNameMarker may be connected to the bus. In such cases the BusNameMarker can be arbitrarily selected.

getConnectivityNode(self)

 

Terminals interconnect with zero impedance at a node. Measurements on a node apply to all of its terminals.

getMeasurements(self)

 

One or more measurements may be associated with a terminal in the network. Measurement-Terminal defines where the measurement is placed in the network topology. Some Measurements represent quantities related to a particular sensor position, e.g. a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. The sensing position is captured by the Measurement - Terminal association that makes it possible to place the sensing position at a well defined place. The place is defined by the connection of the Terminal to ConductingEquipment.

getOperationalLimitSet(self)

 

The operatinal limits sets that applie specifically to this terminal. Other operational limits sets may apply to this terminal through the association to Equipment.

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.


Class Variable Details [hide private]

_attr_types

Value:
{'connected': <type 'bool'>,
 'phases': <type 'str'>,
 'sequenceNumber': <type 'int'>}

_defaults

Value:
{'connected': False, 'phases': 's12N', 'sequenceNumber': 0}

_many_refs

Value:
['TieFlow',
 'HasSecond_MutualCoupling',
 'OperationalLimitSet',
 'Measurements',
 'RegulatingControl',
 'HasFirst_MutualCoupling',
 'AuxiliaryEquipment',
 'TransformerEnd',
...

_refs

Value:
['BushingInfo',
 'TieFlow',
 'HasSecond_MutualCoupling',
 'OperationalLimitSet',
 'Measurements',
 'ConductingEquipment',
 'RegulatingControl',
 'HasFirst_MutualCoupling',
...

Property Details [hide private]

AuxiliaryEquipment

Get Method:
getAuxiliaryEquipment(self)
Set Method:
setAuxiliaryEquipment(self, value)

BranchGroupTerminal

The directed branch group terminals for which the terminal is monitored.

Get Method:
getBranchGroupTerminal(self) - The directed branch group terminals for which the terminal is monitored.
Set Method:
setBranchGroupTerminal(self, value)

BusNameMarker

The BusNameMarker used to name the bus (TopologicalNode) with the Terminal having the BusNameMarker. A bus typically have multiple Terminals connected and in of normal topologies Terminals with different BusNameMarker may be connected to the bus. In such cases the BusNameMarker can be arbitrarily selected.

Get Method:
getBusNameMarker(self) - The BusNameMarker used to name the bus (TopologicalNode) with the Terminal having the BusNameMarker.
Set Method:
setBusNameMarker(self, value)

BushingInfo

Get Method:
getBushingInfo(self)
Set Method:
setBushingInfo(self, value)

ConductingEquipment

ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes

Get Method:
getConductingEquipment(self) - ConductingEquipment has 1 or 2 terminals that may be connected to other ConductingEquipment terminals via ConnectivityNodes
Set Method:
setConductingEquipment(self, value)

ConnectivityNode

Terminals interconnect with zero impedance at a node. Measurements on a node apply to all of its terminals.

Get Method:
getConnectivityNode(self) - Terminals interconnect with zero impedance at a node.
Set Method:
setConnectivityNode(self, value)

HasFirst_MutualCoupling

Mutual couplings associated with the branch as the first branch.

Get Method:
getHasFirst_MutualCoupling(self) - Mutual couplings associated with the branch as the first branch.
Set Method:
setHasFirst_MutualCoupling(self, value)

HasSecond_MutualCoupling

Mutual couplings with the branch associated as the first branch.

Get Method:
getHasSecond_MutualCoupling(self) - Mutual couplings with the branch associated as the first branch.
Set Method:
setHasSecond_MutualCoupling(self, value)

Measurements

One or more measurements may be associated with a terminal in the network. Measurement-Terminal defines where the measurement is placed in the network topology. Some Measurements represent quantities related to a particular sensor position, e.g. a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. The sensing position is captured by the Measurement - Terminal association that makes it possible to place the sensing position at a well defined place. The place is defined by the connection of the Terminal to ConductingEquipment.

Get Method:
getMeasurements(self) - One or more measurements may be associated with a terminal in the network.
Set Method:
setMeasurements(self, value)

OperationalLimitSet

The operatinal limits sets that applie specifically to this terminal. Other operational limits sets may apply to this terminal through the association to Equipment.

Get Method:
getOperationalLimitSet(self) - The operatinal limits sets that applie specifically to this terminal.
Set Method:
setOperationalLimitSet(self, value)

RegulatingControl

The terminal is regulated by a control.

Get Method:
getRegulatingControl(self) - The terminal is regulated by a control.
Set Method:
setRegulatingControl(self, value)

SvPowerFlow

The power flow state associated with the terminal.

Get Method:
getSvPowerFlow(self) - The power flow state associated with the terminal.
Set Method:
setSvPowerFlow(self, value)

TieFlow

The control area tie flows to which this terminal associates.

Get Method:
getTieFlow(self) - The control area tie flows to which this terminal associates.
Set Method:
setTieFlow(self, value)

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)

TransformerEnd

All transformer ends connected at this external terminal.

Get Method:
getTransformerEnd(self) - All transformer ends connected at this external terminal.
Set Method:
setTransformerEnd(self, value)

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