dss::classic::IGenerators Class Reference

Inheritance diagram for dss::classic::IGenerators:

Collaboration diagram for dss::classic::IGenerators:

Public Member Functions
	IGenerators (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Generator names in the circuit.
int32_t	Count ()
	Number of Generator objects in active circuit.
int32_t	First ()
	Sets the first Generator active. More...
string	Name ()
	Get the name of the current active Generator.
IGenerators &	Name (const char *value)
	Sets the active Generator by Name.
IGenerators &	Name (const string &value)
int32_t	Next ()
	Sets the next Generator active. More...
int32_t	idx ()
	Get active Generator by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Generator by index; index is 1-based: 1..count.
bool	ForcedON ()
	Indicates whether the generator is forced ON regardles of other dispatch criteria.
IGenerators &	ForcedON (bool value)
int32_t	Model ()
	Generator Model.
IGenerators &	Model (int32_t value)
double	PF ()
	Power factor (pos. More...
IGenerators &	PF (double value)
int32_t	Phases ()
	Number of phases.
IGenerators &	Phases (int32_t value)
strings	RegisterNames ()
	Array of Names of all generator energy meter registers.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	RegisterValues ()
	Array of valus in generator energy meter registers.
double	Vmaxpu ()
	Vmaxpu for generator model.
IGenerators &	Vmaxpu (double value)
double	Vminpu ()
	Vminpu for Generator model.
IGenerators &	Vminpu (double value)
double	kV ()
	Voltage base for the active generator, kV.
IGenerators &	kV (double value)
double	kVArated ()
	kVA rating of the generator
IGenerators &	kVArated (double value)
double	kW ()
	kW output for the active generator. More...
IGenerators &	kW (double value)
double	kvar ()
	kvar output for the active generator. More...
IGenerators &	kvar (double value)
string	daily ()
	Name of the loadshape for a daily generation profile. More...
IGenerators &	daily (const char *value)
IGenerators &	daily (const string &value)
string	duty ()
	Name of the loadshape for a duty cycle simulation. More...
IGenerators &	duty (const char *value)
IGenerators &	duty (const string &value)
string	Yearly ()
	Name of yearly loadshape. More...
IGenerators &	Yearly (const char *value)
IGenerators &	Yearly (const string &value)
int32_t	Status ()
	Response to dispatch multipliers: Fixed=1 (dispatch multipliers do not apply), Variable=0 (follows curves). More...
IGenerators &	Status (int32_t value)
bool	IsDelta ()
	Generator connection. More...
IGenerators &	IsDelta (bool value)
double	kva ()
	kVA rating of electrical machine. More...
IGenerators &	kva (double value)
int32_t	Class ()
	An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class. More...
IGenerators &	Class (int32_t value)
string	Bus1 ()
	Bus to which the Generator is connected. More...
IGenerators &	Bus1 (const char *value)
IGenerators &	Bus1 (const string &value)
Public Member Functions inherited from dss::ContextState
	ContextState (APIUtil *util)

Additional Inherited Members
Public Attributes inherited from dss::ContextState
void *	ctx
	Pointer to the DSSContext for easy access.
APIUtil *	api_util
	API utility functions.

Member Function Documentation

Bus1()

string dss::classic::IGenerators::Bus1 ( )

inline

Bus to which the Generator is connected.

May include specific node specification.

(API Extension)

Class()

int32_t dss::classic::IGenerators::Class ( )

inline

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

(API Extension)

daily()

string dss::classic::IGenerators::daily ( )

inline

Name of the loadshape for a daily generation profile.

(API Extension)

duty()

string dss::classic::IGenerators::duty ( )

inline

Name of the loadshape for a duty cycle simulation.

(API Extension)

First()

int32_t dss::classic::IGenerators::First ( )

inline

Sets the first Generator active.

Returns 0 if no more.

IsDelta()

bool dss::classic::IGenerators::IsDelta ( )

inline

Generator connection.

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

(API Extension)

kva()

double dss::classic::IGenerators::kva ( )

inline

kVA rating of electrical machine.

Applied to machine or inverter definition for Dynamics mode solutions.

(API Extension)

kvar()

double dss::classic::IGenerators::kvar ( )

inline

kvar output for the active generator.

Updates power factor based on present kW value.

kW()

double dss::classic::IGenerators::kW ( )

inline

kW output for the active generator.

kvar is updated for current power factor.

Next()

int32_t dss::classic::IGenerators::Next ( )

inline

Sets the next Generator active.

Returns 0 if no more.

PF()

double dss::classic::IGenerators::PF ( )

inline

Power factor (pos.

= producing vars). Updates kvar based on present kW value.

Status()

int32_t dss::classic::IGenerators::Status ( )

inline

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

Related enumeration: GeneratorStatus

(API Extension)

Yearly()

string dss::classic::IGenerators::Yearly ( )

inline

Name of yearly loadshape.

(API Extension)

---

The documentation for this class was generated from the following file:

• include/dss_classic.hpp