Inheritance diagram for dss::obj::Recloser:

Collaboration diagram for dss::obj::Recloser:

Classes
struct	Properties

Public Types
enum class	RecloserAction : int32_t { close = 2 , open = 1 , trip = 1 }
	Recloser: Action (DSS enumeration for Recloser) More...

enum class	RecloserState : int32_t { closed = 2 , open = 1 , trip = 1 }
	Recloser: State (DSS enumeration for Recloser) More...

Public Member Functions
	Recloser (APIUtil util=nullptr, void ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.

	Recloser (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".

	Recloser (APIUtil util, char name)
	Create a wrapper for an element given its name.

const char *	name ()
	Returns the object's name.

Recloser &	begin_edit ()
	Marks an object for edition. More...

Recloser &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...

string	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...

Recloser &	MonitoredObj (const string &value)

Recloser &	MonitoredObj (dss::obj::DSSObj &value)

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...

Recloser &	MonitoredObj_obj (dss::obj::DSSObj &value)

int32_t	MonitoredTerm ()
	Number of the terminal of the circuit element to which the Recloser is connected. More...

Recloser &	MonitoredTerm (int32_t value)

string	SwitchedObj ()
	Name of circuit element switch that the Recloser controls. More...

Recloser &	SwitchedObj (const string &value)

Recloser &	SwitchedObj (dss::obj::DSSObj &value)

dss::obj::DSSObj	SwitchedObj_obj ()
	Name of circuit element switch that the Recloser controls. More...

Recloser &	SwitchedObj_obj (dss::obj::DSSObj &value)

int32_t	SwitchedTerm ()
	Number of the terminal of the controlled element in which the switch is controlled by the Recloser. More...

Recloser &	SwitchedTerm (int32_t value)

int32_t	NumFast ()
	Number of Fast (fuse saving) operations. More...

Recloser &	NumFast (int32_t value)

string	PhaseFast ()
	Name of the TCC Curve object that determines the Phase Fast trip. More...

Recloser &	PhaseFast (const string &value)

Recloser &	PhaseFast (dss::obj::TCC_Curve &value)

dss::obj::TCC_Curve	PhaseFast_obj ()
	Name of the TCC Curve object that determines the Phase Fast trip. More...

Recloser &	PhaseFast_obj (dss::obj::TCC_Curve &value)

string	PhaseDelayed ()
	Name of the TCC Curve object that determines the Phase Delayed trip. More...

Recloser &	PhaseDelayed (const string &value)

Recloser &	PhaseDelayed (dss::obj::TCC_Curve &value)

dss::obj::TCC_Curve	PhaseDelayed_obj ()
	Name of the TCC Curve object that determines the Phase Delayed trip. More...

Recloser &	PhaseDelayed_obj (dss::obj::TCC_Curve &value)

string	GroundFast ()
	Name of the TCC Curve object that determines the Ground Fast trip. More...

Recloser &	GroundFast (const string &value)

Recloser &	GroundFast (dss::obj::TCC_Curve &value)

dss::obj::TCC_Curve	GroundFast_obj ()
	Name of the TCC Curve object that determines the Ground Fast trip. More...

Recloser &	GroundFast_obj (dss::obj::TCC_Curve &value)

string	GroundDelayed ()
	Name of the TCC Curve object that determines the Ground Delayed trip. More...

Recloser &	GroundDelayed (const string &value)

Recloser &	GroundDelayed (dss::obj::TCC_Curve &value)

dss::obj::TCC_Curve	GroundDelayed_obj ()
	Name of the TCC Curve object that determines the Ground Delayed trip. More...

Recloser &	GroundDelayed_obj (dss::obj::TCC_Curve &value)

double	PhaseTrip ()
	Multiplier or actual phase amps for the phase TCC curve. More...

Recloser &	PhaseTrip (double value)

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

Recloser &	GroundTrip (double value)

double	PhaseInst ()
	Actual amps for instantaneous phase trip which is assumed to happen in 0.01 sec + Delay Time. More...

Recloser &	PhaseInst (double value)

double	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...

Recloser &	GroundInst (double value)

double	Reset ()
	Reset time in sec for Recloser. More...

Recloser &	Reset (double value)

int32_t	Shots ()
	Total Number of fast and delayed shots to lockout. More...

Recloser &	Shots (int32_t value)

VectorXd	RecloseIntervals ()
	Array of reclose intervals. More...

Recloser &	RecloseIntervals (VectorXd &value)

double	Delay ()
	Fixed delay time (sec) added to Recloser trip time. More...

Recloser &	Delay (double value)

RecloserAction	Action ()
	DEPRECATED. More...

Recloser &	Action (int32_t value)

Recloser &	Action (RecloserAction value)

Recloser &	Action (const string &value)

Recloser &	Action (const char *value)

string	Action_str ()
	DEPRECATED. More...

Recloser &	Action_str (const string &value)
	DEPRECATED. More...

double	TDPhFast ()
	Time dial for Phase Fast trip curve. More...

Recloser &	TDPhFast (double value)

double	TDGrFast ()
	Time dial for Ground Fast trip curve. More...

Recloser &	TDGrFast (double value)

double	TDPhDelayed ()
	Time dial for Phase Delayed trip curve. More...

Recloser &	TDPhDelayed (double value)

double	TDGrDelayed ()
	Time dial for Ground Delayed trip curve. More...

Recloser &	TDGrDelayed (double value)

RecloserState	Normal ()
	{Open \| Closed} Normal state of the recloser. More...

Recloser &	Normal (int32_t value)

Recloser &	Normal (RecloserState value)

Recloser &	Normal (const string &value)

Recloser &	Normal (const char *value)

string	Normal_str ()
	{Open \| Closed} Normal state of the recloser. More...

Recloser &	Normal_str (const string &value)
	{Open \| Closed} Normal state of the recloser. More...

RecloserState	State ()
	{Open \| Closed} Actual state of the recloser. More...

Recloser &	State (int32_t value)

Recloser &	State (RecloserState value)

Recloser &	State (const string &value)

Recloser &	State (const char *value)

string	State_str ()
	{Open \| Closed} Actual state of the recloser. More...

Recloser &	State_str (const string &value)
	{Open \| Closed} Actual state of the recloser. More...

double	basefreq ()
	Base Frequency for ratings. More...

Recloser &	basefreq (double value)

bool	enabled ()
	{Yes\|No or True\|False} Indicates whether this element is enabled. More...

Recloser &	enabled (bool value)

Recloser &	like (const string &value)
	Make like another object, e.g. More...

Recloser &	like (const char *value)
	Make like another object, e.g. More...

Public Member Functions inherited from dss::obj::DSSObj
	DSSObj (APIUtil util=nullptr, void ptr_=nullptr)

Static Public Attributes
static const char	dss_cls_name [] = "Recloser"

static const int32_t	dss_cls_idx = 31

Additional Inherited Members
Public Attributes inherited from dss::obj::DSSObj
APIUtil *	api_util

void *	ptr

Protected Member Functions inherited from dss::obj::DSSObj
void	check_for_error ()

void	set_string (int32_t index, const string &value)

void	set_string (int32_t index, const char *value)

string	get_prop_string (int32_t index)

complex	get_complex (int32_t index)

void	set_complex (int32_t index, complex value)

void	set_string_array (int32_t index, strings &value)

void	set_obj (int32_t index, DSSObj &value)

template<typename T >
T	get_obj (int32_t index)

template<typename T = VectorXd>
T	get_array (int32_t index)

template<typename T = VectorXd>
void	set_array (int32_t index, T value)

Static Protected Member Functions inherited from dss::obj::DSSObj
template<typename T = VectorXd>
static void	set_array (void *ptr, int32_t index, T value)

Protected Attributes inherited from dss::obj::DSSObj
friend	DSSBatch

Member Enumeration Documentation

◆ RecloserAction

enum class dss::obj::Recloser::RecloserAction : int32_t

strong

Recloser: Action (DSS enumeration for Recloser)

Enumerator
close	close
open	open
trip	trip

◆ RecloserState

enum class dss::obj::Recloser::RecloserState : int32_t

strong

Recloser: State (DSS enumeration for Recloser)

Enumerator
closed	closed
open	open
trip	trip

Member Function Documentation

◆ Action()

RecloserAction dss::obj::Recloser::Action ( )

inline

DEPRECATED.

See "State" property

DSS property name: Action, DSS property index: 18

◆ Action_str() [1/2]

string dss::obj::Recloser::Action_str ( )

inline

DEPRECATED.

See "State" property

DSS property name: Action, DSS property index: 18

◆ Action_str() [2/2]

Recloser & dss::obj::Recloser::Action_str ( const string & value )

inline

DEPRECATED.

See "State" property

DSS property name: Action, DSS property index: 18

◆ basefreq()

double dss::obj::Recloser::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 25

◆ begin_edit()

Recloser & dss::obj::Recloser::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ Delay()

double dss::obj::Recloser::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()

bool dss::obj::Recloser::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 26

◆ end_edit()

Recloser & dss::obj::Recloser::end_edit ( int32_t num_edits = 1 )

inline

Finalizes an object edition.

This will result more compelx side-effects like Yprim and other internal data recalculation, for example.

◆ GroundDelayed()

string dss::obj::Recloser::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()

dss::obj::TCC_Curve dss::obj::Recloser::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()

string dss::obj::Recloser::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()

dss::obj::TCC_Curve dss::obj::Recloser::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()

double dss::obj::Recloser::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()

double dss::obj::Recloser::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]

Recloser & dss::obj::Recloser::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]

