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

Public Member Functions

 ILineSpacings (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all LineSpacing names in the circuit.
 
int32_t Count ()
 Number of LineSpacing objects in active circuit.
 
int32_t First ()
 Sets the first LineSpacing active. More...
 
string Name ()
 Get the name of the current active LineSpacing.
 
ILineSpacingsName (const char *value)
 Sets the active LineSpacing by Name.
 
ILineSpacingsName (const string &value)
 
int32_t Next ()
 Sets the next LineSpacing active. More...
 
int32_t idx ()
 Get active LineSpacing by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active LineSpacing by index; index is 1-based: 1..count.
 
int32_t Phases ()
 Number of Phases.
 
ILineSpacingsPhases (int32_t value)
 
int32_t Nconds ()
 
ILineSpacingsNconds (int32_t value)
 
int32_t Units ()
 
ILineSpacingsUnits (int32_t 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>>
ILineSpacingsXcoords (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>>
ILineSpacingsYcoords (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::ILineSpacings::First ( )
inline

Sets the first LineSpacing active.

Returns 0 if no more.

◆ Next()

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

Sets the next LineSpacing active.

Returns 0 if no more.


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