dss.IActiveClass

Module Contents

Classes

IActiveClass

API

class dss.IActiveClass.IActiveClass(api_util, prefer_lists=False)

Bases: dss._cffi_api_util.Base

property ActiveClassName: str

Returns name of active class.

Original COM help: https://opendss.epri.com/ActiveClassName.html

property ActiveClassParent: str

Get the name of the parent class of the active class

Original COM help: https://opendss.epri.com/ActiveClassParent.html

property AllNames: List[str]

Array of strings consisting of all element names in the active class.

Original COM help: https://opendss.epri.com/AllNames.html

property Count: int

Number of elements in Active Class. Same as NumElements Property.

Original COM help: https://opendss.epri.com/Count.html

property First: int

Sets first element in the active class to be the active DSS object. If the object is a CktElement, ActiveCktELement also points to this element.

Returns 0 if none.

Original COM help: https://opendss.epri.com/First.html

property Name: str

Name of the Active Element of the Active Class

Original COM help: https://opendss.epri.com/Name.html

property Next: int

Sets next element in active class to be the active DSS object. If the object is a CktElement, ActiveCktElement also points to this element.

Returns 0 if no more.

Original COM help: https://opendss.epri.com/Next.html

property NumElements: int

Number of elements in this class. Same as Count property.

Original COM help: https://opendss.epri.com/NumElements.html

ToJSON(options: dss.enums.DSSJSONFlags = 0) → str

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, or DSSObj.to_json in Python.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

(API Extension)

__init__(api_util, prefer_lists=False)

__iter__() → Iterator[dss.IActiveClass.IActiveClass]

__len__() → int