Inheritance diagram for dss::obj::GICTransformerBatch:

Collaboration diagram for dss::obj::GICTransformerBatch:

Public Types
typedef GICTransformer::Properties	Properties

typedef GICTransformer	BatchElementClass

typedef GICTransformer::GICTransformerType	GICTransformerType

Public Member Functions
	GICTransformerBatch (APIUtil *util)
	Create a batch of all GICTransformer elements.

	GICTransformerBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all GICTransformer elements that match an integer property value.

	GICTransformerBatch (APIUtil util, const char regexp)
	Create a batch of all GICTransformer elements that match a regular expression.

GICTransformerBatch &	begin_edit ()

GICTransformerBatch &	end_edit (int32_t num_edits=1)

strings	BusH ()
	Name of High-side(H) bus. More...

GICTransformerBatch &	BusH (const string &value)

GICTransformerBatch &	BusH (strings &value)

strings	BusNH ()
	Name of Neutral bus for H, or first, winding. More...

GICTransformerBatch &	BusNH (const string &value)

GICTransformerBatch &	BusNH (strings &value)

strings	BusX ()
	Name of Low-side(X) bus, if type=Auto or YY. More...

GICTransformerBatch &	BusX (const string &value)

GICTransformerBatch &	BusX (strings &value)

strings	BusNX ()
	Name of Neutral bus for X, or Second, winding. More...

GICTransformerBatch &	BusNX (const string &value)

GICTransformerBatch &	BusNX (strings &value)

BatchInt32ArrayProxy	phases ()
	Number of Phases. More...

GICTransformerBatch &	phases (int32_t value)

template<typename T >
GICTransformerBatch &	phases (T &value)

