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

Public Member Functions

 IActiveClass (dss::APIUtil *util)
 
string ActiveClassName ()
 Returns name of active class.
 
strings AllNames ()
 Array of strings consisting of all element names in the active class.
 
int32_t Count ()
 Number of elements in Active Class. More...
 
int32_t First ()
 Sets first element in the active class to be the active DSS object. More...
 
string Name ()
 Name of the Active Element of the Active Class.
 
IActiveClass & Name (const char *value)
 
IActiveClass & Name (const string &value)
 
int32_t Next ()
 Sets next element in active class to be the active DSS object. More...
 
int32_t NumElements ()
 Number of elements in this class. More...
 
string ActiveClassParent ()
 Get the name of the parent class of the active class.
 
string ToJSON (int32_t options=0)
 Returns the data (as a list) of all elements from the active class as a JSON-encoded string. More...
 
- 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

◆ Count()

int32_t dss::classic::IActiveClass::Count ( )
inline

Number of elements in Active Class.

Same as NumElements Property.

◆ First()

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

Sets first element in the active class to be the active DSS object.

If object is a CktElement, ActiveCktELment also points to this element. Returns 0 if none.

◆ Next()

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

Sets next element in active class to be the active DSS object.

If object is a CktElement, ActiveCktElement also points to this element. Returns 0 if no more.

◆ NumElements()

int32_t dss::classic::IActiveClass::NumElements ( )
inline

Number of elements in this class.

Same as Count property.

◆ ToJSON()

string dss::classic::IActiveClass::ToJSON ( int32_t  options = 0)
inline

Returns the data (as a list) of all elements from the active class as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON (C-API) for more, or DSSObj.to_json in Python.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

(API Extension)


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