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

Public Member Functions

 ICapControls (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all CapControl names in the circuit.
 
int32_t Count ()
 Number of CapControl objects in active circuit.
 
int32_t First ()
 Sets the first CapControl active. More...
 
string Name ()
 Get the name of the current active CapControl.
 
ICapControls & Name (const char *value)
 Sets the active CapControl by Name.
 
ICapControls & Name (const string &value)
 
int32_t Next ()
 Sets the next CapControl active. More...
 
int32_t idx ()
 Get active CapControl by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active CapControl by index; index is 1-based: 1..count.
 
void Reset ()
 
double CTratio ()
 Transducer ratio from pirmary current to control current.
 
ICapControls & CTratio (double value)
 
string Capacitor ()
 Name of the Capacitor that is controlled.
 
ICapControls & Capacitor (const char *value)
 
ICapControls & Capacitor (const string &value)
 
double DeadTime ()
 
ICapControls & DeadTime (double value)
 
double Delay ()
 Time delay [s] to switch on after arming. More...
 
ICapControls & Delay (double value)
 
double DelayOff ()
 Time delay [s] before swithcing off a step. More...
 
ICapControls & DelayOff (double value)
 
int32_t Mode ()
 Type of automatic controller.
 
ICapControls & Mode (int32_t value)
 
string MonitoredObj ()
 Full name of the element that PT and CT are connected to.
 
ICapControls & MonitoredObj (const char *value)
 
ICapControls & MonitoredObj (const string &value)
 
int32_t MonitoredTerm ()
 Terminal number on the element that PT and CT are connected to.
 
ICapControls & MonitoredTerm (int32_t value)
 
double OFFSetting ()
 Threshold to switch off a step. More...
 
ICapControls & OFFSetting (double value)
 
double ONSetting ()
 Threshold to arm or switch on a step. More...
 
ICapControls & ONSetting (double value)
 
double PTratio ()
 Transducer ratio from primary feeder to control voltage.
 
ICapControls & PTratio (double value)
 
bool UseVoltOverride ()
 Enables Vmin and Vmax to override the control Mode.
 
ICapControls & UseVoltOverride (bool value)
 
double Vmax ()
 With VoltOverride, swtich off whenever PT voltage exceeds this level.
 
ICapControls & Vmax (double value)
 
double Vmin ()
 With VoltOverride, switch ON whenever PT voltage drops below this level.
 
ICapControls & Vmin (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

◆ Delay()

double dss::classic::ICapControls::Delay ( )
inline

Time delay [s] to switch on after arming.

Control may reset before actually switching.

◆ DelayOff()

double dss::classic::ICapControls::DelayOff ( )
inline

Time delay [s] before swithcing off a step.

Control may reset before actually switching.

◆ First()

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

Sets the first CapControl active.

Returns 0 if no more.

◆ Next()

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

Sets the next CapControl active.

Returns 0 if no more.

◆ OFFSetting()

double dss::classic::ICapControls::OFFSetting ( )
inline

Threshold to switch off a step.

See Mode for units.

◆ ONSetting()

double dss::classic::ICapControls::ONSetting ( )
inline

Threshold to arm or switch on a step.

See Mode for units.


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