Click or drag to resize

Circuit Methods

[This is preliminary documentation and is subject to change.]

The Circuit type exposes the following members.

Methods
  NameDescription
Public methodAllNodeDistancesByPhase
Returns an array of doubles representing the distances to parent EnergyMeter. Sequence of array corresponds to other node ByPhase properties.
Public methodAllNodeNamesByPhase
Return array of strings of the node names for the By Phase criteria. Sequence corresponds to other ByPhase properties.
Public methodAllNodeVmagByPhase
Returns Array of doubles represent voltage magnitudes for nodes on the specified phase.
Public methodAllNodeVmagPUByPhase
Returns array of per unit voltage magnitudes for each node by phase
Public methodCapacity
Protected methodCheckForError (Inherited from ContextState.)
Public methodDisable
Public methodElementLosses
Array of total losses (complex) in a selection of elements. Use the element indices (starting at 1) as parameter. (API Extension)
Public methodEnable
Public methodEndOfTimeStepUpdate
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFirstElement
Public methodFirstPCElement
Public methodFirstPDElement
Public methodget_Buses(Int32)
Activates and returns a bus by its (zero-based) index.
Public methodget_Buses(String)
Activates and returns a bus by its name.
Public methodget_CktElements(Int32)
Activates and returns a CktElement by its global (zero-based) index.
Public methodget_CktElements(String)
Activates and returns a CktElement by its full name (e.g. "load.abc").
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodNextElement
Public methodNextPCElement
Public methodNextPDElement
Public methodSample
Public methodSaveSample
Public methodSetActiveBus
Public methodSetActiveBusi
Public methodSetActiveClass
Public methodSetActiveElement
Public methodToString (Inherited from Object.)
Public methodUpdateStorage
Top
See Also