Module Contents#




class dss.IGenerators.IGenerators(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property Bus1: str#

Bus to which the Generator is connected. May include specific node specification.

(API Extension)

property Class: int#

An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class.

(API Extension)

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 ForcedON: bool#

Indicates whether the generator is forced ON regardless of other dispatch criteria.

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

property IsDelta: bool#

Generator connection. True/1 if delta connection, False/0 if wye.

(API Extension)

property Model: int#

Generator Model

Original COM help: https://opendss.epri.com/Model.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 PF: float#

Power factor (pos. = producing vars). Updates kvar based on present kW value.

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

property Phases: int#

Number of phases

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

property RegisterNames: List[str]#

Array of Names of all generator energy meter registers

See also the enum GeneratorRegisters.

property RegisterValues: dss._types.Float64Array#

Array of values in generator energy meter registers.

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

property Status: dss.enums.GeneratorStatus#

Response to dispatch multipliers: Fixed=1 (dispatch multipliers do not apply), Variable=0 (follows curves).

Related enumeration: GeneratorStatus

(API Extension)

property Vmaxpu: float#

Vmaxpu for generator model

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

property Vminpu: float#

Vminpu for Generator model

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

property Yearly: str#

Name of yearly loadshape

(API Extension)

__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 daily: str#

Name of the loadshape for a daily generation profile.

(API Extension)

property duty: str#

Name of the loadshape for a duty cycle simulation.

(API Extension)

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#

Voltage base for the active generator, kV

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

property kVArated: float#

kVA rating of the generator

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

property kW: float#

kW output for the active generator. kvar is updated for current power factor.

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

property kva: float#

kVA rating of electrical machine. Applied to machine or inverter definition for Dynamics mode solutions.

(API Extension)

property kvar: float#

kvar output for the active generator. Updates power factor based on present kW value.

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