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

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.
 
RecloserBatchbegin_edit ()
 
RecloserBatchend_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...
 
RecloserBatchMonitoredObj (dss::obj::DSSObj &value)
 
RecloserBatchMonitoredObj (const string &value)
 
std::vector< dss::obj::DSSObjMonitoredObj_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...
 
RecloserBatchMonitoredObj_obj (dss::obj::DSSObj &value)
 
BatchInt32ArrayProxy MonitoredTerm ()
 Number of the terminal of the circuit element to which the Recloser is connected. More...
 
RecloserBatchMonitoredTerm (int32_t value)
 
template<typename T >
RecloserBatchMonitoredTerm (T &value)
 
template<typename T >
RecloserBatchMonitoredTerm (typename T::iterator it_begin, typename T::iterator it_end)
 
strings SwitchedObj ()
 Name of circuit element switch that the Recloser controls. More...
 
RecloserBatchSwitchedObj (dss::obj::DSSObj &value)
 
RecloserBatchSwitchedObj (const string &value)
 
std::vector< dss::obj::DSSObjSwitchedObj_obj ()
 Name of circuit element switch that the Recloser controls. More...
 
RecloserBatchSwitchedObj_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...
 
RecloserBatchSwitchedTerm (int32_t value)
 
template<typename T >
RecloserBatchSwitchedTerm (T &value)
 
