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.
 
IWireData & Name (const char *value)
 Sets the active WireData by Name.
 
IWireData & Name (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.
 
IWireData & EmergAmps (double value)
 
double NormAmps ()
 Normal Ampere rating.
 
IWireData & NormAmps (double value)
 
double Rdc ()
 
IWireData & Rdc (double value)
 
double Rac ()
 
IWireData & Rac (double value)
 
double GMRac ()
 
IWireData & GMRac (double value)
 
int32_t GMRUnits ()
 
IWireData & GMRUnits (int32_t value)
 
double Radius ()
 
IWireData & Radius (double value)
 
int32_t RadiusUnits ()
 
IWireData & RadiusUnits (int32_t value)
 
int32_t ResistanceUnits ()
 
IWireData & ResistanceUnits (int32_t value)
 
double Diameter ()
 
IWireData & Diameter (double value)
 
double CapRadius ()
 Equivalent conductor radius for capacitance calcs. More...
 
IWireData & CapRadius (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

◆ 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: