DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
|
Public Types | |
typedef Recloser::Properties | Properties |
typedef Recloser | BatchElementClass |
typedef Recloser::RecloserAction | RecloserAction |
typedef Recloser::RecloserState | RecloserState |
Public Member Functions | |
RecloserBatch (APIUtil *util) | |
Create a batch of all Recloser elements. | |
RecloserBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value) | |
Create a batch of all Recloser elements that match an integer property value. | |
RecloserBatch (APIUtil *util, const char *regexp) | |
Create a batch of all Recloser elements that match a regular expression. | |
RecloserBatch & | begin_edit () |
RecloserBatch & | end_edit (int32_t num_edits=1) |
strings | MonitoredObj () |
Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Recloser's PT and/or CT are connected. More... | |
RecloserBatch & | MonitoredObj (dss::obj::DSSObj &value) |
RecloserBatch & | MonitoredObj (const string &value) |
std::vector< dss::obj::DSSObj > | MonitoredObj_obj () |
Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Recloser's PT and/or CT are connected. More... | |
RecloserBatch & | MonitoredObj_obj (dss::obj::DSSObj &value) |
BatchInt32ArrayProxy | MonitoredTerm () |
Number of the terminal of the circuit element to which the Recloser is connected. More... | |
RecloserBatch & | MonitoredTerm (int32_t value) |
template<typename T > | |
RecloserBatch & | MonitoredTerm (T &value) |
template<typename T > | |
RecloserBatch & | MonitoredTerm (typename T::iterator it_begin, typename T::iterator it_end) |
strings | SwitchedObj () |
Name of circuit element switch that the Recloser controls. More... | |
RecloserBatch & | SwitchedObj (dss::obj::DSSObj &value) |
RecloserBatch & | SwitchedObj (const string &value) |
std::vector< dss::obj::DSSObj > | SwitchedObj_obj () |
Name of circuit element switch that the Recloser controls. More... | |
RecloserBatch & | SwitchedObj_obj (dss::obj::DSSObj &value) |
BatchInt32ArrayProxy | SwitchedTerm () |
Number of the terminal of the controlled element in which the switch is controlled by the Recloser. More... | |
RecloserBatch & | SwitchedTerm (int32_t value) |
template<typename T > | |
RecloserBatch & | SwitchedTerm (T &value) |
template<typename T > | |
RecloserBatch & | SwitchedTerm (typename T::iterator it_begin, typename T::iterator it_end) |
BatchInt32ArrayProxy | NumFast () |
Number of Fast (fuse saving) operations. More... | |
RecloserBatch & | NumFast (int32_t value) |
template<typename T > | |
RecloserBatch & | NumFast (T &value) |
template<typename T > | |
RecloserBatch & | NumFast (typename T::iterator it_begin, typename T::iterator it_end) |
strings | PhaseFast () |
Name of the TCC Curve object that determines the Phase Fast trip. More... | |
RecloserBatch & | PhaseFast (dss::obj::TCC_Curve &value) |
RecloserBatch & | PhaseFast (const string &value) |
std::vector< dss::obj::TCC_Curve > | PhaseFast_obj () |
Name of the TCC Curve object that determines the Phase Fast trip. More... | |
RecloserBatch & | PhaseFast_obj (dss::obj::TCC_Curve &value) |
strings | PhaseDelayed () |
Name of the TCC Curve object that determines the Phase Delayed trip. More... | |
RecloserBatch & | PhaseDelayed (dss::obj::TCC_Curve &value) |
RecloserBatch & | PhaseDelayed (const string &value) |
std::vector< dss::obj::TCC_Curve > | PhaseDelayed_obj () |
Name of the TCC Curve object that determines the Phase Delayed trip. More... | |
RecloserBatch & | PhaseDelayed_obj (dss::obj::TCC_Curve &value) |
strings | GroundFast () |
Name of the TCC Curve object that determines the Ground Fast trip. More... | |
RecloserBatch & | GroundFast (dss::obj::TCC_Curve &value) |
RecloserBatch & | GroundFast (const string &value) |
std::vector< dss::obj::TCC_Curve > | GroundFast_obj () |
Name of the TCC Curve object that determines the Ground Fast trip. More... | |
RecloserBatch & | GroundFast_obj (dss::obj::TCC_Curve &value) |
strings | GroundDelayed () |
Name of the TCC Curve object that determines the Ground Delayed trip. More... | |
RecloserBatch & | GroundDelayed (dss::obj::TCC_Curve &value) |
RecloserBatch & | GroundDelayed (const string &value) |
std::vector< dss::obj::TCC_Curve > | GroundDelayed_obj () |
Name of the TCC Curve object that determines the Ground Delayed trip. More... | |
RecloserBatch & | GroundDelayed_obj (dss::obj::TCC_Curve &value) |
BatchFloat64ArrayProxy | PhaseTrip () |
Multiplier or actual phase amps for the phase TCC curve. More... | |
RecloserBatch & | PhaseTrip (double value) |
template<typename T > | |
RecloserBatch & | PhaseTrip (T &value) |
template<typename T > | |
RecloserBatch & | PhaseTrip (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | GroundTrip () |
Multiplier or actual ground amps (3I0) for the ground TCC curve. More... | |
RecloserBatch & | GroundTrip (double value) |
template<typename T > | |
RecloserBatch & | GroundTrip (T &value) |
template<typename T > | |
RecloserBatch & | GroundTrip (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | PhaseInst () |
Actual amps for instantaneous phase trip which is assumed to happen in 0.01 sec + Delay Time. More... | |
RecloserBatch & | PhaseInst (double value) |
template<typename T > | |
RecloserBatch & | PhaseInst (T &value) |
template<typename T > | |
RecloserBatch & | PhaseInst (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | GroundInst () |
Actual amps for instantaneous ground trip which is assumed to happen in 0.01 sec + Delay Time.Default is 0.0, which signifies no inst trip. More... | |
RecloserBatch & | GroundInst (double value) |
template<typename T > | |
RecloserBatch & | GroundInst (T &value) |
template<typename T > | |
RecloserBatch & | GroundInst (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | Reset () |
Reset time in sec for Recloser. More... | |
RecloserBatch & | Reset (double value) |
template<typename T > | |
RecloserBatch & | Reset (T &value) |
template<typename T > | |
RecloserBatch & | Reset (typename T::iterator it_begin, typename T::iterator it_end) |
BatchInt32ArrayProxy | Shots () |
Total Number of fast and delayed shots to lockout. More... | |
RecloserBatch & | Shots (int32_t value) |
template<typename T > | |
RecloserBatch & | Shots (T &value) |
template<typename T > | |
RecloserBatch & | Shots (typename T::iterator it_begin, typename T::iterator it_end) |
std::vector< VectorXd > | RecloseIntervals () |
Array of reclose intervals. More... | |
RecloserBatch & | RecloseIntervals (VectorXd &value) |
BatchFloat64ArrayProxy | Delay () |
Fixed delay time (sec) added to Recloser trip time. More... | |
RecloserBatch & | Delay (double value) |
template<typename T > | |
RecloserBatch & | Delay (T &value) |
template<typename T > | |
RecloserBatch & | Delay (typename T::iterator it_begin, typename T::iterator it_end) |
BatchInt32ArrayProxy | Action () |
DEPRECATED. More... | |
RecloserBatch & | Action (string &value) |
RecloserBatch & | Action (int32_t value) |
RecloserBatch & | Action (Recloser::RecloserAction value) |
RecloserBatch & | Action (strings &value) |
RecloserBatch & | Action (std::vector< int32_t > &value) |
RecloserBatch & | Action (std::vector< Recloser::RecloserAction > &value) |
strings | Action_str () |
DEPRECATED. More... | |
RecloserBatch & | Action_str (string &value) |
RecloserBatch & | Action_str (strings &value) |
BatchFloat64ArrayProxy | TDPhFast () |
Time dial for Phase Fast trip curve. More... | |
RecloserBatch & | TDPhFast (double value) |
template<typename T > | |
RecloserBatch & | TDPhFast (T &value) |
template<typename T > | |
RecloserBatch & | TDPhFast (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | TDGrFast () |
Time dial for Ground Fast trip curve. More... | |
RecloserBatch & | TDGrFast (double value) |
template<typename T > | |
RecloserBatch & | TDGrFast (T &value) |
template<typename T > | |
RecloserBatch & | TDGrFast (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | TDPhDelayed () |
Time dial for Phase Delayed trip curve. More... | |
RecloserBatch & | TDPhDelayed (double value) |
template<typename T > | |
RecloserBatch & | TDPhDelayed (T &value) |
template<typename T > | |
RecloserBatch & | TDPhDelayed (typename T::iterator it_begin, typename T::iterator it_end) |
BatchFloat64ArrayProxy | TDGrDelayed () |
Time dial for Ground Delayed trip curve. More... | |
RecloserBatch & | TDGrDelayed (double value) |
template<typename T > | |
RecloserBatch & | TDGrDelayed (T &value) |
template<typename T > | |
RecloserBatch & | TDGrDelayed (typename T::iterator it_begin, typename T::iterator it_end) |
BatchInt32ArrayProxy | Normal () |
{Open | Closed} Normal state of the recloser. More... | |
RecloserBatch & | Normal (string &value) |
RecloserBatch & | Normal (int32_t value) |
RecloserBatch & | Normal (Recloser::RecloserState value) |
RecloserBatch & | Normal (strings &value) |
RecloserBatch & | Normal (std::vector< int32_t > &value) |
RecloserBatch & | Normal (std::vector< Recloser::RecloserState > &value) |
strings | Normal_str () |
{Open | Closed} Normal state of the recloser. More... | |
RecloserBatch & | Normal_str (string &value) |
RecloserBatch & | Normal_str (strings &value) |
BatchInt32ArrayProxy | State () |
{Open | Closed} Actual state of the recloser. More... | |
RecloserBatch & | State (string &value) |
RecloserBatch & | State (int32_t value) |
RecloserBatch & | State (Recloser::RecloserState value) |
RecloserBatch & | State (strings &value) |
RecloserBatch & | State (std::vector< int32_t > &value) |
RecloserBatch & | State (std::vector< Recloser::RecloserState > &value) |
strings | State_str () |
{Open | Closed} Actual state of the recloser. More... | |
RecloserBatch & | State_str (string &value) |
RecloserBatch & | State_str (strings &value) |
BatchFloat64ArrayProxy | basefreq () |
Base Frequency for ratings. More... | |
RecloserBatch & | basefreq (double value) |
template<typename T > | |
RecloserBatch & | basefreq (T &value) |
template<typename T > | |
RecloserBatch & | basefreq (typename T::iterator it_begin, typename T::iterator it_end) |
bools | enabled () |
{Yes|No or True|False} Indicates whether this element is enabled. More... | |
RecloserBatch & | enabled (bool value) |
RecloserBatch & | enabled (bools &value) |
RecloserBatch & | like (const string &value) |
Make like another object, e.g. More... | |
RecloserBatch & | like (const char *value) |
Make like another object, e.g. More... | |
Public Member Functions inherited from dss::obj::DSSBatch | |
DSSBatch (APIUtil *util, int32_t cls_idx) | |
Create a batch of all elements in the DSS class. | |
DSSBatch (APIUtil *util, int32_t cls_idx, int32_t prop_idx, int32_t prop_value) | |
Create a batch of all elements that match an integer property value. | |
DSSBatch (APIUtil *util, int32_t cls_idx, const char *regexp) | |
Create a batch of all elements that match a regular expression. | |
DSSBatch (APIUtil *util) | |
Create an uninitialized batch instance. | |
strings | name () |
Additional Inherited Members | |
Public Attributes inherited from dss::obj::DSSBatch | |
APIUtil * | api_util |
void ** | pointer |
int32_t | count [2] |
Protected Member Functions inherited from dss::obj::DSSBatch | |
void | check_for_error () |
bools | get_batch_bool (int32_t index) |
std::vector< complex > | get_batch_complex (int32_t index) |
template<typename T = VectorXd> | |
std::vector< T > | get_batch_valarray (int32_t index) |
void | set_batch_complex_for_each (int32_t index, std::vector< complex > &values) |
template<typename T > | |
void | set_batch_val (int32_t index, const T &value) |
template<typename T = VectorXd> | |
T | get_batch_val (int32_t index) |
template<typename T > | |
void | set_batch_val_for_each (int32_t index, typename T::iterator v, typename T::iterator v_end) |
Static Protected Member Functions inherited from dss::obj::DSSBatch | |
template<typename T = VectorXd> | |
static T | get_batch_val (int32_t index, DSSBatch &batch) |
|
inline |
DEPRECATED.
See "State" property
DSS property name: Action, DSS property index: 18
|
inline |
DEPRECATED.
See "State" property
DSS property name: Action, DSS property index: 18
|
inline |
Base Frequency for ratings.
DSS property name: basefreq, DSS property index: 25
|
inline |
Fixed delay time (sec) added to Recloser trip time.
Default is 0.0. Used to represent breaker time or any other delay.
DSS property name: Delay, DSS property index: 17
|
inline |
{Yes|No or True|False} Indicates whether this element is enabled.
DSS property name: enabled, DSS property index: 26
|
inline |
Name of the TCC Curve object that determines the Ground Delayed trip.
Must have been previously defined as a TCC_Curve object. Default is none (ignored).Multiplying the current values in the curve by the "groundtrip" value gives the actual current.
DSS property name: GroundDelayed, DSS property index: 9
|
inline |
Name of the TCC Curve object that determines the Ground Delayed trip.
Must have been previously defined as a TCC_Curve object. Default is none (ignored).Multiplying the current values in the curve by the "groundtrip" value gives the actual current.
DSS property name: GroundDelayed, DSS property index: 9
|
inline |
Name of the TCC Curve object that determines the Ground Fast trip.
Must have been previously defined as a TCC_Curve object. Default is none (ignored). Multiplying the current values in the curve by the "groundtrip" value gives the actual current.
DSS property name: GroundFast, DSS property index: 8
|
inline |
Name of the TCC Curve object that determines the Ground Fast trip.
Must have been previously defined as a TCC_Curve object. Default is none (ignored). Multiplying the current values in the curve by the "groundtrip" value gives the actual current.
DSS property name: GroundFast, DSS property index: 8
|
inline |
Actual amps for instantaneous ground trip which is assumed to happen in 0.01 sec + Delay Time.Default is 0.0, which signifies no inst trip.
DSS property name: GroundInst, DSS property index: 13
|
inline |
Multiplier or actual ground amps (3I0) for the ground TCC curve.
Defaults to 1.0.
DSS property name: GroundTrip, DSS property index: 11
|
inline |
Make like another object, e.g.
:
New Capacitor.C2 like=c1 ...
DSS property name: like, DSS property index: 27
|
inline |
Make like another object, e.g.
:
New Capacitor.C2 like=c1 ...
DSS property name: like, DSS property index: 27
|
inline |
Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Recloser's PT and/or CT are connected.
This is the "monitored" element. There is no default; must be specified.
DSS property name: MonitoredObj, DSS property index: 1
|
inline |
Full object name of the circuit element, typically a line, transformer, load, or generator, to which the Recloser's PT and/or CT are connected.
This is the "monitored" element. There is no default; must be specified.
DSS property name: MonitoredObj, DSS property index: 1
|
inline |
Number of the terminal of the circuit element to which the Recloser is connected.
1 or 2, typically. Default is 1.
DSS property name: MonitoredTerm, DSS property index: 2
|
inline |
{Open | Closed} Normal state of the recloser.
The recloser reverts to this state for reset, change of mode, etc. Defaults to "State" if not specificallt declared.
DSS property name: Normal, DSS property index: 23
|
inline |
{Open | Closed} Normal state of the recloser.
The recloser reverts to this state for reset, change of mode, etc. Defaults to "State" if not specificallt declared.
DSS property name: Normal, DSS property index: 23
|
inline |
Number of Fast (fuse saving) operations.
Default is 1. (See "Shots")
DSS property name: NumFast, DSS property index: 5
|
inline |
Name of the TCC Curve object that determines the Phase Delayed trip.
Must have been previously defined as a TCC_Curve object. Default is "D".Multiplying the current values in the curve by the "phasetrip" value gives the actual current.
DSS property name: PhaseDelayed, DSS property index: 7
|
inline |
Name of the TCC Curve object that determines the Phase Delayed trip.
Must have been previously defined as a TCC_Curve object. Default is "D".Multiplying the current values in the curve by the "phasetrip" value gives the actual current.
DSS property name: PhaseDelayed, DSS property index: 7
|
inline |
Name of the TCC Curve object that determines the Phase Fast trip.
Must have been previously defined as a TCC_Curve object. Default is "A". Multiplying the current values in the curve by the "phasetrip" value gives the actual current.
DSS property name: PhaseFast, DSS property index: 6
|
inline |
Name of the TCC Curve object that determines the Phase Fast trip.
Must have been previously defined as a TCC_Curve object. Default is "A". Multiplying the current values in the curve by the "phasetrip" value gives the actual current.
DSS property name: PhaseFast, DSS property index: 6
|
inline |
Actual amps for instantaneous phase trip which is assumed to happen in 0.01 sec + Delay Time.
Default is 0.0, which signifies no inst trip.
DSS property name: PhaseInst, DSS property index: 12
|
inline |
Multiplier or actual phase amps for the phase TCC curve.
Defaults to 1.0.
DSS property name: PhaseTrip, DSS property index: 10
|
inline |
|
inline |
|
inline |
Total Number of fast and delayed shots to lockout.
Default is 4. This is one more than the number of reclose intervals.
DSS property name: Shots, DSS property index: 15
|
inline |
{Open | Closed} Actual state of the recloser.
Upon setting, immediately forces state of the recloser, overriding the Recloser control. Simulates manual control on recloser. Defaults to Closed. "Open" causes the controlled element to open and lock out. "Closed" causes the controlled element to close and the recloser to reset to its first operation.
DSS property name: State, DSS property index: 24
|
inline |
{Open | Closed} Actual state of the recloser.
Upon setting, immediately forces state of the recloser, overriding the Recloser control. Simulates manual control on recloser. Defaults to Closed. "Open" causes the controlled element to open and lock out. "Closed" causes the controlled element to close and the recloser to reset to its first operation.
DSS property name: State, DSS property index: 24
|
inline |
Name of circuit element switch that the Recloser controls.
Specify the full object name.Defaults to the same as the Monitored element. This is the "controlled" element.
DSS property name: SwitchedObj, DSS property index: 3
|
inline |
Name of circuit element switch that the Recloser controls.
Specify the full object name.Defaults to the same as the Monitored element. This is the "controlled" element.
DSS property name: SwitchedObj, DSS property index: 3
|
inline |
Number of the terminal of the controlled element in which the switch is controlled by the Recloser.
1 or 2, typically. Default is 1.
DSS property name: SwitchedTerm, DSS property index: 4
|
inline |
Time dial for Ground Delayed trip curve.
Multiplier on time axis of specified curve. Default=1.0.
DSS property name: TDGrDelayed, DSS property index: 22
|
inline |
Time dial for Ground Fast trip curve.
Multiplier on time axis of specified curve. Default=1.0.
DSS property name: TDGrFast, DSS property index: 20
|
inline |
Time dial for Phase Delayed trip curve.
Multiplier on time axis of specified curve. Default=1.0.
DSS property name: TDPhDelayed, DSS property index: 21
|
inline |
Time dial for Phase Fast trip curve.
Multiplier on time axis of specified curve. Default=1.0.
DSS property name: TDPhFast, DSS property index: 19