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

Public Types

typedef CNData::Properties Properties
 
typedef CNData BatchElementClass
 

Public Member Functions

 CNDataBatch (APIUtil *util)
 Create a batch of all CNData elements.
 
 CNDataBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
 Create a batch of all CNData elements that match an integer property value.
 
 CNDataBatch (APIUtil *util, const char *regexp)
 Create a batch of all CNData elements that match a regular expression.
 
CNDataBatchbegin_edit ()
 
CNDataBatchend_edit (int32_t num_edits=1)
 
BatchInt32ArrayProxy k ()
 Number of concentric neutral strands; default is 2. More...
 
CNDataBatchk (int32_t value)
 
template<typename T >
CNDataBatchk (T &value)
 
template<typename T >
CNDataBatchk (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy DiaStrand ()
 Diameter of a concentric neutral strand; same units as core conductor radius; no default. More...
 
CNDataBatchDiaStrand (double value)
 
template<typename T >
CNDataBatchDiaStrand (T &value)
 
template<typename T >
CNDataBatchDiaStrand (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy GmrStrand ()
 Geometric mean radius of a concentric neutral strand; same units as core conductor GMR; defaults to 0.7788 * CN strand radius. More...
 
CNDataBatchGmrStrand (double value)
 
template<typename T >
CNDataBatchGmrStrand (T &value)
 
template<typename T >
CNDataBatchGmrStrand (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy Rstrand ()
 AC resistance of a concentric neutral strand; same units as core conductor resistance; no default. More...
 
CNDataBatchRstrand (double value)
 
template<typename T >
CNDataBatchRstrand (T &value)
 
template<typename T >
CNDataBatchRstrand (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy EpsR ()
 Insulation layer relative permittivity; default is 2.3. More...
 
CNDataBatchEpsR (double value)
 
template<typename T >
CNDataBatchEpsR (T &value)
 
template<typename T >
CNDataBatchEpsR (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy InsLayer ()
 Insulation layer thickness; same units as radius; no default. More...
 
CNDataBatchInsLayer (double value)
 
template<typename T >
CNDataBatchInsLayer (T &value)
 
template<typename T >
CNDataBatchInsLayer (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy DiaIns ()
 Diameter over insulation layer; same units as radius; no default. More...
 
CNDataBatchDiaIns (double value)
 
template<typename T >
CNDataBatchDiaIns (T &value)
 
template<typename T >
CNDataBatchDiaIns (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy DiaCable ()
 Diameter over cable; same units as radius; no default. More...
 
CNDataBatchDiaCable (double value)
 
template<typename T >
CNDataBatchDiaCable (T &value)
 
template<typename T >
CNDataBatchDiaCable (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy Rdc ()
 dc Resistance, ohms per unit length (see Runits). More...
 
CNDataBatchRdc (double value)
 
template<typename T >
CNDataBatchRdc (T &value)
 
template<typename T >
CNDataBatchRdc (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy Rac ()
 Resistance at 60 Hz per unit length. More...
 
CNDataBatchRac (double value)
 
template<typename T >
CNDataBatchRac (T &value)
 
template<typename T >
CNDataBatchRac (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...
 
CNDataBatchRunits (string &value)
 
CNDataBatchRunits (int32_t value)
 
CNDataBatchRunits (DimensionUnits value)
 
CNDataBatchRunits (strings &value)
 
CNDataBatchRunits (std::vector< int32_t > &value)
 
CNDataBatchRunits (std::vector< DimensionUnits > &value)
 
strings Runits_str ()
 Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
CNDataBatchRunits_str (string &value)
 
CNDataBatchRunits_str (strings &value)
 
BatchFloat64ArrayProxy GMRac ()
 GMR at 60 Hz. More...
 
CNDataBatchGMRac (double value)
 
template<typename T >
CNDataBatchGMRac (T &value)
 
template<typename T >
CNDataBatchGMRac (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...
 
CNDataBatchGMRunits (string &value)
 
CNDataBatchGMRunits (int32_t value)
 
CNDataBatchGMRunits (DimensionUnits value)
 
CNDataBatchGMRunits (strings &value)
 
CNDataBatchGMRunits (std::vector< int32_t > &value)
 
CNDataBatchGMRunits (std::vector< DimensionUnits > &value)
 
strings GMRunits_str ()
 Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
CNDataBatchGMRunits_str (string &value)
 
CNDataBatchGMRunits_str (strings &value)
 
BatchFloat64ArrayProxy radius ()
 Outside radius of conductor. More...
 
CNDataBatchradius (double value)
 
template<typename T >
CNDataBatchradius (T &value)
 
template<typename T >
CNDataBatchradius (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...
 
CNDataBatchradunits (string &value)
 
CNDataBatchradunits (int32_t value)
 
CNDataBatchradunits (DimensionUnits value)
 
CNDataBatchradunits (strings &value)
 
CNDataBatchradunits (std::vector< int32_t > &value)
 
CNDataBatchradunits (std::vector< DimensionUnits > &value)
 
strings radunits_str ()
 Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More...
 
CNDataBatchradunits_str (string &value)
 
CNDataBatchradunits_str (strings &value)
 
BatchFloat64ArrayProxy normamps ()
 Normal ampacity, amperes. More...
 
CNDataBatchnormamps (double value)
 
template<typename T >
CNDataBatchnormamps (T &value)
 
template<typename T >
CNDataBatchnormamps (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy emergamps ()
 Emergency ampacity, amperes. More...
 
CNDataBatchemergamps (double value)
 
template<typename T >
CNDataBatchemergamps (T &value)
 
template<typename T >
CNDataBatchemergamps (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy diam ()
 Diameter; Alternative method for entering radius. More...
 
CNDataBatchdiam (double value)
 
template<typename T >
CNDataBatchdiam (T &value)
 
template<typename T >
CNDataBatchdiam (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...
 
CNDataBatchSeasons (int32_t value)
 
template<typename T >
CNDataBatchSeasons (T &value)
 
template<typename T >
CNDataBatchSeasons (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...
 
CNDataBatchRatings (VectorXd &value)
 
BatchFloat64ArrayProxy Capradius ()
 Equivalent conductor radius for capacitance calcs. More...
 
CNDataBatchCapradius (double value)
 
template<typename T >
CNDataBatchCapradius (T &value)
 
template<typename T >
CNDataBatchCapradius (typename T::iterator it_begin, typename T::iterator it_end)
 
CNDataBatchlike (const string &value)
 Make like another object, e.g. More...
 
CNDataBatchlike (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::CNDataBatch::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: 21

◆ DiaCable()

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

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

DSS property name: DiaCable, DSS property index: 8

◆ DiaIns()

BatchFloat64ArrayProxy dss::obj::CNDataBatch::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: 7

◆ diam()

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

Diameter; Alternative method for entering radius.

DSS property name: diam, DSS property index: 18

◆ DiaStrand()

BatchFloat64ArrayProxy dss::obj::CNDataBatch::DiaStrand ( )
inline

Diameter of a concentric neutral strand; same units as core conductor radius; no default.

DSS property name: DiaStrand, DSS property index: 2

◆ emergamps()

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

Emergency ampacity, amperes.

Defaults to 1.5 * Normal Amps if not specified.

DSS property name: emergamps, DSS property index: 17

◆ EpsR()

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

Insulation layer relative permittivity; default is 2.3.

DSS property name: EpsR, DSS property index: 5

◆ GMRac()

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

GMR at 60 Hz.

Defaults to .7788*radius if not specified.

DSS property name: GMRac, DSS property index: 12

◆ GmrStrand()

BatchFloat64ArrayProxy dss::obj::CNDataBatch::GmrStrand ( )
inline

Geometric mean radius of a concentric neutral strand; same units as core conductor GMR; defaults to 0.7788 * CN strand radius.

DSS property name: GmrStrand, DSS property index: 3

◆ GMRunits()

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

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

DSS property name: GMRunits, DSS property index: 13

◆ GMRunits_str()

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

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

DSS property name: GMRunits, DSS property index: 13

◆ InsLayer()

BatchFloat64ArrayProxy dss::obj::CNDataBatch::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: 6

◆ k()

BatchInt32ArrayProxy dss::obj::CNDataBatch::k ( )
inline

Number of concentric neutral strands; default is 2.

DSS property name: k, DSS property index: 1

◆ like() [1/2]

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

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 22

◆ like() [2/2]

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

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 22

◆ normamps()

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

Normal ampacity, amperes.

Defaults to Emergency amps/1.5 if not specified.

DSS property name: normamps, DSS property index: 16

◆ Rac()

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

Resistance at 60 Hz per unit length.

Defaults to 1.02*Rdc if not specified.

DSS property name: Rac, DSS property index: 10

◆ radius()

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

Outside radius of conductor.

Defaults to GMR/0.7788 if not specified.

DSS property name: radius, DSS property index: 14

◆ radunits()

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

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

DSS property name: radunits, DSS property index: 15

◆ radunits_str()

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

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

DSS property name: radunits, DSS property index: 15

◆ Ratings()

std::vector< VectorXd > dss::obj::CNDataBatch::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: 20

◆ Rdc()

BatchFloat64ArrayProxy dss::obj::CNDataBatch::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: 9

◆ Rstrand()

BatchFloat64ArrayProxy dss::obj::CNDataBatch::Rstrand ( )
inline

AC resistance of a concentric neutral strand; same units as core conductor resistance; no default.

DSS property name: Rstrand, DSS property index: 4

◆ Runits()

BatchInt32ArrayProxy dss::obj::CNDataBatch::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: 11

◆ Runits_str()

strings dss::obj::CNDataBatch::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: 11

◆ Seasons()

BatchInt32ArrayProxy dss::obj::CNDataBatch::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: 19


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