Inheritance diagram for dss::classic::ILoads:

Collaboration diagram for dss::classic::ILoads:

Public Member Functions
	ILoads (dss::APIUtil *util)

strings	AllNames ()
	Array of strings with all Load names in the circuit.

int32_t	Count ()
	Number of Load objects in active circuit.

int32_t	First ()
	Sets the first Load active. More...

string	Name ()
	Get the name of the current active Load.

ILoads &	Name (const char *value)
	Sets the active Load by Name.

ILoads &	Name (const string &value)

int32_t	Next ()
	Sets the next Load active. More...

int32_t	idx ()
	Get active Load by index; index is 1-based: 1..count.

void	idx (int32_t value)
	Get active Load by index; index is 1-based: 1..count.

double	AllocationFactor ()
	Factor for allocating loads by connected xfkva.

ILoads &	AllocationFactor (double value)

string	CVRcurve ()
	Name of a loadshape with both Mult and Qmult, for CVR factors as a function of time.

ILoads &	CVRcurve (const char *value)

ILoads &	CVRcurve (const string &value)

double	CVRvars ()
	Percent reduction in Q for percent reduction in V. More...

ILoads &	CVRvars (double value)

double	CVRwatts ()
	Percent reduction in P for percent reduction in V. More...

ILoads &	CVRwatts (double value)

double	Cfactor ()
	Factor relates average to peak kw. More...

ILoads &	Cfactor (double value)

int32_t	Class ()

ILoads &	Class (int32_t value)

string	Growth ()
	Name of the growthshape curve for yearly load growth factors.

ILoads &	Growth (const char *value)

ILoads &	Growth (const string &value)

bool	IsDelta ()
	Delta loads are connected line-to-line.

ILoads &	IsDelta (bool value)

int32_t	Model ()
	The Load Model defines variation of P and Q with voltage.

ILoads &	Model (int32_t value)

int32_t	NumCust ()
	Number of customers in this load, defaults to one.

ILoads &	NumCust (int32_t value)

double	PF ()
	Get or set Power Factor for Active Load. More...

ILoads &	PF (double value)

double	PctMean ()
	Average percent of nominal load in Monte Carlo studies; only if no loadshape defined for this load.

ILoads &	PctMean (double value)

double	PctStdDev ()
	Percent standard deviation for Monte Carlo load studies; if there is no loadshape assigned to this load.

ILoads &	PctStdDev (double value)

double	RelWeight ()
	Relative Weighting factor for the active LOAD.

ILoads &	RelWeight (double value)

double	Rneut ()
	Neutral resistance for wye-connected loads.

ILoads &	Rneut (double value)

string	Spectrum ()
	Name of harmonic current spectrrum shape.

ILoads &	Spectrum (const char *value)

ILoads &	Spectrum (const string &value)

int32_t	Status ()
	Response to load multipliers: Fixed (growth only), Exempt (no LD curve), Variable (all).

ILoads &	Status (int32_t value)

double	Vmaxpu ()
	Maximum per-unit voltage to use the load model. More...

ILoads &	Vmaxpu (double value)

double	Vminemerg ()
	Minimum voltage for unserved energy (UE) evaluation.

ILoads &	Vminemerg (double value)

double	Vminnorm ()
	Minimum voltage for energy exceeding normal (EEN) evaluations.

ILoads &	Vminnorm (double value)

double	Vminpu ()
	Minimum voltage to apply the load model. More...

ILoads &	Vminpu (double value)

double	Xneut ()
	Neutral reactance for wye-connected loads.

ILoads &	Xneut (double value)

string	Yearly ()
	Name of yearly duration loadshape.

ILoads &	Yearly (const char *value)

ILoads &	Yearly (const string &value)

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	ZIPV ()
	Array of 7 doubles with values for ZIPV property of the load object.

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILoads &	ZIPV (const VectorT &value)

string	daily ()
	Name of the loadshape for a daily load profile.

