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

Public Member Functions

 IGICSources (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all GICSource names in the circuit.
 
int32_t Count ()
 Number of GICSource objects in active circuit.
 
int32_t First ()
 Sets the first GICSource active. More...
 
string Name ()
 Get the name of the current active GICSource.
 
IGICSources & Name (const char *value)
 Sets the active GICSource by Name.
 
IGICSources & Name (const string &value)
 
int32_t Next ()
 Sets the next GICSource active. More...
 
int32_t idx ()
 Get active GICSource by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active GICSource by index; index is 1-based: 1..count.
 
string Bus1 ()
 First bus name of GICSource (Created name)
 
string Bus2 ()
 Second bus name.
 
int32_t Phases ()
 Number of Phases, this GICSource element.
 
IGICSources & Phases (int32_t value)
 
double EN ()
 Northward E Field V/km.
 
IGICSources & EN (double value)
 
double EE ()
 Eastward E Field, V/km.
 
IGICSources & EE (double value)
 
double Lat1 ()
 Latitude of Bus1 (degrees)
 
IGICSources & Lat1 (double value)
 
double Lat2 ()
 Latitude of Bus2 (degrees)
 
IGICSources & Lat2 (double value)
 
double Lon1 ()
 Longitude of Bus1 (Degrees)
 
IGICSources & Lon1 (double value)
 
double Lon2 ()
 Longitude of Bus2 (Degrees)
 
IGICSources & Lon2 (double value)
 
double Volts ()
 Specify dc voltage directly.
 
IGICSources & Volts (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::IGICSources::First ( )
inline

Sets the first GICSource active.

Returns 0 if no more.

◆ Next()

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

Sets the next GICSource active.

Returns 0 if no more.


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