dss::classic::ITransformers Class Reference

Inheritance diagram for dss::classic::ITransformers:

Collaboration diagram for dss::classic::ITransformers:

Public Member Functions
	ITransformers (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Transformer names in the circuit.
int32_t	Count ()
	Number of Transformer objects in active circuit.
int32_t	First ()
	Sets the first Transformer active. More...
string	Name ()
	Get the name of the current active Transformer.
ITransformers &	Name (const char *value)
	Sets the active Transformer by Name.
ITransformers &	Name (const string &value)
int32_t	Next ()
	Sets the next Transformer active. More...
int32_t	idx ()
	Get active Transformer by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Transformer by index; index is 1-based: 1..count.
bool	IsDelta ()
	Active Winding delta or wye connection?
ITransformers &	IsDelta (bool value)
double	MaxTap ()
	Active Winding maximum tap in per-unit.
ITransformers &	MaxTap (double value)
double	MinTap ()
	Active Winding minimum tap in per-unit.
ITransformers &	MinTap (double value)
int32_t	NumTaps ()
	Active Winding number of tap steps betwein MinTap and MaxTap.
ITransformers &	NumTaps (int32_t value)
int32_t	NumWindings ()
	Number of windings on this transformer. More...
ITransformers &	NumWindings (int32_t value)
double	R ()
	Active Winding resistance in %.
ITransformers &	R (double value)
double	Rneut ()
	Active Winding neutral resistance [ohms] for wye connections. More...
ITransformers &	Rneut (double value)
double	Tap ()
	Active Winding tap in per-unit.
ITransformers &	Tap (double value)
int32_t	Wdg ()
	Active Winding Number from 1..NumWindings. More...
ITransformers &	Wdg (int32_t value)
string	XfmrCode ()
	Name of an XfrmCode that supplies electircal parameters for this Transformer.
ITransformers &	XfmrCode (const char *value)
ITransformers &	XfmrCode (const string &value)
double	Xhl ()
	Percent reactance between windings 1 and 2, on winding 1 kVA base. More...
ITransformers &	Xhl (double value)
double	Xht ()
	Percent reactance between windigns 1 and 3, on winding 1 kVA base. More...
ITransformers &	Xht (double value)
double	Xlt ()
	Percent reactance between windings 2 and 3, on winding 1 kVA base. More...
ITransformers &	Xlt (double value)
double	Xneut ()
	Active Winding neutral reactance [ohms] for wye connections.
ITransformers &	Xneut (double value)
double	kV ()
	Active Winding kV rating. More...
ITransformers &	kV (double value)
double	kVA ()
	Active Winding kVA rating. More...
ITransformers &	kVA (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	WdgVoltages ()
	Complex array of voltages for active winding.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	WdgCurrents ()
	All Winding currents (ph1, wdg1, wdg2,... ph2, wdg1, wdg2 ...)
string	strWdgCurrents ()
	All winding currents in CSV string form like the WdgCurrents property.
int32_t	CoreType ()
	Transformer Core Type: 0=shell;1 = 1-phase; 3= 3-leg; 5= 5-leg.
ITransformers &	CoreType (int32_t value)
double	RdcOhms ()
	dc Resistance of active winding in ohms for GIC analysis
ITransformers &	RdcOhms (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	LossesByType ()
	Complex array with the losses by type (total losses, load losses, no-load losses), in VA.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllLossesByType ()
	Complex array with the losses by type (total losses, load losses, no-load losses), in VA, concatenated for ALL transformers.
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

First()

int32_t dss::classic::ITransformers::First ( )

inline

Sets the first Transformer active.

Returns 0 if no more.

kV()

double dss::classic::ITransformers::kV ( )

inline

Active Winding kV rating.

Phase-phase for 2 or 3 phases, actual winding kV for 1 phase transformer.

kVA()

double dss::classic::ITransformers::kVA ( )

inline

Active Winding kVA rating.

On winding 1, this also determines normal and emergency current ratings for all windings.

Next()

int32_t dss::classic::ITransformers::Next ( )

inline

Sets the next Transformer active.

Returns 0 if no more.

NumWindings()

int32_t dss::classic::ITransformers::NumWindings ( )

inline

Number of windings on this transformer.

Allocates memory; set or change this property first.

Rneut()

double dss::classic::ITransformers::Rneut ( )

inline

Active Winding neutral resistance [ohms] for wye connections.

Set less than zero for ungrounded wye.

Wdg()

int32_t dss::classic::ITransformers::Wdg ( )

inline

Active Winding Number from 1..NumWindings.

Update this before reading or setting a sequence of winding properties (R, Tap, kV, kVA, etc.)

Xhl()

double dss::classic::ITransformers::Xhl ( )

inline

Percent reactance between windings 1 and 2, on winding 1 kVA base.

Use for 2-winding or 3-winding transformers.

Xht()

double dss::classic::ITransformers::Xht ( )

inline

Percent reactance between windigns 1 and 3, on winding 1 kVA base.

Use for 3-winding transformers only.

Xlt()

double dss::classic::ITransformers::Xlt ( )

inline

Percent reactance between windings 2 and 3, on winding 1 kVA base.

Use for 3-winding transformers only.

---

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

• include/dss_classic.hpp