dss::classic::IRegControls Class Reference

Inheritance diagram for dss::classic::IRegControls:

Collaboration diagram for dss::classic::IRegControls:

Public Member Functions
	IRegControls (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all RegControl names in the circuit.
int32_t	Count ()
	Number of RegControl objects in active circuit.
int32_t	First ()
	Sets the first RegControl active. More...
string	Name ()
	Get the name of the current active RegControl.
IRegControls &	Name (const char *value)
	Sets the active RegControl by Name.
IRegControls &	Name (const string &value)
int32_t	Next ()
	Sets the next RegControl active. More...
int32_t	idx ()
	Get active RegControl by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active RegControl by index; index is 1-based: 1..count.
void	Reset ()
double	CTPrimary ()
	CT primary ampere rating (secondary is 0.2 amperes)
IRegControls &	CTPrimary (double value)
double	Delay ()
	Time delay [s] after arming before the first tap change. More...
IRegControls &	Delay (double value)
double	ForwardBand ()
	Regulation bandwidth in forward direciton, centered on Vreg.
IRegControls &	ForwardBand (double value)
double	ForwardR ()
	LDC R setting in Volts.
IRegControls &	ForwardR (double value)
double	ForwardVreg ()
	Target voltage in the forward direction, on PT secondary base.
IRegControls &	ForwardVreg (double value)
double	ForwardX ()
	LDC X setting in Volts.
IRegControls &	ForwardX (double value)
bool	IsInverseTime ()
	Time delay is inversely adjsuted, proportinal to the amount of voltage outside the regulating band.
IRegControls &	IsInverseTime (bool value)
bool	IsReversible ()
	Regulator can use different settings in the reverse direction. More...
IRegControls &	IsReversible (bool value)
int32_t	MaxTapChange ()
	Maximum tap change per iteration in STATIC solution mode. More...
IRegControls &	MaxTapChange (int32_t value)
string	MonitoredBus ()
	Name of a remote regulated bus, in lieu of LDC settings.
IRegControls &	MonitoredBus (const char *value)
IRegControls &	MonitoredBus (const string &value)
double	PTratio ()
	PT ratio for voltage control settings.
IRegControls &	PTratio (double value)
double	ReverseBand ()
	Bandwidth in reverse direction, centered on reverse Vreg.
IRegControls &	ReverseBand (double value)
double	ReverseR ()
	Reverse LDC R setting in Volts.
IRegControls &	ReverseR (double value)
double	ReverseVreg ()
	Target voltage in the revese direction, on PT secondary base.
IRegControls &	ReverseVreg (double value)
double	ReverseX ()
	Reverse LDC X setting in volts.
IRegControls &	ReverseX (double value)
double	TapDelay ()
	Time delay [s] for subsequent tap changes in a set. More...
IRegControls &	TapDelay (double value)
int32_t	TapNumber ()
	Integer number of the tap that the controlled transformer winding is currentliy on.
IRegControls &	TapNumber (int32_t value)
int32_t	TapWinding ()
	Tapped winding number.
IRegControls &	TapWinding (int32_t value)
string	Transformer ()
	Name of the transformer this regulator controls.
IRegControls &	Transformer (const char *value)
IRegControls &	Transformer (const string &value)
double	VoltageLimit ()
	First house voltage limit on PT secondary base. More...
IRegControls &	VoltageLimit (double value)
int32_t	Winding ()
	Winding number for PT and CT connections.
IRegControls &	Winding (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

Delay()

double dss::classic::IRegControls::Delay ( )

inline

Time delay [s] after arming before the first tap change.

Control may reset before actually changing taps.

First()

int32_t dss::classic::IRegControls::First ( )

inline

Sets the first RegControl active.

Returns 0 if no more.

IsReversible()

bool dss::classic::IRegControls::IsReversible ( )

inline

Regulator can use different settings in the reverse direction.

Usually not applicable to substation transformers.

MaxTapChange()

int32_t dss::classic::IRegControls::MaxTapChange ( )

inline

Maximum tap change per iteration in STATIC solution mode.

1 is more realistic, 16 is the default for a faster soluiton.

Next()

int32_t dss::classic::IRegControls::Next ( )

inline

Sets the next RegControl active.

Returns 0 if no more.

TapDelay()

double dss::classic::IRegControls::TapDelay ( )

inline

Time delay [s] for subsequent tap changes in a set.

Control may reset before actually changing taps.

VoltageLimit()

double dss::classic::IRegControls::VoltageLimit ( )

inline

First house voltage limit on PT secondary base.

Setting to 0 disables this function.

---

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

• include/dss_classic.hpp