 | Circuit Methods |
[This is preliminary documentation and is subject to change.]
The Circuit type exposes the following members.
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 |
See Also