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::TSDataBatch Class Reference
Inheritance diagram for dss::obj::TSDataBatch:
[legend]
Collaboration diagram for dss::obj::TSDataBatch:
[legend]

Public Types

typedef TSData::Properties Properties
 
typedef TSData BatchElementClass
 

Public Member Functions

 TSDataBatch (APIUtil *util)
 Create a batch of all TSData elements.
 
 TSDataBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
 Create a batch of all TSData elements that match an integer property value.
 
 TSDataBatch (APIUtil *util, const char *regexp)
 Create a batch of all TSData elements that match a regular expression.
 
TSDataBatchbegin_edit ()
 
TSDataBatchend_edit (int32_t num_edits=1)
 
BatchFloat64ArrayProxy DiaShield ()
 Diameter over tape shield; same units as radius; no default. More...
 
TSDataBatchDiaShield (double value)
 
template<typename T >
TSDataBatchDiaShield (T &value)
 
template<typename T >
TSDataBatchDiaShield (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy TapeLayer ()
 Tape shield thickness; same units as radius; no default. More...
 
TSDataBatchTapeLayer (double value)
 
template<typename T >
TSDataBatchTapeLayer (T &value)
 
template<typename T >
TSDataBatchTapeLayer (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy TapeLap ()
 Tape Lap in percent; default 20.0. More...
 
TSDataBatchTapeLap (double value)
 
template<typename T >
TSDataBatchTapeLap (T &value)
 
template<typename T >
TSDataBatchTapeLap (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy EpsR ()
 Insulation layer relative permittivity; default is 2.3. More...
 
TSDataBatchEpsR (double value)
 
template<typename T >
TSDataBatchEpsR (T &value)
 
template<typename T >
TSDataBatchEpsR (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy InsLayer ()
 Insulation layer thickness; same units as radius; no default. More...
 
TSDataBatchInsLayer (double value)
 
template<typename T >
TSDataBatchInsLayer (T &value)
 
template<typename T >
TSDataBatchInsLayer (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy DiaIns ()
 Diameter over insulation layer; same units as radius; no default. More...
 
TSDataBatchDiaIns (double value)
 
template<typename T >
TSDataBatchDiaIns (T &value)
 
template<typename T >
TSDataBatchDiaIns (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy DiaCable ()
 Diameter over cable; same units as radius; no default. More...
 
TSDataBatchDiaCable (double value)
 
template<typename T >
TSDataBatchDiaCable (T &value)
 
template<typename T >
TSDataBatchDiaCable (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy Rdc ()
 dc Resistance, ohms per unit length (see Runits). More...
 
TSDataBatchRdc (double value)
 
template<typename T >
TSDataBatchRdc (T &value)
 
template<typename T >
TSDataBatchRdc (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy Rac ()
 Resistance at 60 Hz per unit length. More...
 
TSDataBatchRac (double value)
 
template<typename T >
TSDataBatchRac (T &value)
 
template<typename T >
TSDataBatchRac (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy Runits ()
 Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
TSDataBatchRunits (string &value)
 
TSDataBatchRunits (int32_t value)
 
TSDataBatchRunits (DimensionUnits value)
 
TSDataBatchRunits (strings &value)
 
TSDataBatchRunits (std::vector< int32_t > &value)
 
TSDataBatchRunits (std::vector< DimensionUnits > &value)
 
strings Runits_str ()
 Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
TSDataBatchRunits_str (string &value)
 
TSDataBatchRunits_str (strings &value)
 
BatchFloat64ArrayProxy GMRac ()
 GMR at 60 Hz. More...
 
TSDataBatchGMRac (double value)
 
template<typename T >
TSDataBatchGMRac (T &value)
 
template<typename T >
TSDataBatchGMRac (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy GMRunits ()
 Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
TSDataBatchGMRunits (string &value)
 
TSDataBatchGMRunits (int32_t value)
 
TSDataBatchGMRunits (DimensionUnits value)
 
TSDataBatchGMRunits (strings &value)
 
TSDataBatchGMRunits (std::vector< int32_t > &value)
 
TSDataBatchGMRunits (std::vector< DimensionUnits > &value)
 
strings GMRunits_str ()
 Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
TSDataBatchGMRunits_str (string &value)
 
TSDataBatchGMRunits_str (strings &value)
 
BatchFloat64ArrayProxy radius ()
 Outside radius of conductor. More...
 
TSDataBatchradius (double value)
 
template<typename T >
TSDataBatchradius (T &value)
 
template<typename T >
TSDataBatchradius (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy radunits ()
 Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
TSDataBatchradunits (string &value)
 
TSDataBatchradunits (int32_t value)
 
TSDataBatchradunits (DimensionUnits value)
 
TSDataBatchradunits (strings &value)
 
TSDataBatchradunits (std::vector< int32_t > &value)
 
TSDataBatchradunits (std::vector< DimensionUnits > &value)
 
strings radunits_str ()
 Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
TSDataBatchradunits_str (string &value)
 
TSDataBatchradunits_str (strings &value)
 
BatchFloat64ArrayProxy normamps ()
 Normal ampacity, amperes. More...
 
TSDataBatchnormamps (double value)
 
template<typename T >
TSDataBatchnormamps (T &value)
 
template<typename T >
TSDataBatchnormamps (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy emergamps ()
 Emergency ampacity, amperes. More...
 
TSDataBatchemergamps (double value)
 
template<typename T >
TSDataBatchemergamps (T &value)
 
template<typename T >
TSDataBatchemergamps (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy diam ()
 Diameter; Alternative method for entering radius. More...
 
TSDataBatchdiam (double value)
 
template<typename T >
TSDataBatchdiam (T &value)
 
template<typename T >
TSDataBatchdiam (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy Seasons ()
 Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the "Ratings" property. More...
 
TSDataBatchSeasons (int32_t value)
 
template<typename T >
TSDataBatchSeasons (T &value)
 
template<typename T >
TSDataBatchSeasons (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...
 
TSDataBatchRatings (VectorXd &value)
 
BatchFloat64ArrayProxy Capradius ()
 Equivalent conductor radius for capacitance calcs. More...
 
TSDataBatchCapradius (double value)
 
template<typename T >
TSDataBatchCapradius (T &value)
 
template<typename T >
TSDataBatchCapradius (typename T::iterator it_begin, typename T::iterator it_end)
 
TSDataBatchlike (const string &value)
 Make like another object, e.g. More...
 
TSDataBatchlike (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

◆ Capradius()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::Capradius ( )
inline

Equivalent conductor radius for capacitance calcs.

Specify this for bundled conductors. Defaults to same value as radius. Define Diam or Radius property first.

DSS property name: Capradius, DSS property index: 20

◆ DiaCable()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::DiaCable ( )
inline

Diameter over cable; same units as radius; no default.

DSS property name: DiaCable, DSS property index: 7

◆ DiaIns()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::DiaIns ( )
inline

Diameter over insulation layer; same units as radius; no default.

Establishes outer radius for capacitance calculation.

DSS property name: DiaIns, DSS property index: 6

◆ diam()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::diam ( )
inline

Diameter; Alternative method for entering radius.

DSS property name: diam, DSS property index: 17

◆ DiaShield()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::DiaShield ( )
inline

Diameter over tape shield; same units as radius; no default.

DSS property name: DiaShield, DSS property index: 1

◆ emergamps()

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

Emergency ampacity, amperes.

Defaults to 1.5 * Normal Amps if not specified.

DSS property name: emergamps, DSS property index: 16

◆ EpsR()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::EpsR ( )
inline

Insulation layer relative permittivity; default is 2.3.

DSS property name: EpsR, DSS property index: 4

◆ GMRac()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::GMRac ( )
inline

GMR at 60 Hz.

Defaults to .7788*radius if not specified.

DSS property name: GMRac, DSS property index: 11

◆ GMRunits()

BatchInt32ArrayProxy dss::obj::TSDataBatch::GMRunits ( )
inline

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 12

◆ GMRunits_str()

strings dss::obj::TSDataBatch::GMRunits_str ( )
inline

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 12

◆ InsLayer()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::InsLayer ( )
inline

Insulation layer thickness; same units as radius; no default.

With DiaIns, establishes inner radius for capacitance calculation.

DSS property name: InsLayer, DSS property index: 5

◆ like() [1/2]

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

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 21

◆ like() [2/2]

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

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 21

◆ normamps()

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

Normal ampacity, amperes.

Defaults to Emergency amps/1.5 if not specified.

DSS property name: normamps, DSS property index: 15

◆ Rac()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::Rac ( )
inline

Resistance at 60 Hz per unit length.

Defaults to 1.02*Rdc if not specified.

DSS property name: Rac, DSS property index: 9

◆ radius()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::radius ( )
inline

Outside radius of conductor.

Defaults to GMR/0.7788 if not specified.

DSS property name: radius, DSS property index: 13

◆ radunits()

BatchInt32ArrayProxy dss::obj::TSDataBatch::radunits ( )
inline

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 14

◆ radunits_str()

strings dss::obj::TSDataBatch::radunits_str ( )
inline

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 14

◆ Ratings()

std::vector< VectorXd > dss::obj::TSDataBatch::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 lines.

DSS property name: Ratings, DSS property index: 19

◆ Rdc()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::Rdc ( )
inline

dc Resistance, ohms per unit length (see Runits).

Defaults to Rac/1.02 if not specified.

DSS property name: Rdc, DSS property index: 8

◆ Runits()

BatchInt32ArrayProxy dss::obj::TSDataBatch::Runits ( )
inline

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 10

◆ Runits_str()

strings dss::obj::TSDataBatch::Runits_str ( )
inline

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 10

◆ Seasons()

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

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

DSS property name: Seasons, DSS property index: 18

◆ TapeLap()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::TapeLap ( )
inline

Tape Lap in percent; default 20.0.

DSS property name: TapeLap, DSS property index: 3

◆ TapeLayer()

BatchFloat64ArrayProxy dss::obj::TSDataBatch::TapeLayer ( )
inline

Tape shield thickness; same units as radius; no default.

DSS property name: TapeLayer, DSS property index: 2


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