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

Public Member Functions

 ITopology (dss::APIUtil *util)
 
int32_t ActiveBranch ()
 Returns index of the active branch.
 
int32_t ActiveLevel ()
 Topological depth of the active branch.
 
strings AllIsolatedBranches ()
 Array of all isolated branch names.
 
strings AllIsolatedLoads ()
 Array of all isolated load names.
 
strings AllLoopedPairs ()
 Array of all looped element names, by pairs.
 
int32_t BackwardBranch ()
 MOve back toward the source, return index of new active branch, or 0 if no more.
 
string BranchName ()
 Name of the active branch.
 
ITopologyBranchName (const char *value)
 
ITopologyBranchName (const string &value)
 
string BusName ()
 Set the active branch to one containing this bus, return index or 0 if not found.
 
ITopologyBusName (const char *value)
 
ITopologyBusName (const string &value)
 
int32_t First ()
 Sets the first branch active, returns 0 if none.
 
int32_t FirstLoad ()
 First load at the active branch, return index or 0 if none.
 
int32_t ForwardBranch ()
 Move forward in the tree, return index of new active branch or 0 if no more.
 
int32_t LoopedBranch ()
 Move to looped branch, return index or 0 if none.
 
int32_t Next ()
 Sets the next branch active, returns 0 if no more.
 
int32_t NextLoad ()
 Next load at the active branch, return index or 0 if no more.
 
int32_t NumIsolatedBranches ()
 Number of isolated branches (PD elements and capacitors).
 
int32_t NumIsolatedLoads ()
 Number of isolated loads.
 
int32_t NumLoops ()
 Number of loops.
 
int32_t ParallelBranch ()
 Move to directly parallel branch, return index or 0 if none.
 
- 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.
 

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