DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
dss::obj::TransformerBatch Class Reference
Inheritance diagram for dss::obj::TransformerBatch:
[legend]
Collaboration diagram for dss::obj::TransformerBatch:
[legend]

Public Types

typedef Transformer::Properties Properties
 
typedef Transformer BatchElementClass
 

Public Member Functions

 TransformerBatch (APIUtil *util)
 Create a batch of all Transformer elements.
 
 TransformerBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
 Create a batch of all Transformer elements that match an integer property value.
 
 TransformerBatch (APIUtil *util, const char *regexp)
 Create a batch of all Transformer elements that match a regular expression.
 
TransformerBatchbegin_edit ()
 
TransformerBatchend_edit (int32_t num_edits=1)
 
BatchInt32ArrayProxy phases ()
 Number of phases this transformer. More...
 
TransformerBatchphases (int32_t value)
 
template<typename T >
TransformerBatchphases (T &value)
 
template<typename T >
TransformerBatchphases (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy windings ()
 Number of windings, this transformers. More...
 
TransformerBatchwindings (int32_t value)
 
template<typename T >
TransformerBatchwindings (T &value)
 
template<typename T >
TransformerBatchwindings (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy wdg ()
 Set this = to the number of the winding you wish to define. More...
 
TransformerBatchwdg (int32_t value)
 
template<typename T >
TransformerBatchwdg (T &value)
 
template<typename T >
TransformerBatchwdg (typename T::iterator it_begin, typename T::iterator it_end)
 
std::vector< strings > bus ()
 Bus connection spec for this winding. More...
 
TransformerBatchbus (strings &value)
 
std::vector< VectorXi > conn ()
 Connection of this winding {wye*, Delta, LN, LL}. More...
 
TransformerBatchconn (std::vector< int32_t > &value)
 
TransformerBatchconn (std::vector< Connection > &value)
 
TransformerBatchconn (strings &value)
 
TransformerBatchconn (std::vector< strings > &value)
 
std::vector< strings > conn_str ()
 Connection of this winding {wye*, Delta, LN, LL}. More...
 
TransformerBatchconn_str (strings &value)
 
std::vector< VectorXd > kV ()
 For 2-or 3-phase, enter phase-phase kV rating. More...
 
TransformerBatchkV (VectorXd &value)
 
std::vector< VectorXd > kVA ()
 Base kVA rating of the winding. More...
 
TransformerBatchkVA (VectorXd &value)
 
std::vector< VectorXd > tap ()
 Per unit tap that this winding is on. More...
 
TransformerBatchtap (VectorXd &value)
 
std::vector< VectorXd > pctR ()
 Percent resistance this winding. More...
 
TransformerBatchpctR (VectorXd &value)
 
std::vector< VectorXd > Rneut ()
 Default = -1. More...
 
TransformerBatchRneut (VectorXd &value)
 
std::vector< VectorXd > Xneut ()
 Neutral reactance of wye(star)-connected winding in actual ohms. More...
 
TransformerBatchXneut (VectorXd &value)
 
std::vector< strings > buses ()
 Use this to specify all the bus connections at once using an array. More...
 
TransformerBatchbuses (strings &value)
 
std::vector< VectorXi > conns ()
 Use this to specify all the Winding connections at once using an array. More...
 
TransformerBatchconns (std::vector< int32_t > &value)
 
TransformerBatchconns (std::vector< Connection > &value)
 
TransformerBatchconns (strings &value)
 
TransformerBatchconns (std::vector< strings > &value)
 
std::vector< strings > conns_str ()
 Use this to specify all the Winding connections at once using an array. More...
 
TransformerBatchconns_str (strings &value)
 
std::vector< VectorXd > kVs ()
 Use this to specify the kV ratings of all windings at once using an array. More...
 
TransformerBatchkVs (VectorXd &value)
 
std::vector< VectorXd > kVAs ()
 Use this to specify the kVA ratings of all windings at once using an array. More...
 
TransformerBatchkVAs (VectorXd &value)
 
std::vector< VectorXd > taps ()
 Use this to specify the p.u. More...
 
TransformerBatchtaps (VectorXd &value)
 
BatchFloat64ArrayProxy XHL ()
 Use this to specify the percent reactance, H-L (winding 1 to winding 2). More...
 
TransformerBatchXHL (double value)
 
template<typename T >
TransformerBatchXHL (T &value)
 
template<typename T >
TransformerBatchXHL (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy XHT ()
 Use this to specify the percent reactance, H-T (winding 1 to winding 3). More...
 
TransformerBatchXHT (double value)
 
template<typename T >
TransformerBatchXHT (T &value)
 
template<typename T >
TransformerBatchXHT (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy XLT ()
 Use this to specify the percent reactance, L-T (winding 2 to winding 3). More...
 
TransformerBatchXLT (double value)
 
template<typename T >
TransformerBatchXLT (T &value)
 
template<typename T >
TransformerBatchXLT (typename T::iterator it_begin, typename T::iterator it_end)
 
std::vector< VectorXd > Xscarray ()
 Use this to specify the percent reactance between all pairs of windings as an array. More...
 
TransformerBatchXscarray (VectorXd &value)
 
BatchFloat64ArrayProxy thermal ()
 Thermal time constant of the transformer in hours. More...
 
TransformerBatchthermal (double value)
 
template<typename T >
TransformerBatchthermal (T &value)
 
template<typename T >
TransformerBatchthermal (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy n ()
 n Exponent for thermal properties in IEEE C57. More...
 
TransformerBatchn (double value)
 
template<typename T >
TransformerBatchn (T &value)
 
template<typename T >
TransformerBatchn (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy m ()
 m Exponent for thermal properties in IEEE C57. More...
 
TransformerBatchm (double value)
 
template<typename T >
TransformerBatchm (T &value)
 
template<typename T >
TransformerBatchm (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy flrise ()
 Temperature rise, deg C, for full load. More...
 
TransformerBatchflrise (double value)
 
template<typename T >
TransformerBatchflrise (T &value)
 
template<typename T >
TransformerBatchflrise (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy hsrise ()
 Hot spot temperature rise, deg C. More...
 
TransformerBatchhsrise (double value)
 
template<typename T >
TransformerBatchhsrise (T &value)
 
template<typename T >
TransformerBatchhsrise (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy pctloadloss ()
 Percent load loss at full load. More...
 
TransformerBatchpctloadloss (double value)
 
template<typename T >
TransformerBatchpctloadloss (T &value)
 
template<typename T >
TransformerBatchpctloadloss (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy pctnoloadloss ()
 Percent no load losses at rated excitatation voltage. More...
 
TransformerBatchpctnoloadloss (double value)
 
template<typename T >
TransformerBatchpctnoloadloss (T &value)
 
template<typename T >
TransformerBatchpctnoloadloss (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy normhkVA ()
 Normal maximum kVA rating of H winding (winding 1). More...
 
TransformerBatchnormhkVA (double value)
 
template<typename T >
TransformerBatchnormhkVA (T &value)
 
template<typename T >
TransformerBatchnormhkVA (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy emerghkVA ()
 Emergency (contingency) kVA rating of H winding (winding 1). More...
 
TransformerBatchemerghkVA (double value)
 
template<typename T >
TransformerBatchemerghkVA (T &value)
 
template<typename T >
TransformerBatchemerghkVA (typename T::iterator it_begin, typename T::iterator it_end)
 
bools sub ()
 ={Yes|No} Designates whether this transformer is to be considered a substation.Default is No. More...
 
TransformerBatchsub (bool value)
 
TransformerBatchsub (bools &value)
 
std::vector< VectorXd > MaxTap ()
 Max per unit tap for the active winding. More...
 
TransformerBatchMaxTap (VectorXd &value)
 
std::vector< VectorXd > MinTap ()
 Min per unit tap for the active winding. More...
 
TransformerBatchMinTap (VectorXd &value)
 
std::vector< VectorXi > NumTaps ()
 Total number of taps between min and max tap. More...
 
TransformerBatchNumTaps (VectorXi &value)
 
TransformerBatchNumTaps (std::vector< VectorXi > &value)
 
strings subname ()
 Substation Name. More...
 
TransformerBatchsubname (const string &value)
 
TransformerBatchsubname (strings &value)
 
BatchFloat64ArrayProxy pctimag ()
 Percent magnetizing current. More...
 
TransformerBatchpctimag (double value)
 
template<typename T >
TransformerBatchpctimag (T &value)
 
template<typename T >
TransformerBatchpctimag (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy ppm_antifloat ()
 Default=1 ppm. More...
 
TransformerBatchppm_antifloat (double value)
 
template<typename T >
TransformerBatchppm_antifloat (T &value)
 
template<typename T >
TransformerBatchppm_antifloat (typename T::iterator it_begin, typename T::iterator it_end)
 
std::vector< VectorXd > pctRs ()
 Use this property to specify all the winding resistances using an array. More...
 
TransformerBatchpctRs (VectorXd &value)
 
strings bank ()
 Name of the bank this transformer is part of, for CIM, MultiSpeak, and other interfaces. More...
 
TransformerBatchbank (const string &value)
 
TransformerBatchbank (strings &value)
 
strings XfmrCode ()
 Name of a library entry for transformer properties. More...
 
TransformerBatchXfmrCode (dss::obj::XfmrCode &value)
 
TransformerBatchXfmrCode (const string &value)
 
std::vector< dss::obj::XfmrCodeXfmrCode_obj ()
 Name of a library entry for transformer properties. More...
 
TransformerBatchXfmrCode_obj (dss::obj::XfmrCode &value)
 
bools XRConst ()
 ={Yes|No} Default is NO. More...
 
TransformerBatchXRConst (bool value)
 
TransformerBatchXRConst (bools &value)
 
BatchFloat64ArrayProxy X12 ()
 Alternative to XHL for specifying the percent reactance from winding 1 to winding 2. More...
 
TransformerBatchX12 (double value)
 
template<typename T >
TransformerBatchX12 (T &value)
 
template<typename T >
TransformerBatchX12 (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy X13 ()
 Alternative to XHT for specifying the percent reactance from winding 1 to winding 3. More...
 
TransformerBatchX13 (double value)
 
template<typename T >
TransformerBatchX13 (T &value)
 
template<typename T >
TransformerBatchX13 (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy X23 ()
 Alternative to XLT for specifying the percent reactance from winding 2 to winding 3.Use for 3-winding transformers only. More...
 
TransformerBatchX23 (double value)
 
template<typename T >
TransformerBatchX23 (T &value)
 
template<typename T >
TransformerBatchX23 (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy LeadLag ()
 {Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding. More...
 
TransformerBatchLeadLag (string &value)
 
TransformerBatchLeadLag (int32_t value)
 
TransformerBatchLeadLag (PhaseSequence value)
 
TransformerBatchLeadLag (strings &value)
 
TransformerBatchLeadLag (std::vector< int32_t > &value)
 
TransformerBatchLeadLag (std::vector< PhaseSequence > &value)
 
strings LeadLag_str ()
 {Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding. More...
 
TransformerBatchLeadLag_str (string &value)
 
TransformerBatchLeadLag_str (strings &value)
 
strings WdgCurrents ()
 (Read only) Makes winding currents available via return on query (? Transformer.TX.WdgCurrents). More...
 
BatchInt32ArrayProxy Core ()
 {Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type. More...
 
TransformerBatchCore (string &value)
 
TransformerBatchCore (int32_t value)
 
TransformerBatchCore (CoreType value)
 
TransformerBatchCore (strings &value)
 
TransformerBatchCore (std::vector< int32_t > &value)
 
TransformerBatchCore (std::vector< CoreType > &value)
 
strings Core_str ()
 {Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type. More...
 
TransformerBatchCore_str (string &value)
 
TransformerBatchCore_str (strings &value)
 
std::vector< VectorXd > RdcOhms ()
 Winding dc resistance in OHMS. More...
 
TransformerBatchRdcOhms (VectorXd &value)
 
BatchInt32ArrayProxy Seasons ()
 Defines the number of ratings to be defined for the transfomer, to be used only when defining seasonal ratings using the "Ratings" property. More...
 
TransformerBatchSeasons (int32_t value)
 
template<typename T >
TransformerBatchSeasons (T &value)
 
template<typename T >
TransformerBatchSeasons (typename T::iterator it_begin, typename T::iterator it_end)
 
std::vector< VectorXd > Ratings ()
 An array of ratings to be used when the seasonal ratings flag is True. More...
 
TransformerBatchRatings (VectorXd &value)
 
BatchFloat64ArrayProxy normamps ()
 Normal rated current. More...
 
TransformerBatchnormamps (double value)
 
template<typename T >
TransformerBatchnormamps (T &value)
 
template<typename T >
TransformerBatchnormamps (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy emergamps ()
 Maximum or emerg current. More...
 
TransformerBatchemergamps (double value)
 
template<typename T >
TransformerBatchemergamps (T &value)
 
template<typename T >
TransformerBatchemergamps (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy faultrate ()
 Failure rate per year. More...
 
TransformerBatchfaultrate (double value)
 
template<typename T >
TransformerBatchfaultrate (T &value)
 
template<typename T >
TransformerBatchfaultrate (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy pctperm ()
 Percent of failures that become permanent. More...
 
TransformerBatchpctperm (double value)
 
template<typename T >
TransformerBatchpctperm (T &value)
 
template<typename T >
TransformerBatchpctperm (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy repair ()
 Hours to repair. More...
 
TransformerBatchrepair (double value)
 
template<typename T >
TransformerBatchrepair (T &value)
 
template<typename T >
TransformerBatchrepair (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy basefreq ()
 Base Frequency for ratings. More...
 
TransformerBatchbasefreq (double value)
 
template<typename T >
TransformerBatchbasefreq (T &value)
 
template<typename T >
TransformerBatchbasefreq (typename T::iterator it_begin, typename T::iterator it_end)
 
bools enabled ()
 {Yes|No or True|False} Indicates whether this element is enabled. More...
 
TransformerBatchenabled (bool value)
 
TransformerBatchenabled (bools &value)
 
TransformerBatchlike (const string &value)
 Make like another object, e.g. More...
 
TransformerBatchlike (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
APIUtilapi_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>
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

◆ bank()

strings dss::obj::TransformerBatch::bank ( )
inline

Name of the bank this transformer is part of, for CIM, MultiSpeak, and other interfaces.

DSS property name: bank, DSS property index: 38

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::basefreq ( )
inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 55

◆ bus()

std::vector< strings > dss::obj::TransformerBatch::bus ( )
inline

Bus connection spec for this winding.

DSS property name: bus, DSS property index: 4

◆ buses()

std::vector< strings > dss::obj::TransformerBatch::buses ( )
inline

Use this to specify all the bus connections at once using an array.

Example:

New Transformer.T1 buses="Hibus, lowbus"

DSS property name: buses, DSS property index: 12

◆ conn()

std::vector< VectorXi > dss::obj::TransformerBatch::conn ( )
inline

Connection of this winding {wye*, Delta, LN, LL}.

Default is "wye" with the neutral solidly grounded.

DSS property name: conn, DSS property index: 5

◆ conn_str()

std::vector< strings > dss::obj::TransformerBatch::conn_str ( )
inline

Connection of this winding {wye*, Delta, LN, LL}.

Default is "wye" with the neutral solidly grounded.

DSS property name: conn, DSS property index: 5

◆ conns()

std::vector< VectorXi > dss::obj::TransformerBatch::conns ( )
inline

Use this to specify all the Winding connections at once using an array.

Example:

New Transformer.T1 buses="Hibus, lowbus" ~ conns=(delta, wye)

DSS property name: conns, DSS property index: 13

◆ conns_str()

std::vector< strings > dss::obj::TransformerBatch::conns_str ( )
inline

Use this to specify all the Winding connections at once using an array.

Example:

New Transformer.T1 buses="Hibus, lowbus" ~ conns=(delta, wye)

DSS property name: conns, DSS property index: 13

◆ Core()

BatchInt32ArrayProxy dss::obj::TransformerBatch::Core ( )
inline

{Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type.

Used for GIC analysis

DSS property name: Core, DSS property index: 46

◆ Core_str()

strings dss::obj::TransformerBatch::Core_str ( )
inline

{Shell*|5-leg|3-Leg|1-phase|core-1-phase|4-leg} Core Type.

Used for GIC analysis

DSS property name: Core, DSS property index: 46

◆ emergamps()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::emergamps ( )
inline

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 51

◆ emerghkVA()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::emerghkVA ( )
inline

Emergency (contingency) kVA rating of H winding (winding 1).

Usually 140% - 150% ofmaximum nameplate rating, depending on load shape. Defaults to 150% of kVA rating of Winding 1.

DSS property name: emerghkVA, DSS property index: 29

◆ enabled()

bools dss::obj::TransformerBatch::enabled ( )
inline

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

DSS property name: enabled, DSS property index: 56

◆ faultrate()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::faultrate ( )
inline

Failure rate per year.

DSS property name: faultrate, DSS property index: 52

◆ flrise()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::flrise ( )
inline

Temperature rise, deg C, for full load.

Default is 65.

DSS property name: flrise, DSS property index: 24

◆ hsrise()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::hsrise ( )
inline

Hot spot temperature rise, deg C.

Default is 15.

DSS property name: hsrise, DSS property index: 25

◆ kV()

std::vector< VectorXd > dss::obj::TransformerBatch::kV ( )
inline

For 2-or 3-phase, enter phase-phase kV rating.

Otherwise, kV rating of the actual winding

DSS property name: kV, DSS property index: 6

◆ kVA()

std::vector< VectorXd > dss::obj::TransformerBatch::kVA ( )
inline

Base kVA rating of the winding.

Side effect: forces change of max normal and emerg kVA ratings.If 2-winding transformer, forces other winding to same value. When winding 1 is defined, all other windings are defaulted to the same rating and the first two winding resistances are defaulted to the loadloss value.

DSS property name: kVA, DSS property index: 7

◆ kVAs()

std::vector< VectorXd > dss::obj::TransformerBatch::kVAs ( )
inline

Use this to specify the kVA ratings of all windings at once using an array.

DSS property name: kVAs, DSS property index: 15

◆ kVs()

std::vector< VectorXd > dss::obj::TransformerBatch::kVs ( )
inline

Use this to specify the kV ratings of all windings at once using an array.

Example:

New Transformer.T1 buses="Hibus, lowbus" ~ conns=(delta, wye) ~ kvs=(115, 12.47)

See kV= property for voltage rules.

DSS property name: kVs, DSS property index: 14

◆ LeadLag()

BatchInt32ArrayProxy dss::obj::TransformerBatch::LeadLag ( )
inline

{Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding.

Default is ANSI 30 deg lag, e.g., Dy1 of Yd1 vector group. To get typical European Dy11 connection, specify either "lead" or "Euro"

DSS property name: LeadLag, DSS property index: 44

◆ LeadLag_str()

strings dss::obj::TransformerBatch::LeadLag_str ( )
inline

{Lead | Lag (default) | ANSI (default) | Euro } Designation in mixed Delta-wye connections the relationship between HV to LV winding.

Default is ANSI 30 deg lag, e.g., Dy1 of Yd1 vector group. To get typical European Dy11 connection, specify either "lead" or "Euro"

DSS property name: LeadLag, DSS property index: 44

◆ like() [1/2]

TransformerBatch & dss::obj::TransformerBatch::like ( const char *  value)
inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 57

◆ like() [2/2]

TransformerBatch & dss::obj::TransformerBatch::like ( const string &  value)
inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 57

◆ m()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::m ( )
inline

m Exponent for thermal properties in IEEE C57.

Typically 0.9 - 1.0

DSS property name: m, DSS property index: 23

◆ MaxTap()

std::vector< VectorXd > dss::obj::TransformerBatch::MaxTap ( )
inline

Max per unit tap for the active winding.

Default is 1.10

DSS property name: MaxTap, DSS property index: 31

◆ MinTap()

std::vector< VectorXd > dss::obj::TransformerBatch::MinTap ( )
inline

Min per unit tap for the active winding.

Default is 0.90

DSS property name: MinTap, DSS property index: 32

◆ n()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::n ( )
inline

n Exponent for thermal properties in IEEE C57.

Typically 0.8.

DSS property name: n, DSS property index: 22

◆ normamps()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::normamps ( )
inline

Normal rated current.

DSS property name: normamps, DSS property index: 50

◆ normhkVA()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::normhkVA ( )
inline

Normal maximum kVA rating of H winding (winding 1).

Usually 100% - 110% ofmaximum nameplate rating, depending on load shape. Defaults to 110% of kVA rating of Winding 1.

DSS property name: normhkVA, DSS property index: 28

◆ NumTaps()

std::vector< VectorXi > dss::obj::TransformerBatch::NumTaps ( )
inline

Total number of taps between min and max tap.

Default is 32 (16 raise and 16 lower taps about the neutral position). The neutral position is not counted.

DSS property name: NumTaps, DSS property index: 33

◆ pctimag()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::pctimag ( )
inline

Percent magnetizing current.

Default=0.0. Magnetizing branch is in parallel with windings in each phase. Also, see "ppm_antifloat".

DSS property name: imag, DSS property index: 35

◆ pctloadloss()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::pctloadloss ( )
inline

Percent load loss at full load.

The R of the High and Low windings (1 and 2) are adjusted to agree at rated kVA loading.

DSS property name: loadloss, DSS property index: 26

◆ pctnoloadloss()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::pctnoloadloss ( )
inline

Percent no load losses at rated excitatation voltage.

Default is 0. Converts to a resistance in parallel with the magnetizing impedance in each winding.

DSS property name: noloadloss, DSS property index: 27

◆ pctperm()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::pctperm ( )
inline

Percent of failures that become permanent.

DSS property name: pctperm, DSS property index: 53

◆ pctR()

std::vector< VectorXd > dss::obj::TransformerBatch::pctR ( )
inline

Percent resistance this winding.

(half of total for a 2-winding).

DSS property name: R, DSS property index: 9

◆ pctRs()

std::vector< VectorXd > dss::obj::TransformerBatch::pctRs ( )
inline

Use this property to specify all the winding resistances using an array.

Example:

New Transformer.T1 buses="Hibus, lowbus" ~ Rs=(0.2 0.3)

DSS property name: Rs, DSS property index: 37

◆ phases()

BatchInt32ArrayProxy dss::obj::TransformerBatch::phases ( )
inline

Number of phases this transformer.

Default is 3.

DSS property name: phases, DSS property index: 1

◆ ppm_antifloat()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::ppm_antifloat ( )
inline

Default=1 ppm.

Parts per million of transformer winding VA rating connected to ground to protect against accidentally floating a winding without a reference. If positive then the effect is adding a very large reactance to ground. If negative, then a capacitor.

DSS property name: ppm_antifloat, DSS property index: 36

◆ Ratings()

std::vector< VectorXd > dss::obj::TransformerBatch::Ratings ( )
inline

An array of ratings to be used when the seasonal ratings flag is True.

It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in transformers. Is given in kVA

DSS property name: Ratings, DSS property index: 49

◆ RdcOhms()

std::vector< VectorXd > dss::obj::TransformerBatch::RdcOhms ( )
inline

Winding dc resistance in OHMS.

Useful for GIC analysis. From transformer test report. Defaults to 85% of R property

DSS property name: RdcOhms, DSS property index: 47

◆ repair()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::repair ( )
inline

Hours to repair.

DSS property name: repair, DSS property index: 54

◆ Rneut()

std::vector< VectorXd > dss::obj::TransformerBatch::Rneut ( )
inline

Default = -1.

Neutral resistance of wye (star)-connected winding in actual ohms. If entered as a negative value, the neutral is assumed to be open, or floating. To solidly ground the neutral, connect the neutral conductor to Node 0 in the Bus property spec for this winding. For example: Bus=MyBusName.1.2.3.0, which is generally the default connection.

DSS property name: Rneut, DSS property index: 10

◆ Seasons()

BatchInt32ArrayProxy dss::obj::TransformerBatch::Seasons ( )
inline

Defines the number of ratings to be defined for the transfomer, to be used only when defining seasonal ratings using the "Ratings" property.

DSS property name: Seasons, DSS property index: 48

◆ sub()

bools dss::obj::TransformerBatch::sub ( )
inline

={Yes|No} Designates whether this transformer is to be considered a substation.Default is No.

DSS property name: sub, DSS property index: 30

◆ subname()

strings dss::obj::TransformerBatch::subname ( )
inline

Substation Name.

Optional. Default is null. If specified, printed on plots

DSS property name: subname, DSS property index: 34

◆ tap()

std::vector< VectorXd > dss::obj::TransformerBatch::tap ( )
inline

Per unit tap that this winding is on.

DSS property name: tap, DSS property index: 8

◆ taps()

std::vector< VectorXd > dss::obj::TransformerBatch::taps ( )
inline

Use this to specify the p.u.

tap of all windings at once using an array.

DSS property name: taps, DSS property index: 16

◆ thermal()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::thermal ( )
inline

Thermal time constant of the transformer in hours.

Typically about 2.

DSS property name: thermal, DSS property index: 21

◆ wdg()

BatchInt32ArrayProxy dss::obj::TransformerBatch::wdg ( )
inline

Set this = to the number of the winding you wish to define.

Then set the values for this winding. Repeat for each winding. Alternatively, use the array collections (buses, kVAs, etc.) to define the windings. Note: reactances are BETWEEN pairs of windings; they are not the property of a single winding.

DSS property name: wdg, DSS property index: 3

◆ WdgCurrents()

strings dss::obj::TransformerBatch::WdgCurrents ( )
inline

(Read only) Makes winding currents available via return on query (? Transformer.TX.WdgCurrents).

Order: Phase 1, Wdg 1, Wdg 2, ..., Phase 2 ...

DSS property name: WdgCurrents, DSS property index: 45

◆ windings()

BatchInt32ArrayProxy dss::obj::TransformerBatch::windings ( )
inline

Number of windings, this transformers.

(Also is the number of terminals) Default is 2. This property triggers memory allocation for the Transformer and will cause other properties to revert to default values.

DSS property name: windings, DSS property index: 2

◆ X12()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::X12 ( )
inline

Alternative to XHL for specifying the percent reactance from winding 1 to winding 2.

Use for 2- or 3-winding transformers. Percent on the kVA base of winding 1.

DSS property name: X12, DSS property index: 41

◆ X13()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::X13 ( )
inline

Alternative to XHT for specifying the percent reactance from winding 1 to winding 3.

Use for 3-winding transformers only. Percent on the kVA base of winding 1.

DSS property name: X13, DSS property index: 42

◆ X23()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::X23 ( )
inline

Alternative to XLT for specifying the percent reactance from winding 2 to winding 3.Use for 3-winding transformers only.

Percent on the kVA base of winding 1.

DSS property name: X23, DSS property index: 43

◆ XfmrCode()

strings dss::obj::TransformerBatch::XfmrCode ( )
inline

Name of a library entry for transformer properties.

The named XfmrCode must already be defined.

DSS property name: XfmrCode, DSS property index: 39

◆ XfmrCode_obj()

std::vector< dss::obj::XfmrCode > dss::obj::TransformerBatch::XfmrCode_obj ( )
inline

Name of a library entry for transformer properties.

The named XfmrCode must already be defined.

DSS property name: XfmrCode, DSS property index: 39

◆ XHL()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::XHL ( )
inline

Use this to specify the percent reactance, H-L (winding 1 to winding 2).

Use for 2- or 3-winding transformers. On the kVA base of winding 1. See also X12.

DSS property name: XHL, DSS property index: 17

◆ XHT()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::XHT ( )
inline

Use this to specify the percent reactance, H-T (winding 1 to winding 3).

Use for 3-winding transformers only. On the kVA base of winding 1. See also X13.

DSS property name: XHT, DSS property index: 18

◆ XLT()

BatchFloat64ArrayProxy dss::obj::TransformerBatch::XLT ( )
inline

Use this to specify the percent reactance, L-T (winding 2 to winding 3).

Use for 3-winding transformers only. On the kVA base of winding 1. See also X23.

DSS property name: XLT, DSS property index: 19

◆ Xneut()

std::vector< VectorXd > dss::obj::TransformerBatch::Xneut ( )
inline

Neutral reactance of wye(star)-connected winding in actual ohms.

May be + or -.

DSS property name: Xneut, DSS property index: 11

◆ XRConst()

bools dss::obj::TransformerBatch::XRConst ( )
inline

={Yes|No} Default is NO.

Signifies whether or not the X/R is assumed contant for harmonic studies.

DSS property name: XRConst, DSS property index: 40

◆ Xscarray()

std::vector< VectorXd > dss::obj::TransformerBatch::Xscarray ( )
inline

Use this to specify the percent reactance between all pairs of windings as an array.

All values are on the kVA base of winding 1. The order of the values is as follows:

(x12 13 14... 23 24.. 34 ..)

There will be n(n-1)/2 values, where n=number of windings.

DSS property name: Xscarray, DSS property index: 20


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