template<typename T >
RecloserBatchSwitchedTerm (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy NumFast ()
 Number of Fast (fuse saving) operations. More...
 
RecloserBatchNumFast (int32_t value)
 
template<typename T >
RecloserBatchNumFast (T &value)
 
template<typename T >
RecloserBatchNumFast (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...
 
RecloserBatchPhaseFast (dss::obj::TCC_Curve &value)
 
RecloserBatchPhaseFast (const string &value)
 
std::vector< dss::obj::TCC_CurvePhaseFast_obj ()
 Name of the TCC Curve object that determines the Phase Fast trip. More...
 
RecloserBatchPhaseFast_obj (dss::obj::TCC_Curve &value)
 
strings PhaseDelayed ()
 Name of the TCC Curve object that determines the Phase Delayed trip. More...
 
RecloserBatchPhaseDelayed (dss::obj::TCC_Curve &value)
 
RecloserBatchPhaseDelayed (const string &value)
 
std::vector< dss::obj::TCC_CurvePhaseDelayed_obj ()
 Name of the TCC Curve object that determines the Phase Delayed trip. More...
 
RecloserBatchPhaseDelayed_obj (dss::obj::TCC_Curve &value)
 
strings GroundFast ()
 Name of the TCC Curve object that determines the Ground Fast trip. More...
 
RecloserBatchGroundFast (dss::obj::TCC_Curve &value)
 
RecloserBatchGroundFast (const string &value)
 
std::vector< dss::obj::TCC_CurveGroundFast_obj ()
 Name of the TCC Curve object that determines the Ground Fast trip. More...
 
RecloserBatchGroundFast_obj (dss::obj::TCC_Curve &value)
 
strings GroundDelayed ()
 Name of the TCC Curve object that determines the Ground Delayed trip. More...
 
RecloserBatchGroundDelayed (dss::obj::TCC_Curve &value)
 
RecloserBatchGroundDelayed (const string &value)
 
std::vector< dss::obj::TCC_CurveGroundDelayed_obj ()
 Name of the TCC Curve object that determines the Ground Delayed trip. More...
 
RecloserBatchGroundDelayed_obj (dss::obj::TCC_Curve &value)
 
BatchFloat64ArrayProxy PhaseTrip ()
 Multiplier or actual phase amps for the phase TCC curve. More...
 
RecloserBatchPhaseTrip (double value)
 
template<typename T >
RecloserBatchPhaseTrip (T &value)
 
template<typename T >
RecloserBatchPhaseTrip (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy GroundTrip ()
 Multiplier or actual ground amps (3I0) for the ground TCC curve. More...
 
RecloserBatchGroundTrip (double value)
 
template<typename T >
RecloserBatchGroundTrip (T &value)
 
template<typename T >
RecloserBatchGroundTrip (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...
 
RecloserBatchPhaseInst (double value)
 
template<typename T >
RecloserBatchPhaseInst (T &value)
 
template<typename T >
RecloserBatchPhaseInst (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...
 
RecloserBatchGroundInst (double value)
 
template<typename T >
RecloserBatchGroundInst (T &value)
 
template<typename T >
RecloserBatchGroundInst (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy Reset ()
 Reset time in sec for Recloser. More...
 
RecloserBatchReset (double value)
 
template<typename T >
RecloserBatchReset (T &value)
 
template<typename T >
RecloserBatchReset (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy Shots ()
 Total Number of fast and delayed shots to lockout. More...
 
RecloserBatchShots (int32_t value)
 
template<typename T >
RecloserBatchShots (T &value)
 
template<typename T >
RecloserBatchShots (typename T::iterator it_begin, typename T::iterator it_end)
 
std::vector< VectorXd > RecloseIntervals ()
 Array of reclose intervals. More...
 
RecloserBatchRecloseIntervals (VectorXd &value)
 
BatchFloat64ArrayProxy Delay ()
 Fixed delay time (sec) added to Recloser trip time. More...
 
RecloserBatchDelay (double value)
 
template<typename T >
RecloserBatchDelay (T &value)
 
template<typename T >
RecloserBatchDelay (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy Action ()
 DEPRECATED. More...
 
RecloserBatchAction (string &value)
 
RecloserBatchAction (int32_t value)
 
RecloserBatchAction (Recloser::RecloserAction value)
 
RecloserBatchAction (strings &value)
 
RecloserBatchAction (std::vector< int32_t > &value)
 
RecloserBatchAction (std::vector< Recloser::RecloserAction > &value)
 
strings Action_str ()
 DEPRECATED. More...
 
RecloserBatchAction_str (string &value)
 
RecloserBatchAction_str (strings &value)
 
BatchFloat64ArrayProxy TDPhFast ()
 Time dial for Phase Fast trip curve. More...
 
RecloserBatchTDPhFast (double value)
 
template<typename T >
RecloserBatchTDPhFast (T &value)
 
template<typename T >
RecloserBatchTDPhFast (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy TDGrFast ()
 Time dial for Ground Fast trip curve. More...
 
RecloserBatchTDGrFast (double value)
 
template<typename T >
RecloserBatchTDGrFast (T &value)
 
template<typename T >
RecloserBatchTDGrFast (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy TDPhDelayed ()
 Time dial for Phase Delayed trip curve. More...
 
RecloserBatchTDPhDelayed (double value)
 
template<typename T >
RecloserBatchTDPhDelayed (T &value)
 
template<typename T >
RecloserBatchTDPhDelayed (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchFloat64ArrayProxy TDGrDelayed ()
 Time dial for Ground Delayed trip curve. More...
 
RecloserBatchTDGrDelayed (double value)
 
template<typename T >
RecloserBatchTDGrDelayed (T &value)
 
template<typename T >
RecloserBatchTDGrDelayed (typename T::iterator it_begin, typename T::iterator it_end)
 
BatchInt32ArrayProxy Normal ()
 {Open | Closed} Normal state of the recloser. More...
 
RecloserBatchNormal (string &value)
 
RecloserBatchNormal (int32_t value)
 
RecloserBatchNormal (Recloser::RecloserState value)
 
RecloserBatchNormal (strings &value)
 
RecloserBatchNormal (std::vector< int32_t > &value)
 
RecloserBatchNormal (std::vector< Recloser::RecloserState > &value)
 
strings Normal_str ()
 {Open | Closed} Normal state of the recloser. More...
 
RecloserBatchNormal_str (string &value)
 
RecloserBatchNormal_str (strings &value)
 
BatchInt32ArrayProxy State ()
 {Open | Closed} Actual state of the recloser. More...
 
RecloserBatchState (string &value)
 
RecloserBatchState (int32_t value)
 
RecloserBatchState (Recloser::RecloserState value)
 
RecloserBatchState (strings &value)
 
RecloserBatchState (std::vector< int32_t > &value)
 
RecloserBatchState (std::vector< Recloser::RecloserState > &value)
 
strings State_str ()
 {Open | Closed} Actual state of the recloser. More...
 
RecloserBatchState_str (string &value)
 
RecloserBatchState_str (strings &value)
 
BatchFloat64ArrayProxy basefreq ()
 Base Frequency for ratings. More...
 
RecloserBatchbasefreq (double value)
 
template<typename T >
RecloserBatchbasefreq (T &value)
 
template<typename T >
RecloserBatchbasefreq (typename T::iterator it_begin, typename T::iterator it_end)
 
bools enabled ()
 {Yes|No or True|False} Indicates whether this element is enabled. More...
 
RecloserBatchenabled (bool value)
 
RecloserBatchenabled (bools &value)
 
RecloserBatchlike (const string &value)
 Make like another object, e.g. More...
 
RecloserBatchlike (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
APIUtilapi_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>
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)
 

Member Function Documentation

◆ Action()

BatchInt32ArrayProxy dss::obj::RecloserBatch::Action ( )
inline

DEPRECATED.

See "State" property

DSS property name: Action, DSS property index: 18

◆ Action_str()

strings dss::obj::RecloserBatch::Action_str ( )
inline

DEPRECATED.

See "State" property

DSS property name: Action, DSS property index: 18

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::basefreq ( )
inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 25

◆ Delay()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::Delay ( )
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

◆ enabled()

bools dss::obj::RecloserBatch::enabled ( )
inline

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 26

◆ GroundDelayed()

strings dss::obj::RecloserBatch::GroundDelayed ( )
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

◆ GroundDelayed_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RecloserBatch::GroundDelayed_obj ( )
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

◆ GroundFast()

strings dss::obj::RecloserBatch::GroundFast ( )
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

◆ GroundFast_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RecloserBatch::GroundFast_obj ( )
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

◆ GroundInst()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::GroundInst ( )
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

◆ GroundTrip()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::GroundTrip ( )
inline

Multiplier or actual ground amps (3I0) for the ground TCC curve.

Defaults to 1.0.

DSS property name: GroundTrip, DSS property index: 11

◆ like() [1/2]

RecloserBatch & dss::obj::RecloserBatch::like ( const char *  value)
inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 27

◆ like() [2/2]

RecloserBatch & dss::obj::RecloserBatch::like ( const string &  value)
inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 27

◆ MonitoredObj()

strings dss::obj::RecloserBatch::MonitoredObj ( )
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

◆ MonitoredObj_obj()

std::vector< dss::obj::DSSObj > dss::obj::RecloserBatch::MonitoredObj_obj ( )
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

◆ MonitoredTerm()

BatchInt32ArrayProxy dss::obj::RecloserBatch::MonitoredTerm ( )
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

◆ Normal()

BatchInt32ArrayProxy dss::obj::RecloserBatch::Normal ( )
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

◆ Normal_str()

strings dss::obj::RecloserBatch::Normal_str ( )
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

◆ NumFast()

BatchInt32ArrayProxy dss::obj::RecloserBatch::NumFast ( )
inline

Number of Fast (fuse saving) operations.

Default is 1. (See "Shots")

DSS property name: NumFast, DSS property index: 5

◆ PhaseDelayed()

strings dss::obj::RecloserBatch::PhaseDelayed ( )
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

◆ PhaseDelayed_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RecloserBatch::PhaseDelayed_obj ( )
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

◆ PhaseFast()

strings dss::obj::RecloserBatch::PhaseFast ( )
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

◆ PhaseFast_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RecloserBatch::PhaseFast_obj ( )
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

◆ PhaseInst()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::PhaseInst ( )
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

◆ PhaseTrip()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::PhaseTrip ( )
inline

Multiplier or actual phase amps for the phase TCC curve.

Defaults to 1.0.

DSS property name: PhaseTrip, DSS property index: 10

◆ RecloseIntervals()

std::vector< VectorXd > dss::obj::RecloserBatch::RecloseIntervals ( )
inline

Array of reclose intervals.

Default for Recloser is (0.5, 2.0, 2.0) seconds. A locked out Recloser must be closed manually (action=close).

DSS property name: RecloseIntervals, DSS property index: 16

◆ Reset()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::Reset ( )
inline

Reset time in sec for Recloser.

Default is 15.

DSS property name: Reset, DSS property index: 14

◆ Shots()

BatchInt32ArrayProxy dss::obj::RecloserBatch::Shots ( )
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

◆ State()

BatchInt32ArrayProxy dss::obj::RecloserBatch::State ( )
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

◆ State_str()

strings dss::obj::RecloserBatch::State_str ( )
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

◆ SwitchedObj()

strings dss::obj::RecloserBatch::SwitchedObj ( )
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

◆ SwitchedObj_obj()

std::vector< dss::obj::DSSObj > dss::obj::RecloserBatch::SwitchedObj_obj ( )
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

◆ SwitchedTerm()

BatchInt32ArrayProxy dss::obj::RecloserBatch::SwitchedTerm ( )
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

◆ TDGrDelayed()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::TDGrDelayed ( )
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

◆ TDGrFast()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::TDGrFast ( )
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

◆ TDPhDelayed()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::TDPhDelayed ( )
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

◆ TDPhFast()

BatchFloat64ArrayProxy dss::obj::RecloserBatch::TDPhFast ( )
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


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