template<typename T >
GICTransformerBatch &	phases (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Type ()
	Type of transformer: {GSU* \| Auto \| YY}. More...

GICTransformerBatch &	Type (string &value)

GICTransformerBatch &	Type (int32_t value)

GICTransformerBatch &	Type (GICTransformer::GICTransformerType value)

GICTransformerBatch &	Type (strings &value)

GICTransformerBatch &	Type (std::vector< int32_t > &value)

GICTransformerBatch &	Type (std::vector< GICTransformer::GICTransformerType > &value)

strings	Type_str ()
	Type of transformer: {GSU* \| Auto \| YY}. More...

GICTransformerBatch &	Type_str (string &value)

GICTransformerBatch &	Type_str (strings &value)

BatchFloat64ArrayProxy	R1 ()
	Resistance, each phase, ohms for H winding, (Series winding, if Auto). More...

GICTransformerBatch &	R1 (double value)

template<typename T >
GICTransformerBatch &	R1 (T &value)

template<typename T >
GICTransformerBatch &	R1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	R2 ()
	Resistance, each phase, ohms for X winding, (Common winding, if Auto). More...

GICTransformerBatch &	R2 (double value)

template<typename T >
GICTransformerBatch &	R2 (T &value)

template<typename T >
GICTransformerBatch &	R2 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	KVLL1 ()
	Optional. More...

GICTransformerBatch &	KVLL1 (double value)

template<typename T >
GICTransformerBatch &	KVLL1 (T &value)

template<typename T >
GICTransformerBatch &	KVLL1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	KVLL2 ()
	Optional. More...

GICTransformerBatch &	KVLL2 (double value)

template<typename T >
GICTransformerBatch &	KVLL2 (T &value)

template<typename T >
GICTransformerBatch &	KVLL2 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	MVA ()
	Optional. More...

GICTransformerBatch &	MVA (double value)

template<typename T >
GICTransformerBatch &	MVA (T &value)

template<typename T >
GICTransformerBatch &	MVA (typename T::iterator it_begin, typename T::iterator it_end)

strings	VarCurve ()
	Optional. More...

GICTransformerBatch &	VarCurve (dss::obj::XYcurve &value)

GICTransformerBatch &	VarCurve (const string &value)

std::vector< dss::obj::XYcurve >	VarCurve_obj ()
	Optional. More...

GICTransformerBatch &	VarCurve_obj (dss::obj::XYcurve &value)

BatchFloat64ArrayProxy	pctR1 ()
	Optional. More...

GICTransformerBatch &	pctR1 (double value)

template<typename T >
GICTransformerBatch &	pctR1 (T &value)

template<typename T >
GICTransformerBatch &	pctR1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctR2 ()
	Optional. More...

GICTransformerBatch &	pctR2 (double value)

template<typename T >
GICTransformerBatch &	pctR2 (T &value)

template<typename T >
GICTransformerBatch &	pctR2 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	K ()
	Mvar K factor. More...

GICTransformerBatch &	K (double value)

template<typename T >
GICTransformerBatch &	K (T &value)

template<typename T >
GICTransformerBatch &	K (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	normamps ()
	Normal rated current. More...

GICTransformerBatch &	normamps (double value)

template<typename T >
GICTransformerBatch &	normamps (T &value)

template<typename T >
GICTransformerBatch &	normamps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	emergamps ()
	Maximum or emerg current. More...

GICTransformerBatch &	emergamps (double value)

template<typename T >
GICTransformerBatch &	emergamps (T &value)

template<typename T >
GICTransformerBatch &	emergamps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	faultrate ()
	Failure rate per year. More...

GICTransformerBatch &	faultrate (double value)

template<typename T >
GICTransformerBatch &	faultrate (T &value)

template<typename T >
GICTransformerBatch &	faultrate (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctperm ()
	Percent of failures that become permanent. More...

GICTransformerBatch &	pctperm (double value)

template<typename T >
GICTransformerBatch &	pctperm (T &value)

template<typename T >
GICTransformerBatch &	pctperm (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	repair ()
	Hours to repair. More...

GICTransformerBatch &	repair (double value)

template<typename T >
GICTransformerBatch &	repair (T &value)

template<typename T >
GICTransformerBatch &	repair (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	basefreq ()
	Base Frequency for ratings. More...

GICTransformerBatch &	basefreq (double value)

template<typename T >
GICTransformerBatch &	basefreq (T &value)

template<typename T >
GICTransformerBatch &	basefreq (typename T::iterator it_begin, typename T::iterator it_end)

bools	enabled ()
	{Yes\|No or True\|False} Indicates whether this element is enabled. More...

GICTransformerBatch &	enabled (bool value)

GICTransformerBatch &	enabled (bools &value)

GICTransformerBatch &	like (const string &value)
	Make like another object, e.g. More...

GICTransformerBatch &	like (const char *value)
	Make like another object, e.g. More...

Public Member Functions inherited from dss::obj::DSSBatch
	DSSBatch (APIUtil *util, int32_t cls_idx)
	Create a batch of all elements in the DSS class.

	DSSBatch (APIUtil *util, int32_t cls_idx, int32_t prop_idx, int32_t prop_value)
	Create a batch of all elements that match an integer property value.

	DSSBatch (APIUtil util, int32_t cls_idx, const char regexp)
	Create a batch of all elements that match a regular expression.

	DSSBatch (APIUtil *util)
	Create an uninitialized batch instance.

strings	name ()

Additional Inherited Members
Public Attributes inherited from dss::obj::DSSBatch
APIUtil *	api_util

void **	pointer

int32_t	count [2]

Protected Member Functions inherited from dss::obj::DSSBatch
void	check_for_error ()

bools	get_batch_bool (int32_t index)

std::vector< complex >	get_batch_complex (int32_t index)

template<typename T = VectorXd>
std::vector< T >	get_batch_valarray (int32_t index)

void	set_batch_complex_for_each (int32_t index, std::vector< complex > &values)

template<typename T >
void	set_batch_val (int32_t index, const T &value)

template<typename T = VectorXd>
T	get_batch_val (int32_t index)

template<typename T >
void	set_batch_val_for_each (int32_t index, typename T::iterator v, typename T::iterator v_end)

Static Protected Member Functions inherited from dss::obj::DSSBatch
template<typename T = VectorXd>
static T	get_batch_val (int32_t index, DSSBatch &batch)

Member Function Documentation

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 21

◆ BusH()

strings dss::obj::GICTransformerBatch::BusH ( )

inline

Name of High-side(H) bus.

Examples: BusH=busname BusH=busname.1.2.3

DSS property name: BusH, DSS property index: 1

◆ BusNH()

strings dss::obj::GICTransformerBatch::BusNH ( )

inline

Name of Neutral bus for H, or first, winding.

Defaults to all phases connected to H-side bus, node 0, if not specified and transformer type is either GSU or YY. (Shunt Wye Connection to ground reference)For Auto, this is automatically set to the X bus.

DSS property name: BusNH, DSS property index: 2

◆ BusNX()

strings dss::obj::GICTransformerBatch::BusNX ( )

inline

Name of Neutral bus for X, or Second, winding.

Defaults to all phases connected to X-side bus, node 0, if not specified. (Shunt Wye Connection to ground reference)

DSS property name: BusNX, DSS property index: 4

◆ BusX()

strings dss::obj::GICTransformerBatch::BusX ( )

inline

Name of Low-side(X) bus, if type=Auto or YY.

DSS property name: BusX, DSS property index: 3

◆ emergamps()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::emergamps ( )

inline

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 17

◆ enabled()

bools dss::obj::GICTransformerBatch::enabled ( )

inline

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 22

◆ faultrate()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::faultrate ( )

inline

Failure rate per year.

DSS property name: faultrate, DSS property index: 18

◆ K()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::K ( )

inline

Mvar K factor.

Default way to convert GIC Amps in H winding (winding 1) to Mvar. Default is 2.2. Commonly-used simple multiplier for estimating Mvar losses for power flow analysis.

Mvar = K * kvLL * GIC per phase / 1000

Mutually exclusive with using the VarCurve property and pu curves.If you specify this (default), VarCurve is ignored.

DSS property name: K, DSS property index: 15

◆ KVLL1()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::KVLL1 ( )

inline

Optional.

kV LL rating for H winding (winding 1). Default is 500. Required if you are going to export vars for power flow analysis or enter winding resistances in percent.

DSS property name: KVLL1, DSS property index: 9

◆ KVLL2()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::KVLL2 ( )

inline

Optional.

kV LL rating for X winding (winding 2). Default is 138. Required if you are going to export vars for power flow analysis or enter winding resistances in percent..

DSS property name: KVLL2, DSS property index: 10

◆ like() [1/2]

GICTransformerBatch & dss::obj::GICTransformerBatch::like ( const char * value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 23

◆ like() [2/2]

GICTransformerBatch & dss::obj::GICTransformerBatch::like ( const string & value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 23

◆ MVA()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::MVA ( )

inline

Optional.

MVA Rating assumed Transformer. Default is 100. Used for computing vars due to GIC and winding resistances if kV and MVA ratings are specified.

DSS property name: MVA, DSS property index: 11

◆ normamps()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::normamps ( )

inline

Normal rated current.

DSS property name: normamps, DSS property index: 16

◆ pctperm()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::pctperm ( )

inline

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 19

◆ pctR1()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::pctR1 ( )

inline

Optional.

Percent Resistance, each phase, for H winding (1), (Series winding, if Auto). Default is 0.2.

Alternative way to enter R1 value. It is the actual resistances in ohmns that matter. MVA and kV should be specified.

DSS property name: R1, DSS property index: 13

◆ pctR2()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::pctR2 ( )

inline

Optional.

Percent Resistance, each phase, for X winding (2), (Common winding, if Auto). Default is 0.2.

Alternative way to enter R2 value. It is the actual resistances in ohms that matter. MVA and kV should be specified.

DSS property name: R2, DSS property index: 14

◆ phases()

BatchInt32ArrayProxy dss::obj::GICTransformerBatch::phases ( )

inline

Number of Phases.

Default is 3.

DSS property name: phases, DSS property index: 5

◆ R1()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::R1 ( )

inline

Resistance, each phase, ohms for H winding, (Series winding, if Auto).

Default is 0.0001. If

DSS property name: R1, DSS property index: 7

◆ R2()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::R2 ( )

inline

Resistance, each phase, ohms for X winding, (Common winding, if Auto).

Default is 0.0001.

DSS property name: R2, DSS property index: 8

◆ repair()

BatchFloat64ArrayProxy dss::obj::GICTransformerBatch::repair ( )

inline

Hours to repair.

DSS property name: repair, DSS property index: 20

◆ Type()

BatchInt32ArrayProxy dss::obj::GICTransformerBatch::Type ( )

inline

Type of transformer: {GSU* | Auto | YY}.

Default is GSU.

DSS property name: Type, DSS property index: 6

◆ Type_str()

strings dss::obj::GICTransformerBatch::Type_str ( )

inline

Type of transformer: {GSU* | Auto | YY}.

Default is GSU.

DSS property name: Type, DSS property index: 6

◆ VarCurve()

strings dss::obj::GICTransformerBatch::VarCurve ( )

inline

Optional.

XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12

◆ VarCurve_obj()

std::vector< dss::obj::XYcurve > dss::obj::GICTransformerBatch::VarCurve_obj ( )

inline

Optional.

XYCurve object name. Curve is expected as TOTAL pu vars vs pu GIC amps/phase. Vars are in pu of the MVA property. No Default value. Required only if you are going to export vars for power flow analysis. See K property.

DSS property name: VarCurve, DSS property index: 12

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

include/dss_obj.hpp

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ BusH()

◆ BusNH()

◆ BusNX()

◆ BusX()

◆ emergamps()

◆ enabled()

◆ faultrate()

◆ K()

◆ KVLL1()

◆ KVLL2()

◆ like() [1/2]

◆ like() [2/2]

◆ MVA()

◆ normamps()

◆ pctperm()

◆ pctR1()

◆ pctR2()

◆ phases()

◆ R1()

◆ R2()

◆ repair()

◆ Type()

◆ Type_str()

◆ VarCurve()

◆ VarCurve_obj()