ActiveClass Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.ActiveClass"]
Namespace: dss_sharp
The ActiveClass type exposes the following members.
| Name | Description | |
|---|---|---|
| ActiveClass | Initializes a new instance of the ActiveClass class |
| Name | Description | |
|---|---|---|
| ActiveClassName |
Returns name of active class.
| |
| ActiveClassParent |
Get the name of the parent class of the active class
| |
| AllNames |
Array of strings consisting of all element names in the active class.
| |
| Count |
Number of elements in Active Class. Same as NumElements Property.
| |
| First |
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.
| |
| Name |
Name of the Active Element of the Active Class
| |
| Next |
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.
| |
| NumElements |
Number of elements in this class. Same as Count property.
|
| Name | Description | |
|---|---|---|
| CheckForError | (Inherited from ContextState.) | |
| 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.) | |
| MemberwiseClone | (Inherited from Object.) | |
| ToJSON |
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)
| |
| ToString | (Inherited from Object.) |
| Name | Description | |
|---|---|---|
| apiutil | (Inherited from ContextState.) | |
| ctx | (Inherited from ContextState.) |