DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
|
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. | |
TSDataBatch & | begin_edit () |
TSDataBatch & | end_edit (int32_t num_edits=1) |
BatchFloat64ArrayProxy | DiaShield () |
Diameter over tape shield; same units as radius; no default. More... | |
TSDataBatch & | DiaShield (double value) |
template<typename T > | |
TSDataBatch & | DiaShield (T &value) |
template<typename T > | |
TSDataBatch & | DiaShield (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | TapeLayer () |
Tape shield thickness; same units as radius; no default. More... | |
TSDataBatch & | TapeLayer (double value) |
template<typename T > | |
TSDataBatch & | TapeLayer (T &value) |
template<typename T > | |
TSDataBatch & | TapeLayer (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | TapeLap () |
Tape Lap in percent; default 20.0. More... | |
TSDataBatch & | TapeLap (double value) |
template<typename T > | |
TSDataBatch & | TapeLap (T &value) |
template<typename T > | |
TSDataBatch & | TapeLap (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | EpsR () |
Insulation layer relative permittivity; default is 2.3. More... | |
TSDataBatch & | EpsR (double value) |
template<typename T > | |
TSDataBatch & | EpsR (T &value) |
template<typename T > | |
TSDataBatch & | EpsR (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | InsLayer () |
Insulation layer thickness; same units as radius; no default. More... | |
TSDataBatch & | InsLayer (double value) |
template<typename T > | |
TSDataBatch & | InsLayer (T &value) |
template<typename T > | |
TSDataBatch & | InsLayer (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | DiaIns () |
Diameter over insulation layer; same units as radius; no default. More... | |
TSDataBatch & | DiaIns (double value) |
template<typename T > | |
TSDataBatch & | DiaIns (T &value) |
template<typename T > | |
TSDataBatch & | DiaIns (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | DiaCable () |
Diameter over cable; same units as radius; no default. More... | |
TSDataBatch & | DiaCable (double value) |
template<typename T > | |
TSDataBatch & | DiaCable (T &value) |
template<typename T > | |
TSDataBatch & | DiaCable (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | Rdc () |
dc Resistance, ohms per unit length (see Runits). More... | |
TSDataBatch & | Rdc (double value) |
template<typename T > | |
TSDataBatch & | Rdc (T &value) |
template<typename T > | |
TSDataBatch & | Rdc (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | Rac () |
Resistance at 60 Hz per unit length. More... | |
TSDataBatch & | Rac (double value) |
template<typename T > | |
TSDataBatch & | Rac (T &value) |
template<typename T > | |
TSDataBatch & | Rac (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... | |
TSDataBatch & | Runits (string &value) |
TSDataBatch & | Runits (int32_t value) |
TSDataBatch & | Runits (DimensionUnits value) |
TSDataBatch & | Runits (strings &value) |
TSDataBatch & | Runits (std::vector< int32_t > &value) |
TSDataBatch & | Runits (std::vector< DimensionUnits > &value) |
strings | Runits_str () |
Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none. More... | |
TSDataBatch & | Runits_str (string &value) |
TSDataBatch & | Runits_str (strings &value) |
BatchFloat64ArrayProxy | GMRac () |
GMR at 60 Hz. More... | |
TSDataBatch & | GMRac (double value) |
template<typename T > | |
TSDataBatch & | GMRac (T &value) |
template<typename T > | |
TSDataBatch & | GMRac (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... | |
TSDataBatch & | GMRunits (string &value) |
TSDataBatch & | GMRunits (int32_t value) |
TSDataBatch & | GMRunits (DimensionUnits value) |
TSDataBatch & | GMRunits (strings &value) |
TSDataBatch & | GMRunits (std::vector< int32_t > &value) |
TSDataBatch & | GMRunits (std::vector< DimensionUnits > &value) |
strings | GMRunits_str () |
Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More... | |
TSDataBatch & | GMRunits_str (string &value) |
TSDataBatch & | GMRunits_str (strings &value) |
BatchFloat64ArrayProxy | radius () |
Outside radius of conductor. More... | |
TSDataBatch & | radius (double value) |
template<typename T > | |
TSDataBatch & | radius (T &value) |
template<typename T > | |
TSDataBatch & | radius (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... | |
TSDataBatch & | radunits (string &value) |
TSDataBatch & | radunits (int32_t value) |
TSDataBatch & | radunits (DimensionUnits value) |
TSDataBatch & | radunits (strings &value) |
TSDataBatch & | radunits (std::vector< int32_t > &value) |
TSDataBatch & | radunits (std::vector< DimensionUnits > &value) |
strings | radunits_str () |
Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none. More... | |
TSDataBatch & | radunits_str (string &value) |
TSDataBatch & | radunits_str (strings &value) |
BatchFloat64ArrayProxy | normamps () |
Normal ampacity, amperes. More... | |
TSDataBatch & | normamps (double value) |
template<typename T > | |
TSDataBatch & | normamps (T &value) |
template<typename T > | |
TSDataBatch & | normamps (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | emergamps () |
Emergency ampacity, amperes. More... | |
TSDataBatch & | emergamps (double value) |
template<typename T > | |
TSDataBatch & | emergamps (T &value) |
template<typename T > | |
TSDataBatch & | emergamps (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | diam () |
Diameter; Alternative method for entering radius. More... | |
TSDataBatch & | diam (double value) |
template<typename T > | |
TSDataBatch & | diam (T &value) |
template<typename T > | |
TSDataBatch & | diam (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... | |
TSDataBatch & | Seasons (int32_t value) |
template<typename T > | |
TSDataBatch & | Seasons (T &value) |
template<typename T > | |
TSDataBatch & | Seasons (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... | |
TSDataBatch & | Ratings (VectorXd &value) |
BatchFloat64ArrayProxy | Capradius () |
Equivalent conductor radius for capacitance calcs. More... | |
TSDataBatch & | Capradius (double value) |
template<typename T > | |
TSDataBatch & | Capradius (T &value) |
template<typename T > | |
TSDataBatch & | Capradius (typename T::iterator it_begin, typename T::iterator it_end) |
TSDataBatch & | like (const string &value) |
Make like another object, e.g. More... | |
TSDataBatch & | 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) |
|
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
|
inline |
Diameter over cable; same units as radius; no default.
DSS property name: DiaCable, DSS property index: 7
|
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
|
inline |
Diameter; Alternative method for entering radius.
DSS property name: diam, DSS property index: 17
|
inline |
Diameter over tape shield; same units as radius; no default.
DSS property name: DiaShield, DSS property index: 1
|
inline |
Emergency ampacity, amperes.
Defaults to 1.5 * Normal Amps if not specified.
DSS property name: emergamps, DSS property index: 16
|
inline |
Insulation layer relative permittivity; default is 2.3.
DSS property name: EpsR, DSS property index: 4
|
inline |
GMR at 60 Hz.
Defaults to .7788*radius if not specified.
DSS property name: GMRac, DSS property index: 11
|
inline |
Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.
DSS property name: GMRunits, DSS property index: 12
|
inline |
Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.
DSS property name: GMRunits, DSS property index: 12
|
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
|
inline |
Make like another object, e.g.
:
New Capacitor.C2 like=c1 ...
DSS property name: like, DSS property index: 21
|
inline |
Make like another object, e.g.
:
New Capacitor.C2 like=c1 ...
DSS property name: like, DSS property index: 21
|
inline |
Normal ampacity, amperes.
Defaults to Emergency amps/1.5 if not specified.
DSS property name: normamps, DSS property index: 15
|
inline |
Resistance at 60 Hz per unit length.
Defaults to 1.02*Rdc if not specified.
DSS property name: Rac, DSS property index: 9
|
inline |
Outside radius of conductor.
Defaults to GMR/0.7788 if not specified.
DSS property name: radius, DSS property index: 13
|
inline |
Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.
DSS property name: radunits, DSS property index: 14
|
inline |
Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.
DSS property name: radunits, DSS property index: 14
|
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
|
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
|
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
|
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
|
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
|
inline |
Tape Lap in percent; default 20.0.
DSS property name: TapeLap, DSS property index: 3
|
inline |
Tape shield thickness; same units as radius; no default.
DSS property name: TapeLayer, DSS property index: 2