Recloser & dss::obj::Recloser::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()

string dss::obj::Recloser::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()

dss::obj::DSSObj dss::obj::Recloser::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()

int32_t dss::obj::Recloser::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()

RecloserState dss::obj::Recloser::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() [1/2]

string dss::obj::Recloser::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

◆ Normal_str() [2/2]

Recloser & dss::obj::Recloser::Normal_str ( const string & value )

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()

int32_t dss::obj::Recloser::NumFast ( )

inline

Number of Fast (fuse saving) operations.

Default is 1. (See "Shots")

DSS property name: NumFast, DSS property index: 5

◆ PhaseDelayed()

string dss::obj::Recloser::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()

dss::obj::TCC_Curve dss::obj::Recloser::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()

string dss::obj::Recloser::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()

dss::obj::TCC_Curve dss::obj::Recloser::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()

double dss::obj::Recloser::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()

double dss::obj::Recloser::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()

VectorXd dss::obj::Recloser::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()

double dss::obj::Recloser::Reset ( )

inline

Reset time in sec for Recloser.

Default is 15.

DSS property name: Reset, DSS property index: 14

◆ Shots()

int32_t dss::obj::Recloser::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()

RecloserState dss::obj::Recloser::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() [1/2]

string dss::obj::Recloser::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

◆ State_str() [2/2]

