Click or drag to resize

ActiveClass Class

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

[Missing <summary> documentation for "T:dss_sharp.ActiveClass"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
public class ActiveClass : ContextState

The ActiveClass type exposes the following members.

Public methodActiveClass
Initializes a new instance of the ActiveClass class
Public propertyActiveClassName
Returns name of active class.
Public propertyActiveClassParent
Get the name of the parent class of the active class
Public propertyAllNames
Array of strings consisting of all element names in the active class.
Public propertyCount
Number of elements in Active Class. Same as NumElements Property.
Public propertyFirst
Sets first element in the active class to be the active DSS object. If object is a CktElement, ActiveCktELment also points to this element. Returns 0 if none.
Public propertyName
Name of the Active Element of the Active Class
Public propertyNext
Sets next element in active class to be the active DSS object. If object is a CktElement, ActiveCktElement also points to this element. Returns 0 if no more.
Public propertyNumElements
Number of elements in this class. Same as Count property.
Protected methodCheckForError (Inherited from ContextState.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
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 methodToJSON
Returns the data (as a list) of all elements from the active class as a JSON-encoded string. The `options` parameter contains bit-flags to toggle specific features. See `Obj_ToJSON` (C-API) for more. Additionally, the `ExcludeDisabled` flag can be used to excluded disabled elements from the output. (API Extension)
Public methodToString (Inherited from Object.)
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
See Also