ILoads &	daily (const char *value)

ILoads &	daily (const string &value)

string	duty ()
	Name of the loadshape for a duty cycle simulation.

ILoads &	duty (const char *value)

ILoads &	duty (const string &value)

double	kV ()
	Set kV rating for active Load. More...

ILoads &	kV (double value)

double	kW ()
	Set kW for active Load. More...

ILoads &	kW (double value)

double	kva ()
	Base load kva. More...

ILoads &	kva (double value)

double	kvar ()
	Get/set kvar for active Load. More...

ILoads &	kvar (double value)

double	kwh ()
	kwh billed for this period. More...

ILoads &	kwh (double value)

double	kwhdays ()
	Length of kwh billing period for average demand calculation. More...

ILoads &	kwhdays (double value)

double	pctSeriesRL ()
	Percent of Load that is modeled as series R-L for harmonics studies.

ILoads &	pctSeriesRL (double value)

double	xfkVA ()
	Rated service transformer kVA for load allocation, using AllocationFactor. More...

ILoads &	xfkVA (double value)

string	Sensor ()
	Name of the sensor monitoring this load.

int32_t	Phases ()
	Number of phases.

ILoads &	Phases (int32_t 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

◆ Cfactor()

double dss::classic::ILoads::Cfactor ( )

inline

Factor relates average to peak kw.

Used for allocation with kwh and kwhdays

◆ CVRvars()

double dss::classic::ILoads::CVRvars ( )

inline

Percent reduction in Q for percent reduction in V.

Must be used with dssLoadModelCVR.

◆ CVRwatts()

double dss::classic::ILoads::CVRwatts ( )

inline

Percent reduction in P for percent reduction in V.

Must be used with dssLoadModelCVR.

◆ First()

int32_t dss::classic::ILoads::First ( )

inline

Sets the first Load active.

Returns 0 if no more.

◆ kV()

double dss::classic::ILoads::kV ( )

inline

Set kV rating for active Load.

For 2 or more phases set Line-Line kV. Else actual kV across terminals.

◆ kva()

double dss::classic::ILoads::kva ( )

inline

Base load kva.

Also defined kw and kvar or pf input, or load allocation by kwh or xfkva.

◆ kvar()

double dss::classic::ILoads::kvar ( )

inline

Get/set kvar for active Load.

If set, updates PF based on present kW.

◆ kW()

double dss::classic::ILoads::kW ( )

inline

Set kW for active Load.

Updates kvar based on present PF.

◆ kwh()

double dss::classic::ILoads::kwh ( )

inline

kwh billed for this period.

Can be used with Cfactor for load allocation.

◆ kwhdays()

double dss::classic::ILoads::kwhdays ( )

inline

Length of kwh billing period for average demand calculation.

Default 30.

◆ Next()

int32_t dss::classic::ILoads::Next ( )

inline

Sets the next Load active.

Returns 0 if no more.

◆ PF()

double dss::classic::ILoads::PF ( )

inline

Get or set Power Factor for Active Load.

Specify leading PF as negative. Updates kvar based on present value of kW

◆ Vmaxpu()

double dss::classic::ILoads::Vmaxpu ( )

inline

Maximum per-unit voltage to use the load model.

Above this, constant Z applies.

◆ Vminpu()

double dss::classic::ILoads::Vminpu ( )

inline

Minimum voltage to apply the load model.

Below this, constant Z is used.

◆ xfkVA()

double dss::classic::ILoads::xfkVA ( )

inline

Rated service transformer kVA for load allocation, using AllocationFactor.

Affects kW, kvar, and pf.

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

include/dss_classic.hpp

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Cfactor()

◆ CVRvars()

◆ CVRwatts()

◆ First()

◆ kV()

◆ kva()

◆ kvar()

◆ kW()

◆ kwh()

◆ kwhdays()

◆ Next()

◆ PF()

◆ Vmaxpu()

◆ Vminpu()

◆ xfkVA()