Recloser & dss::obj::Recloser::State_str ( const string & value )

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()

string dss::obj::Recloser::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()

dss::obj::DSSObj dss::obj::Recloser::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()

int32_t dss::obj::Recloser::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()

double dss::obj::Recloser::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()

double dss::obj::Recloser::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()

double dss::obj::Recloser::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()

double dss::obj::Recloser::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:

include/dss_obj.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ RecloserAction

◆ RecloserState

Member Function Documentation

◆ Action()

◆ Action_str() [1/2]

◆ Action_str() [2/2]

◆ basefreq()

◆ begin_edit()

◆ Delay()

◆ enabled()

◆ end_edit()

◆ GroundDelayed()

◆ GroundDelayed_obj()

◆ GroundFast()

◆ GroundFast_obj()

◆ GroundInst()

◆ GroundTrip()

◆ like() [1/2]

◆ like() [2/2]

◆ MonitoredObj()

◆ MonitoredObj_obj()

◆ MonitoredTerm()

◆ Normal()

◆ Normal_str() [1/2]

◆ Normal_str() [2/2]

◆ NumFast()

◆ PhaseDelayed()

◆ PhaseDelayed_obj()

◆ PhaseFast()

◆ PhaseFast_obj()

◆ PhaseInst()

◆ PhaseTrip()

◆ RecloseIntervals()

◆ Reset()

◆ Shots()

◆ State()

◆ State_str() [1/2]

◆ State_str() [2/2]

◆ SwitchedObj()

◆ SwitchedObj_obj()

◆ SwitchedTerm()

◆ TDGrDelayed()

◆ TDGrFast()

◆ TDPhDelayed()

◆ TDPhFast()