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

Public Member Functions

 ICNData (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all CNData names in the circuit.
 
int32_t Count ()
 Number of CNData objects in active circuit.
 
int32_t First ()
 Sets the first CNData active. More...
 
string Name ()
 Get the name of the current active CNData.
 
ICNData & Name (const char *value)
 Sets the active CNData by Name.
 
ICNData & Name (const string &value)
 
int32_t Next ()
 Sets the next CNData active. More...
 
int32_t idx ()
 Get active CNData by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active CNData by index; index is 1-based: 1..count.
 
double EmergAmps ()
 Emergency ampere rating.
 
ICNData & EmergAmps (double value)
 
double NormAmps ()
 Normal Ampere rating.
 
ICNData & NormAmps (double value)
 
double Rdc ()
 
ICNData & Rdc (double value)
 
double Rac ()
 
ICNData & Rac (double value)
 
double GMRac ()
 
ICNData & GMRac (double value)
 
int32_t GMRUnits ()
 
ICNData & GMRUnits (int32_t value)
 
double Radius ()
 
ICNData & Radius (double value)
 
int32_t RadiusUnits ()
 
ICNData & RadiusUnits (int32_t value)
 
int32_t ResistanceUnits ()
 
ICNData & ResistanceUnits (int32_t value)
 
double Diameter ()
 
ICNData & Diameter (double value)
 
double EpsR ()
 
ICNData & EpsR (double value)
 
double InsLayer ()
 
ICNData & InsLayer (double value)
 
double DiaIns ()
 
ICNData & DiaIns (double value)
 
double DiaCable ()
 
ICNData & DiaCable (double value)
 
int32_t k ()
 
ICNData & k (int32_t value)
 
double DiaStrand ()
 
ICNData & DiaStrand (double value)
 
double GmrStrand ()
 
ICNData & GmrStrand (double value)
 
double RStrand ()
 
ICNData & RStrand (double 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.
 
APIUtil * api_util
 API utility functions.
 

Member Function Documentation

◆ First()

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

Sets the first CNData active.

Returns 0 if no more.

◆ Next()

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

Sets the next CNData active.

Returns 0 if no more.


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