dss::classic::ISettings Class Reference

Inheritance diagram for dss::classic::ISettings:

Collaboration diagram for dss::classic::ISettings:

Public Member Functions
	ISettings (dss::APIUtil *util)
bool	AllowDuplicates ()
	{True | False*} Designates whether to allow duplicate names of objects
ISettings &	AllowDuplicates (bool value)
string	AutoBusList ()
	List of Buses or (File=xxxx) syntax for the AutoAdd solution mode.
ISettings &	AutoBusList (const char *value)
ISettings &	AutoBusList (const string &value)
int32_t	CktModel ()
	{dssMultiphase (0) * | dssPositiveSeq (1) } Indicate if the circuit model is positive sequence.
ISettings &	CktModel (int32_t value)
bool	ControlTrace ()
	{True | False*} Denotes whether to trace the control actions to a file.
ISettings &	ControlTrace (bool value)
double	EmergVmaxpu ()
	Per Unit maximum voltage for Emergency conditions.
ISettings &	EmergVmaxpu (double value)
double	EmergVminpu ()
	Per Unit minimum voltage for Emergency conditions.
ISettings &	EmergVminpu (double value)
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT	LossRegs ()
	Integer array defining which energy meter registers to use for computing losses.
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
ISettings &	LossRegs (const VectorT &value)
double	LossWeight ()
	Weighting factor applied to Loss register values.
ISettings &	LossWeight (double value)
double	NormVmaxpu ()
	Per Unit maximum voltage for Normal conditions.
ISettings &	NormVmaxpu (double value)
double	NormVminpu ()
	Per Unit minimum voltage for Normal conditions.
ISettings &	NormVminpu (double value)
string	PriceCurve ()
	Name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
ISettings &	PriceCurve (const char *value)
ISettings &	PriceCurve (const string &value)
double	PriceSignal ()
	Price Signal for the Circuit.
ISettings &	PriceSignal (double value)
bool	Trapezoidal ()
	{True | False *} Gets value of trapezoidal integration flag in energy meters.
ISettings &	Trapezoidal (bool value)
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT	UEregs ()
	Array of Integers defining energy meter registers to use for computing UE.
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
ISettings &	UEregs (const VectorT &value)
double	UEweight ()
	Weighting factor applied to UE register values.
ISettings &	UEweight (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	VoltageBases ()
	Array of doubles defining the legal voltage bases in kV L-L.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ISettings &	VoltageBases (const VectorT &value)
bool	ZoneLock ()
	{True | False*} Locks Zones on energy meters to prevent rebuilding if a circuit change occurs.
ISettings &	ZoneLock (bool value)
ISettings &	AllocationFactors (double value)
	(write-only) Sets all load allocation factors for all loads defined by XFKVA property to this value.
bool	LoadsTerminalCheck ()
	Controls whether the terminals are checked when updating the currents in Load component. More...
ISettings &	LoadsTerminalCheck (bool value)
int32_t	IterateDisabled ()
	Controls whether First/Next iteration includes or skips disabled circuit elements. More...
ISettings &	IterateDisabled (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

IterateDisabled()

int32_t dss::classic::ISettings::IterateDisabled ( )

inline

Controls whether First/Next iteration includes or skips disabled circuit elements.

The default behavior from OpenDSS is to skip those. The user can still activate the element by name or index.

The default value for IterateDisabled is 0, keeping the original behavior. Set it to 1 (or True) to include disabled elements. Other numeric values are reserved for other potential behaviors.

(API Extension)

LoadsTerminalCheck()

bool dss::classic::ISettings::LoadsTerminalCheck ( )

inline

Controls whether the terminals are checked when updating the currents in Load component.

Defaults to True. If the loads are guaranteed to have their terminals closed throughout the simulation, this can be set to False to save some time.

(API Extension)

---

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

• include/dss_classic.hpp