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

Public Member Functions

 ILineGeometries (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all LineGeometrie names in the circuit.
 
int32_t Count ()
 Number of LineGeometrie objects in active circuit.
 
int32_t First ()
 Sets the first LineGeometrie active. More...
 
string Name ()
 Get the name of the current active LineGeometrie.
 
ILineGeometriesName (const char *value)
 Sets the active LineGeometrie by Name.
 
ILineGeometriesName (const string &value)
 
int32_t Next ()
 Sets the next LineGeometrie active. More...
 
int32_t idx ()
 Get active LineGeometrie by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active LineGeometrie by index; index is 1-based: 1..count.
 
strings Conductors ()
 Array of strings with names of all conductors in the active LineGeometry object.
 
double EmergAmps ()
 Emergency ampere rating.
 
ILineGeometriesEmergAmps (double value)
 
double NormAmps ()
 Normal ampere rating.
 
ILineGeometriesNormAmps (double value)
 
double RhoEarth ()
 
ILineGeometriesRhoEarth (double value)
 
bool Reduce ()
 
ILineGeometriesReduce (bool value)
 
int32_t Phases ()
 Number of Phases.
 
ILineGeometriesPhases (int32_t value)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Rmatrix (double Frequency, double Length, int32_t Units)
 Resistance matrix, ohms.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Xmatrix (double Frequency, double Length, int32_t Units)
 Reactance matrix, ohms.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Zmatrix (double Frequency, double Length, int32_t Units)
 Complex impedance matrix, ohms.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Cmatrix (double Frequency, double Length, int32_t Units)
 Capacitance matrix, nF.
 
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT Units ()
 
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
ILineGeometriesUnits (const VectorT &value)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Xcoords ()
 Get/Set the X (horizontal) coordinates of the conductors.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILineGeometriesXcoords (const VectorT &value)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Ycoords ()
 Get/Set the Y (vertical/height) coordinates of the conductors.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILineGeometriesYcoords (const VectorT &value)
 
int32_t Nconds ()
 Number of conductors in this geometry. More...
 
ILineGeometriesNconds (int32_t 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::ILineGeometries::First ( )
inline

Sets the first LineGeometrie active.

Returns 0 if no more.

◆ Nconds()

int32_t dss::classic::ILineGeometries::Nconds ( )
inline

Number of conductors in this geometry.

Default is 3. Triggers memory allocations. Define first!

◆ Next()

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

Sets the next LineGeometrie active.

Returns 0 if no more.


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