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

Public Member Functions

 IWireData (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all WireData names in the circuit.
 
int32_t Count ()
 Number of WireData objects in active circuit.
 
int32_t First ()
 Sets the first WireData active. More...
 
string Name ()
 Get the name of the current active WireData.
 
IWireDataName (const char *value)
 Sets the active WireData by Name.
 
IWireDataName (const string &value)
 
int32_t Next ()
 Sets the next WireData active. More...
 
int32_t idx ()
 Get active WireData by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active WireData by index; index is 1-based: 1..count.
 
double EmergAmps ()
 Emergency ampere rating.
 
IWireDataEmergAmps (double value)
 
double NormAmps ()
 Normal Ampere rating.
 
IWireDataNormAmps (double value)
 
double Rdc ()
 
IWireDataRdc (double value)
 
double Rac ()
 
IWireDataRac (double value)
 
double GMRac ()
 
IWireDataGMRac (double value)
 
int32_t GMRUnits ()
 
IWireDataGMRUnits (int32_t value)
 
double Radius ()
 
IWireDataRadius (double value)
 
int32_t RadiusUnits ()
 
IWireDataRadiusUnits (int32_t value)
 
int32_t ResistanceUnits ()
 
IWireDataResistanceUnits (int32_t value)
 
double Diameter ()
 
IWireDataDiameter (double value)
 
double CapRadius ()
 Equivalent conductor radius for capacitance calcs. More...
 
IWireDataCapRadius (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.
 
APIUtilapi_util
 API utility functions.
 

Member Function Documentation

◆ CapRadius()

double dss::classic::IWireData::CapRadius ( )
inline

Equivalent conductor radius for capacitance calcs.

Specify this for bundled conductors. Defaults to same value as radius.

◆ First()

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

Sets the first WireData active.

Returns 0 if no more.

◆ Next()

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

Sets the next WireData active.

Returns 0 if no more.


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