 | Circuit Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.Circuit"]
Inheritance HierarchyNamespace: dss_sharp
Assembly: dss_sharp (in dss_sharp.dll) Version: 1.0.0
SyntaxThe Circuit type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AllBusDistances |
Returns distance from each bus to parent EnergyMeter. Corresponds to sequence in AllBusNames.
|
| AllBusNames |
Array of strings containing names of all buses in circuit (see AllNodeNames).
|
| AllBusVmag |
Array of magnitudes (doubles) of voltages at all buses
|
| AllBusVmagPu |
Double Array of all bus voltages (each node) magnitudes in Per unit
|
| AllBusVolts |
Complex array of all bus, node voltages from most recent solution
|
| AllElementLosses |
Array of total losses (complex) in each circuit element
|
| AllElementNames |
Array of strings containing Full Name of all elements.
|
| AllNodeDistances |
Returns an array of distances from parent EnergyMeter for each Node. Corresponds to AllBusVMag sequence.
|
| AllNodeNames |
Array of strings containing full name of each node in system in same order as returned by AllBusVolts, etc.
|
| LineLosses |
Complex total line losses in the circuit
|
| Losses |
Total losses in active circuit, complex number (two-element array of double).
|
| Name |
Name of the active circuit.
|
| NumBuses |
Total number of Buses in the circuit.
|
| NumCktElements |
Number of CktElements in the circuit.
|
| NumNodes |
Total number of nodes in the circuit.
|
| ParentPDElement |
Sets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.
|
| SubstationLosses |
Complex losses in all transformers designated to substations.
|
| SystemY |
System Y matrix (after a solution has been performed).
This is deprecated as it returns a dense matrix. Only use it for small systems.
For large scale systems, prefer YMatrix.GetCompressedYMatrix.
|
| TotalPower |
Total power, kW delivered to the circuit
|
| YCurrents |
Array of doubles containing complex injection currents for the present solution. Is is the "I" vector of I=YV
|
| YNodeOrder |
Array of strings containing the names of the nodes in the same order as the Y matrix
|
| YNodeVarray |
Complex array of actual node voltages in same order as SystemY matrix.
|
Methods| Name | Description | |
|---|---|---|
 | AllNodeDistancesByPhase |
Returns an array of doubles representing the distances to parent EnergyMeter. Sequence of array corresponds to other node ByPhase properties.
|
| AllNodeNamesByPhase |
Return array of strings of the node names for the By Phase criteria. Sequence corresponds to other ByPhase properties.
|
| AllNodeVmagByPhase |
Returns Array of doubles represent voltage magnitudes for nodes on the specified phase.
|
| AllNodeVmagPUByPhase |
Returns array of per unit voltage magnitudes for each node by phase
|
| Capacity | |
 | CheckForError | (Inherited from ContextState.) |
| Disable | |
| ElementLosses |
Array of total losses (complex) in a selection of elements.
Use the element indices (starting at 1) as parameter.
(API Extension)
|
| Enable | |
| EndOfTimeStepUpdate | |
| Equals | (Inherited from Object.) |
| Finalize | (Inherited from Object.) |
| FirstElement | |
| FirstPCElement | |
| FirstPDElement | |
| get_Buses(Int32) |
Activates and returns a bus by its (zero-based) index.
|
| get_Buses(String) |
Activates and returns a bus by its name.
|
| get_CktElements(Int32) |
Activates and returns a CktElement by its global (zero-based) index.
|
| get_CktElements(String) |
Activates and returns a CktElement by its full name (e.g. "load.abc").
|
| GetContextHandle |
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| NextElement | |
| NextPCElement | |
| NextPDElement | |
| Sample | |
| SaveSample | |
| SetActiveBus | |
| SetActiveBusi | |
| SetActiveClass | |
| SetActiveElement | |
| ToString | (Inherited from Object.) |
| UpdateStorage |
FieldsTop
See Also