dss.ICNData

`dss.ICNData`#

Module Contents#

Classes#

ICNData

CNData objects

API#

class dss.ICNData.ICNData(api_util)#

Bases: dss._cffi_api_util.Iterable

CNData objects

(API Extension)

property AllNames: List[str]#: Array of all names of this object type

property Count: int#: Number of objects of this type

property DiaCable: float#

property DiaIns: float#

property DiaStrand: float#

property Diameter: float#

property EmergAmps: float#: Emergency ampere rating

property EpsR: float#

property First: int#: Sets the first object of this type active. Returns 0 if none.

property GMRUnits: dss.enums.LineUnits#

property GMRac: float#

property GmrStrand: float#

property InsLayer: float#

property Name: str#: Gets the current name or sets the active object of this type by name

property Next: int#: Sets next object of this type active. Returns 0 if no more.

property NormAmps: float#: Normal Ampere rating

property RStrand: float#

property Rac: float#

property Radius: float#

property RadiusUnits: dss.enums.LineUnits#

property Rdc: float#

property ResistanceUnits: dss.enums.LineUnits#

__init__(api_util)#

__iter__() → Iterator[dss._cffi_api_util.Iterable]#

Get an iterator of the object collection.

Note that OpenDSS, via the classic APIs, only allow a single object of a specific type to be activated. That is, you cannot use references of distinct objects and interact with both at the same time, or keep a reference to use later. You need to reactivate the target object or ensure it is the active one.

For an alternative, consider using our AltDSS-Python package.

(API Extension)

__len__() → int#

property idx: int#

Gets the current index or sets the active object of this type by index

While the official API included this for some classes, this is an API Extension for:

Capacitors
CapControls
ISources
LineCodes
Lines
LoadShapes
Meters
Monitors
RegControls
Sensors
SwtControls
Transformers
Vsources
XYCurves