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

Public Member Functions

 IISources (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all ISource names in the circuit.
 
int32_t Count ()
 Number of ISource objects in active circuit.
 
int32_t First ()
 Sets the first ISource active. More...
 
string Name ()
 Get the name of the current active ISource.
 
IISourcesName (const char *value)
 Sets the active ISource by Name.
 
IISourcesName (const string &value)
 
int32_t Next ()
 Sets the next ISource active. More...
 
int32_t idx ()
 Get active ISource by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active ISource by index; index is 1-based: 1..count.
 
double Amps ()
 Magnitude of the ISource in amps.
 
IISourcesAmps (double value)
 
double AngleDeg ()
 Phase angle for ISource, degrees.
 
IISourcesAngleDeg (double value)
 
double Frequency ()
 The present frequency of the ISource, Hz.
 
IISourcesFrequency (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

◆ First()

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

Sets the first ISource active.

Returns 0 if no more.

◆ Next()

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

Sets the next ISource active.

Returns 0 if no more.


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