 | Generators Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.Generators"]
Inheritance HierarchyNamespace: dss_sharp
Assembly: dss_sharp (in dss_sharp.dll) Version: 1.0.0
SyntaxThe Generators type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Generators | Initializes a new instance of the Generators class |
Properties| Name | Description | |
|---|---|---|
 | AllNames |
Array of strings with all Generator names in the circuit.
|
| Bus1 |
Bus to which the Generator is connected. May include specific node specification.
(API Extension)
|
| Class |
An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class.
(API Extension)
|
| Count |
Number of Generator objects in active circuit.
|
| daily |
Name of the loadshape for a daily generation profile.
(API Extension)
|
| duty |
Name of the loadshape for a duty cycle simulation.
(API Extension)
|
| First |
Sets the first Generator active. Returns 0 if no more.
|
| ForcedON |
Indicates whether the generator is forced ON regardles of other dispatch criteria.
|
| idx |
Get/set active Generator by index; index is 1-based: 1..count
|
| IsDelta |
Generator connection. True/1 if delta connection, False/0 if wye.
(API Extension)
|
| kV |
Voltage base for the active generator, kV
|
| kva |
kVA rating of electrical machine. Applied to machine or inverter definition for Dynamics mode solutions.
(API Extension)
|
| kvar |
kvar output for the active generator. Updates power factor based on present kW value.
|
| kVArated |
kVA rating of the generator
|
| kW |
kW output for the active generator. kvar is updated for current power factor.
|
| Model |
Generator Model
|
| Name |
Sets the active Generator by Name.
|
| Next |
Sets the next Generator active. Returns 0 if no more.
|
| PF |
Power factor (pos. = producing vars). Updates kvar based on present kW value.
|
| Phases |
Number of phases
|
| RegisterNames |
Array of Names of all generator energy meter registers
|
| RegisterValues |
Array of valus in generator energy meter registers.
|
| Status |
Response to dispatch multipliers: Fixed=1 (dispatch multipliers do not apply), Variable=0 (follows curves).
Related enumeration: GeneratorStatus
(API Extension)
|
| Vmaxpu |
Vmaxpu for generator model
|
| Vminpu |
Vminpu for Generator model
|
| Yearly |
Name of yearly loadshape
(API Extension)
|
Methods| 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.) |
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | apiutil | (Inherited from ContextState.) |
| ctx | (Inherited from ContextState.) |
See Also