Ctrl+K

dss.ITransformers

dss.ITransformers#

Module Contents#

Classes#

ITransformers

API#

class dss.ITransformers.ITransformers(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllLossesByType: dss._types.Float64ArrayOrComplexArray#

Complex array with the losses by type (total losses, load losses, no-load losses), in VA, concatenated for ALL transformers

(API Extension)

property AllNames: List[str]#

Array of all names of this object type

property CoreType: dss.enums.CoreType#

Transformer Core Type: 0=Shell; 1=1ph; 3-3leg; 4=4-Leg; 5=5-leg; 9=Core-1-phase

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

property Count: int#

Number of objects of this type

property First: int#

Sets the first object of this type active. Returns 0 if none.

property IsDelta: bool#

Active Winding delta or wye connection?

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

property LossesByType: dss._types.Float64ArrayOrComplexArray#

Complex array with the losses by type (total losses, load losses, no-load losses), in VA

(API Extension)

property MaxTap: float#

Active Winding maximum tap in per-unit.

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

property MinTap: float#

Active Winding minimum tap in per-unit.

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

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 NumTaps: int#

Active Winding number of tap steps between MinTap and MaxTap.

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

property NumWindings: int#

Number of windings on this transformer. Allocates memory; set or change this property first.

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

property R: float#

Active Winding resistance in %

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

property RdcOhms: float#

dc Resistance of active winding in ohms for GIC analysis

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

property Rneut: float#

Active Winding neutral resistance [ohms] for wye connections. Set less than zero for ungrounded wye.

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

property Tap: float#

Active Winding tap in per-unit.

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

property Wdg: int#

Active Winding Number from 1..NumWindings. Update this before reading or setting a sequence of winding properties (R, Tap, kV, kVA, etc.)

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

property WdgCurrents: dss._types.Float64ArrayOrComplexArray#

All Winding currents (ph1, wdg1, wdg2,… ph2, wdg1, wdg2 …)

WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this in those situations. For more information, see dss-extensions/dss-extensions#24

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

property WdgVoltages: dss._types.Float64ArrayOrComplexArray#

Complex array of voltages for active winding

WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this in those situations. For more information, see dss-extensions/dss-extensions#24

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

property XfmrCode: str#

Name of an XfrmCode that supplies electrical parameters for this Transformer.

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

property Xhl: float#

Percent reactance between windings 1 and 2, on winding 1 kVA base. Use for 2-winding or 3-winding transformers.

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

property Xht: float#

Percent reactance between windings 1 and 3, on winding 1 kVA base. Use for 3-winding transformers only.

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

property Xlt: float#

Percent reactance between windings 2 and 3, on winding 1 kVA base. Use for 3-winding transformers only.

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

property Xneut: float#

Active Winding neutral reactance [ohms] for wye connections.

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

__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

(API Extension)

property kV: float#

Active Winding kV rating. Phase-phase for 2 or 3 phases, actual winding kV for 1 phase transformer.

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

property kVA: float#

Active Winding kVA rating. On winding 1, this also determines normal and emergency current ratings for all windings.

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

kva#

None

property strWdgCurrents: str#

All winding currents in CSV string form like the WdgCurrents property

WARNING: If the transformer has open terminal(s), results may be wrong, i.e. avoid using this in those situations. For more information, see dss-extensions/dss-extensions#24

Contents