 | CktElement Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.CktElement"]
Inheritance HierarchyNamespace: dss_sharp
Assembly: dss_sharp (in dss_sharp.dll) Version: 1.0.0
SyntaxThe CktElement type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CktElement | Initializes a new instance of the CktElement class |
Properties| Name | Description | |
|---|---|---|
 | AllPropertyNames |
Array containing all property names of the active device.
|
| AllVariableNames |
Array of strings listing all the published variable names, if a PCElement. Otherwise, null string.
|
| AllVariableValues |
Array of doubles. Values of state variables of active element if PC element.
|
| BusNames |
Array of strings. Get Bus definitions to which each terminal is connected.
|
| CplxSeqCurrents |
Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.
|
| CplxSeqVoltages |
Complex double array of Sequence Voltage for all terminals of active circuit element.
|
| Currents |
Complex array of currents into each conductor of each terminal
|
| CurrentsMagAng |
Currents in magnitude, angle format as a array of doubles.
|
| DisplayName |
Display name of the object (not necessarily unique)
|
| EmergAmps |
Emergency Ampere Rating for PD elements
|
| Enabled |
Boolean indicating that element is currently in the circuit.
|
| EnergyMeter |
Name of the Energy Meter this element is assigned to.
|
| GUID |
globally unique identifier for this object
|
| Handle |
Pointer to this object
|
| HasOCPDevice |
True if a recloser, relay, or fuse controlling this ckt element. OCP = Overcurrent Protection
|
| HasSwitchControl |
This element has a SwtControl attached.
|
| HasVoltControl |
This element has a CapControl or RegControl attached.
|
| IsIsolated |
Returns true if the current active element is isolated.
Note that this only fetches the current value. See also the Topology interface.
|
| Losses |
Total losses in the element: two-element complex array
|
| Name |
Full Name of Active Circuit Element
|
| NodeOrder |
Array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal.
|
| NodeRef |
Array of integers, a copy of the internal NodeRef of the CktElement.
|
| NormalAmps |
Normal ampere rating for PD Elements
|
| NumConductors |
Number of Conductors per Terminal
|
| NumControls |
Number of controls connected to this device.
Use to determine valid range for index into Controller array.
|
| NumPhases |
Number of Phases
|
| NumProperties |
Number of Properties this Circuit Element.
|
| NumTerminals |
Number of Terminals this Circuit Element
|
| OCPDevIndex |
Index into Controller list of OCP Device controlling this CktElement
|
| OCPDevType |
0=None; 1=Fuse; 2=Recloser; 3=Relay; Type of OCP controller device
|
| PhaseLosses |
Complex array of losses by phase
|
| Powers |
Complex array of powers into each conductor of each terminal
|
| Residuals |
Residual currents for each terminal: (mag, angle)
|
| SeqCurrents |
Double array of symmetrical component currents into each 3-phase terminal
|
| SeqPowers |
Double array of sequence powers into each 3-phase teminal
|
| SeqVoltages |
Double array of symmetrical component voltages at each 3-phase terminal
|
| TotalPowers |
Returns the total powers (complex) at ALL terminals of the active circuit element.
|
| Voltages |
Complex array of voltages at terminals
|
| VoltagesMagAng |
Voltages at each conductor in magnitude, angle form as array of doubles.
|
| Yprim |
YPrim matrix, column order, complex numbers (paired)
|
Methods| Name | Description | |
|---|---|---|
 | CheckForError | (Inherited from ContextState.) |
| Close | |
| Controller |
Full name of the i-th controller attached to this element. Ex: str = Controller(2). See NumControls to determine valid index range
|
| Equals | (Inherited from Object.) |
| Finalize | (Inherited from Object.) |
| GetContextHandle |
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| IsOpen | |
| MemberwiseClone | (Inherited from Object.) |
| Open | |
| ToString | (Inherited from Object.) |
| Variable |
Value as return and error code in Code parameter. For PCElement, get the value of a variable by name. If Code>0 then no variable by this name or not a PCelement.
|
| VariableByIndex(Int32, Int32) |
Value as return and error code in Code parameter. For PCElement, get the value of a variable by integer index. If Code>0 then no variable by this index or not a PCelement.
|
| VariableByIndex(Int32, Int32, Double) |
Set the Value of a variable by indx if a PCElement. If Code>0 then no variable by this index or not a PCelement.
|
| VariableByName(String, Int32) |
Value as return and error code in Code parameter. For PCElement, get the value of a variable by name. If Code>0 then no variable by this name or not a PCelement.
|
| VariableByName(String, Int32, Double) |
Set the Value of a variable by name if a PCElement. If Code>0 then no variable by this name or not a PCelement.
|
| Variablei |
Value as return and error code in Code parameter. For PCElement, get the value of a variable by integer index. If Code>0 then no variable by this index or not a PCelement.
|
Fields| Name | Description | |
|---|---|---|
 | apiutil | (Inherited from ContextState.) |
| ctx | (Inherited from ContextState.) |
 | Properties |
See Also