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

Public Member Functions

 ILineCodes (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all LineCode names in the circuit.
 
int32_t Count ()
 Number of LineCode objects in active circuit.
 
int32_t First ()
 Sets the first LineCode active. More...
 
string Name ()
 Get the name of the current active LineCode.
 
ILineCodesName (const char *value)
 Sets the active LineCode by Name.
 
ILineCodesName (const string &value)
 
int32_t Next ()
 Sets the next LineCode active. More...
 
int32_t idx ()
 Get active LineCode by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active LineCode by index; index is 1-based: 1..count.
 
double C0 ()
 Zero-sequence capacitance, nF per unit length.
 
ILineCodesC0 (double value)
 
double C1 ()
 Positive-sequence capacitance, nF per unit length.
 
ILineCodesC1 (double value)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Cmatrix ()
 Capacitance matrix, nF per unit length.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILineCodesCmatrix (const VectorT &value)
 
double EmergAmps ()
 Emergency ampere rating.
 
ILineCodesEmergAmps (double value)
 
bool IsZ1Z0 ()
 Flag denoting whether impedance data were entered in symmetrical components.
 
double NormAmps ()
 Normal Ampere rating.
 
ILineCodesNormAmps (double value)
 
int32_t Phases ()
 Number of Phases.
 
ILineCodesPhases (int32_t value)
 
double R0 ()
 Zero-Sequence Resistance, ohms per unit length.
 
ILineCodesR0 (double value)
 
double R1 ()
 Positive-sequence resistance ohms per unit length.
 
ILineCodesR1 (double value)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Rmatrix ()
 Resistance matrix, ohms per unit length.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILineCodesRmatrix (const VectorT &value)
 
int32_t Units ()
 
ILineCodesUnits (int32_t value)
 
double X0 ()
 Zero Sequence Reactance, Ohms per unit length.
 
ILineCodesX0 (double value)
 
double X1 ()
 Posiive-sequence reactance, ohms per unit length.
 
ILineCodesX1 (double value)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Xmatrix ()
 Reactance matrix, ohms per unit length.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILineCodesXmatrix (const VectorT &value)
 
- Public Member Functions inherited from dss::ContextState
 ContextState (APIUtil *util)
 

Additional Inherited Members

- Public Attributes inherited from dss::ContextState
void * ctx
 Pointer to the DSSContext for easy access.
 
APIUtilapi_util
 API utility functions.
 

Member Function Documentation

◆ First()

int32_t dss::classic::ILineCodes::First ( )
inline

Sets the first LineCode active.

Returns 0 if no more.

◆ Next()

int32_t dss::classic::ILineCodes::Next ( )
inline

Sets the next LineCode active.

Returns 0 if no more.


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