Inheritance diagram for dss::obj::RelayBatch:

Collaboration diagram for dss::obj::RelayBatch:

Public Types
typedef Relay::Properties	Properties

typedef Relay	BatchElementClass

typedef Relay::RelayType	RelayType

typedef Relay::RelayAction	RelayAction

typedef Relay::RelayState	RelayState

Public Member Functions
	RelayBatch (APIUtil *util)
	Create a batch of all Relay elements.

	RelayBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all Relay elements that match an integer property value.

	RelayBatch (APIUtil util, const char regexp)
	Create a batch of all Relay elements that match a regular expression.

RelayBatch &	begin_edit ()

RelayBatch &	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 relay's PT and/or CT are connected. More...

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

RelayBatch &	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 relay's PT and/or CT are connected. More...

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

BatchInt32ArrayProxy	MonitoredTerm ()
	Number of the terminal of the circuit element to which the Relay is connected. More...

RelayBatch &	MonitoredTerm (int32_t value)

template<typename T >
RelayBatch &	MonitoredTerm (T &value)

template<typename T >
RelayBatch &	MonitoredTerm (typename T::iterator it_begin, typename T::iterator it_end)

strings	SwitchedObj ()
	Name of circuit element switch that the Relay controls. More...

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

RelayBatch &	SwitchedObj (const string &value)

std::vector< dss::obj::DSSObj >	SwitchedObj_obj ()
	Name of circuit element switch that the Relay controls. More...

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

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

RelayBatch &	SwitchedTerm (int32_t value)

template<typename T >
RelayBatch &	SwitchedTerm (T &value)

template<typename T >
RelayBatch &	SwitchedTerm (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	type ()
	One of a legal relay type: Current Voltage Reversepower 46 (neg seq current) 47 (neg seq voltage) Generic (generic over/under relay) Distance TD21 DOC (directional overcurrent) More...

RelayBatch &	type (string &value)

RelayBatch &	type (int32_t value)

RelayBatch &	type (Relay::RelayType value)

RelayBatch &	type (strings &value)

RelayBatch &	type (std::vector< int32_t > &value)

RelayBatch &	type (std::vector< Relay::RelayType > &value)

strings	type_str ()
	One of a legal relay type: Current Voltage Reversepower 46 (neg seq current) 47 (neg seq voltage) Generic (generic over/under relay) Distance TD21 DOC (directional overcurrent) More...

RelayBatch &	type_str (string &value)

RelayBatch &	type_str (strings &value)

strings	Phasecurve ()
	Name of the TCC Curve object that determines the phase trip. More...

RelayBatch &	Phasecurve (dss::obj::TCC_Curve &value)

RelayBatch &	Phasecurve (const string &value)

std::vector< dss::obj::TCC_Curve >	Phasecurve_obj ()
	Name of the TCC Curve object that determines the phase trip. More...

RelayBatch &	Phasecurve_obj (dss::obj::TCC_Curve &value)

strings	Groundcurve ()
	Name of the TCC Curve object that determines the ground trip. More...

RelayBatch &	Groundcurve (dss::obj::TCC_Curve &value)

RelayBatch &	Groundcurve (const string &value)

std::vector< dss::obj::TCC_Curve >	Groundcurve_obj ()
	Name of the TCC Curve object that determines the ground trip. More...

RelayBatch &	Groundcurve_obj (dss::obj::TCC_Curve &value)

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

RelayBatch &	PhaseTrip (double value)

template<typename T >
RelayBatch &	PhaseTrip (T &value)

template<typename T >
RelayBatch &	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...

RelayBatch &	GroundTrip (double value)

template<typename T >
RelayBatch &	GroundTrip (T &value)

template<typename T >
RelayBatch &	GroundTrip (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	TDPhase ()
	Time dial for Phase trip curve. More...

RelayBatch &	TDPhase (double value)

template<typename T >
RelayBatch &	TDPhase (T &value)

template<typename T >
RelayBatch &	TDPhase (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	TDGround ()
	Time dial for Ground trip curve. More...

RelayBatch &	TDGround (double value)

template<typename T >
RelayBatch &	TDGround (T &value)

template<typename T >
RelayBatch &	TDGround (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	PhaseInst ()
	Actual amps (Current relay) or kW (reverse power relay) for instantaneous phase trip which is assumed to happen in 0.01 sec + Delay Time. More...

RelayBatch &	PhaseInst (double value)

template<typename T >
RelayBatch &	PhaseInst (T &value)

template<typename T >
RelayBatch &	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...

RelayBatch &	GroundInst (double value)

template<typename T >
RelayBatch &	GroundInst (T &value)

template<typename T >
RelayBatch &	GroundInst (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Reset ()
	Reset time in sec for relay. More...

RelayBatch &	Reset (double value)

template<typename T >
RelayBatch &	Reset (T &value)

template<typename T >
RelayBatch &	Reset (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Shots ()
	Number of shots to lockout. More...

RelayBatch &	Shots (int32_t value)

template<typename T >
RelayBatch &	Shots (T &value)

template<typename T >
RelayBatch &	Shots (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	RecloseIntervals ()
	Array of reclose intervals. More...

RelayBatch &	RecloseIntervals (VectorXd &value)

BatchFloat64ArrayProxy	Delay ()
	Trip time delay (sec) for DEFINITE TIME relays. More...

RelayBatch &	Delay (double value)

template<typename T >
RelayBatch &	Delay (T &value)

template<typename T >
RelayBatch &	Delay (typename T::iterator it_begin, typename T::iterator it_end)

strings	Overvoltcurve ()
	TCC Curve object to use for overvoltage relay. More...

RelayBatch &	Overvoltcurve (dss::obj::TCC_Curve &value)

RelayBatch &	Overvoltcurve (const string &value)

std::vector< dss::obj::TCC_Curve >	Overvoltcurve_obj ()
	TCC Curve object to use for overvoltage relay. More...

RelayBatch &	Overvoltcurve_obj (dss::obj::TCC_Curve &value)

strings	Undervoltcurve ()
	TCC Curve object to use for undervoltage relay. More...

RelayBatch &	Undervoltcurve (dss::obj::TCC_Curve &value)

RelayBatch &	Undervoltcurve (const string &value)

std::vector< dss::obj::TCC_Curve >	Undervoltcurve_obj ()
	TCC Curve object to use for undervoltage relay. More...

RelayBatch &	Undervoltcurve_obj (dss::obj::TCC_Curve &value)

BatchFloat64ArrayProxy	kvbase ()
	Voltage base (kV) for the relay. More...

RelayBatch &	kvbase (double value)

template<typename T >
RelayBatch &	kvbase (T &value)

template<typename T >
RelayBatch &	kvbase (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctPickup47 ()
	Percent voltage pickup for 47 relay (Neg seq voltage). More...

RelayBatch &	pctPickup47 (double value)

template<typename T >
RelayBatch &	pctPickup47 (T &value)

template<typename T >
RelayBatch &	pctPickup47 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	BaseAmps46 ()
	Base current, Amps, for 46 relay (neg seq current). More...

RelayBatch &	BaseAmps46 (double value)

template<typename T >
RelayBatch &	BaseAmps46 (T &value)

template<typename T >
RelayBatch &	BaseAmps46 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctPickup46 ()
	Percent pickup current for 46 relay (neg seq current). More...

RelayBatch &	pctPickup46 (double value)

template<typename T >
RelayBatch &	pctPickup46 (T &value)

template<typename T >
RelayBatch &	pctPickup46 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	isqt46 ()
	Negative Sequence I-squared-t trip value for 46 relay (neg seq current). More...

RelayBatch &	isqt46 (double value)

template<typename T >
RelayBatch &	isqt46 (T &value)

template<typename T >
RelayBatch &	isqt46 (typename T::iterator it_begin, typename T::iterator it_end)

strings	Variable ()
	Name of variable in PC Elements being monitored. More...

RelayBatch &	Variable (const string &value)

RelayBatch &	Variable (strings &value)

BatchFloat64ArrayProxy	overtrip ()
	Trip setting (high value) for Generic relay variable. More...

RelayBatch &	overtrip (double value)

template<typename T >
RelayBatch &	overtrip (T &value)

template<typename T >
RelayBatch &	overtrip (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	undertrip ()
	Trip setting (low value) for Generic relay variable. More...

RelayBatch &	undertrip (double value)

template<typename T >
RelayBatch &	undertrip (T &value)

template<typename T >
RelayBatch &	undertrip (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Breakertime ()
	Fixed delay time (sec) added to relay time. More...

RelayBatch &	Breakertime (double value)

template<typename T >
RelayBatch &	Breakertime (T &value)

template<typename T >
RelayBatch &	Breakertime (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	action ()
	DEPRECATED. More...

RelayBatch &	action (string &value)

RelayBatch &	action (int32_t value)

RelayBatch &	action (Relay::RelayAction value)

RelayBatch &	action (strings &value)

RelayBatch &	action (std::vector< int32_t > &value)

RelayBatch &	action (std::vector< Relay::RelayAction > &value)

strings	action_str ()
	DEPRECATED. More...

RelayBatch &	action_str (string &value)

RelayBatch &	action_str (strings &value)

BatchFloat64ArrayProxy	Z1mag ()
	Positive sequence reach impedance in primary ohms for Distance and TD21 functions. More...

RelayBatch &	Z1mag (double value)

template<typename T >
RelayBatch &	Z1mag (T &value)

template<typename T >
RelayBatch &	Z1mag (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Z1ang ()
	Positive sequence reach impedance angle in degrees for Distance and TD21 functions. More...

RelayBatch &	Z1ang (double value)

template<typename T >
RelayBatch &	Z1ang (T &value)

template<typename T >
RelayBatch &	Z1ang (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Z0mag ()
	Zero sequence reach impedance in primary ohms for Distance and TD21 functions. More...

RelayBatch &	Z0mag (double value)

template<typename T >
RelayBatch &	Z0mag (T &value)

template<typename T >
RelayBatch &	Z0mag (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Z0ang ()
	Zero sequence reach impedance angle in degrees for Distance and TD21 functions. More...

RelayBatch &	Z0ang (double value)

template<typename T >
RelayBatch &	Z0ang (T &value)

template<typename T >
RelayBatch &	Z0ang (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Mphase ()
	Phase reach multiplier in per-unit for Distance and TD21 functions. More...

RelayBatch &	Mphase (double value)

template<typename T >
RelayBatch &	Mphase (T &value)

template<typename T >
RelayBatch &	Mphase (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Mground ()
	Ground reach multiplier in per-unit for Distance and TD21 functions. More...

RelayBatch &	Mground (double value)

template<typename T >
RelayBatch &	Mground (T &value)

template<typename T >
RelayBatch &	Mground (typename T::iterator it_begin, typename T::iterator it_end)

bools	EventLog ()
	{Yes/True* \| No/False} Default is Yes for Relay. More...

RelayBatch &	EventLog (bool value)

RelayBatch &	EventLog (bools &value)

bools	DebugTrace ()
	{Yes/True* \| No/False} Default is No for Relay. More...

RelayBatch &	DebugTrace (bool value)

RelayBatch &	DebugTrace (bools &value)

bools	DistReverse ()
	{Yes/True* \| No/False} Default is No; reverse direction for distance and td21 types. More...

RelayBatch &	DistReverse (bool value)

RelayBatch &	DistReverse (bools &value)

BatchInt32ArrayProxy	Normal ()
	{Open \| Closed} Normal state of the relay. More...

RelayBatch &	Normal (string &value)

RelayBatch &	Normal (int32_t value)

RelayBatch &	Normal (Relay::RelayState value)

RelayBatch &	Normal (strings &value)

RelayBatch &	Normal (std::vector< int32_t > &value)

RelayBatch &	Normal (std::vector< Relay::RelayState > &value)

strings	Normal_str ()
	{Open \| Closed} Normal state of the relay. More...

RelayBatch &	Normal_str (string &value)

RelayBatch &	Normal_str (strings &value)

BatchInt32ArrayProxy	State ()
	{Open \| Closed} Actual state of the relay. More...

RelayBatch &	State (string &value)

RelayBatch &	State (int32_t value)

RelayBatch &	State (Relay::RelayState value)

RelayBatch &	State (strings &value)

RelayBatch &	State (std::vector< int32_t > &value)

RelayBatch &	State (std::vector< Relay::RelayState > &value)

strings	State_str ()
	{Open \| Closed} Actual state of the relay. More...

RelayBatch &	State_str (string &value)

RelayBatch &	State_str (strings &value)

BatchFloat64ArrayProxy	DOC_TiltAngleLow ()
	Tilt angle for lower current magnitudes. More...

RelayBatch &	DOC_TiltAngleLow (double value)

template<typename T >
RelayBatch &	DOC_TiltAngleLow (T &value)

template<typename T >
RelayBatch &	DOC_TiltAngleLow (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_TiltAngleHigh ()
	Tilt angle for higher current magnitudes. More...

RelayBatch &	DOC_TiltAngleHigh (double value)

template<typename T >
RelayBatch &	DOC_TiltAngleHigh (T &value)

template<typename T >
RelayBatch &	DOC_TiltAngleHigh (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_TripSettingLow ()
	Trip setting for lower current magnitude. More...

RelayBatch &	DOC_TripSettingLow (double value)

template<typename T >
RelayBatch &	DOC_TripSettingLow (T &value)

template<typename T >
RelayBatch &	DOC_TripSettingLow (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_TripSettingHigh ()
	Trip setting for higher current magnitude. More...

RelayBatch &	DOC_TripSettingHigh (double value)

template<typename T >
RelayBatch &	DOC_TripSettingHigh (T &value)

template<typename T >
RelayBatch &	DOC_TripSettingHigh (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_TripSettingMag ()
	Trip setting for current magnitude (define a circle for the relay characteristics). More...

RelayBatch &	DOC_TripSettingMag (double value)

template<typename T >
RelayBatch &	DOC_TripSettingMag (T &value)

template<typename T >
RelayBatch &	DOC_TripSettingMag (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_DelayInner ()
	Trip time delay (sec) for operation in inner zone for DOC relay, defined when "DOC_TripSettingMag" or "DOC_TripSettingHigh" are activate. More...

RelayBatch &	DOC_DelayInner (double value)

template<typename T >
RelayBatch &	DOC_DelayInner (T &value)

template<typename T >
RelayBatch &	DOC_DelayInner (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_PhaseCurveInner ()
	Name of the TCC Curve object that determines the phase trip for operation in inner zone for DOC relay. More...

RelayBatch &	DOC_PhaseCurveInner (double value)

template<typename T >
RelayBatch &	DOC_PhaseCurveInner (T &value)

template<typename T >
RelayBatch &	DOC_PhaseCurveInner (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	DOC_PhaseTripInner ()
	Multiplier for the "DOC_PhaseCurveInner" TCC curve. More...

RelayBatch &	DOC_PhaseTripInner (double value)

template<typename T >
RelayBatch &	DOC_PhaseTripInner (T &value)

template<typename T >
RelayBatch &	DOC_PhaseTripInner (typename T::iterator it_begin, typename T::iterator it_end)

strings	DOC_TDPhaseInner ()
	Time dial for "DOC_PhaseCurveInner" TCC curve. More...

RelayBatch &	DOC_TDPhaseInner (dss::obj::TCC_Curve &value)

RelayBatch &	DOC_TDPhaseInner (const string &value)

std::vector< dss::obj::TCC_Curve >	DOC_TDPhaseInner_obj ()
	Time dial for "DOC_PhaseCurveInner" TCC curve. More...

RelayBatch &	DOC_TDPhaseInner_obj (dss::obj::TCC_Curve &value)

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

RelayBatch &	basefreq (double value)

template<typename T >
RelayBatch &	basefreq (T &value)

template<typename T >
RelayBatch &	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...

RelayBatch &	enabled (bool value)

RelayBatch &	enabled (bools &value)

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

RelayBatch &	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)

Member Function Documentation

◆ action()

BatchInt32ArrayProxy dss::obj::RelayBatch::action ( )

inline

DEPRECATED.

See "State" property

DSS property name: action, DSS property index: 29

◆ action_str()

strings dss::obj::RelayBatch::action_str ( )

inline

DEPRECATED.

See "State" property

DSS property name: action, DSS property index: 29

◆ BaseAmps46()

BatchFloat64ArrayProxy dss::obj::RelayBatch::BaseAmps46 ( )

inline

Base current, Amps, for 46 relay (neg seq current).

Used for establishing pickup and per unit I-squared-t.

DSS property name: 46BaseAmps, DSS property index: 22

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::RelayBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 50

◆ Breakertime()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Breakertime ( )

inline

Fixed delay time (sec) added to relay time.

Default is 0.0. Designed to represent breaker time or some other delay after a trip decision is made.Use Delay property for setting a fixed trip time delay.Added to trip time of current and voltage relays. Could use in combination with inst trip value to obtain a definite time overcurrent relay.

DSS property name: Breakertime, DSS property index: 28

◆ DebugTrace()

bools dss::obj::RelayBatch::DebugTrace ( )

inline

{Yes/True* | No/False} Default is No for Relay.

Write extra details to Eventlog.

DSS property name: DebugTrace, DSS property index: 37

◆ Delay()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Delay ( )

inline

Trip time delay (sec) for DEFINITE TIME relays.

Default is 0.0 for current and voltage relays. If >0 then this value is used instead of curves. Used by Generic, RevPower, 46 and 47 relays. Defaults to 0.1 s for these relays.

DSS property name: Delay, DSS property index: 17

◆ DistReverse()

bools dss::obj::RelayBatch::DistReverse ( )

inline

{Yes/True* | No/False} Default is No; reverse direction for distance and td21 types.

DSS property name: DistReverse, DSS property index: 38

◆ DOC_DelayInner()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_DelayInner ( )

inline

Trip time delay (sec) for operation in inner zone for DOC relay, defined when "DOC_TripSettingMag" or "DOC_TripSettingHigh" are activate.

Default is -1.0 (deactivated), meaning that the relay characteristic is insensitive in the inner zone (no trip). Set to 0 for instantaneous trip and >0 for a definite time delay. If "DOC_PhaseCurveInner" is specified, time delay from curve is utilized instead.

DSS property name: DOC_DelayInner, DSS property index: 46

◆ DOC_PhaseCurveInner()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_PhaseCurveInner ( )

inline

Name of the TCC Curve object that determines the phase trip for operation in inner zone for DOC relay.

Must have been previously defined as a TCC_Curve object. Default is none (ignored). Multiplying the current values in the curve by the "DOC_PhaseTripInner" value gives the actual current.

DSS property name: DOC_PhaseCurveInner, DSS property index: 47

◆ DOC_PhaseTripInner()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_PhaseTripInner ( )

inline

Multiplier for the "DOC_PhaseCurveInner" TCC curve.

Defaults to 1.0.

DSS property name: DOC_PhaseTripInner, DSS property index: 48

◆ DOC_TDPhaseInner()

strings dss::obj::RelayBatch::DOC_TDPhaseInner ( )

inline

Time dial for "DOC_PhaseCurveInner" TCC curve.

Multiplier on time axis of specified curve. Default=1.0.

DSS property name: DOC_TDPhaseInner, DSS property index: 49

◆ DOC_TDPhaseInner_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RelayBatch::DOC_TDPhaseInner_obj ( )

inline

Time dial for "DOC_PhaseCurveInner" TCC curve.

Multiplier on time axis of specified curve. Default=1.0.

DSS property name: DOC_TDPhaseInner, DSS property index: 49

◆ DOC_TiltAngleHigh()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_TiltAngleHigh ( )

inline

Tilt angle for higher current magnitudes.

Default is 90.

DSS property name: DOC_TiltAngleHigh, DSS property index: 42

◆ DOC_TiltAngleLow()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_TiltAngleLow ( )

inline

Tilt angle for lower current magnitudes.

Default is 90.

DSS property name: DOC_TiltAngleLow, DSS property index: 41

◆ DOC_TripSettingHigh()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_TripSettingHigh ( )

inline

Trip setting for higher current magnitude.

Default is -1 (deactivated). To activate, set a positive value. Must be greater than "DOC_TripSettingLow".

DSS property name: DOC_TripSettingHigh, DSS property index: 44

◆ DOC_TripSettingLow()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_TripSettingLow ( )

inline

Trip setting for lower current magnitude.

Default is 0.

DSS property name: DOC_TripSettingLow, DSS property index: 43

◆ DOC_TripSettingMag()

BatchFloat64ArrayProxy dss::obj::RelayBatch::DOC_TripSettingMag ( )

inline

Trip setting for current magnitude (define a circle for the relay characteristics).

Default is -1 (deactivated). To activate, set a positive value.

DSS property name: DOC_TripSettingMag, DSS property index: 45

◆ enabled()

bools dss::obj::RelayBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 51

◆ EventLog()

bools dss::obj::RelayBatch::EventLog ( )

inline

{Yes/True* | No/False} Default is Yes for Relay.

Write trips, reclose and reset events to EventLog.

DSS property name: EventLog, DSS property index: 36

◆ Groundcurve()

strings dss::obj::RelayBatch::Groundcurve ( )

inline

Name of the TCC Curve object that determines the ground trip.

Must have been previously defined as a TCC_Curve object. Default is none (ignored).For overcurrent relay, multiplying the current values in the curve by the "groundtrip" valuw gives the actual current.

DSS property name: Groundcurve, DSS property index: 7

◆ Groundcurve_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RelayBatch::Groundcurve_obj ( )

inline

Name of the TCC Curve object that determines the ground trip.

Must have been previously defined as a TCC_Curve object. Default is none (ignored).For overcurrent relay, multiplying the current values in the curve by the "groundtrip" valuw gives the actual current.

DSS property name: Groundcurve, DSS property index: 7

◆ GroundInst()

BatchFloat64ArrayProxy dss::obj::RelayBatch::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::RelayBatch::GroundTrip ( )

inline

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

Defaults to 1.0.

DSS property name: GroundTrip, DSS property index: 9

◆ isqt46()

BatchFloat64ArrayProxy dss::obj::RelayBatch::isqt46 ( )

inline

Negative Sequence I-squared-t trip value for 46 relay (neg seq current).

Default is 1 (trips in 1 sec for 1 per unit neg seq current). Should be 1 to 99.

DSS property name: 46isqt, DSS property index: 24

◆ kvbase()

BatchFloat64ArrayProxy dss::obj::RelayBatch::kvbase ( )

inline

Voltage base (kV) for the relay.

Specify line-line for 3 phase devices); line-neutral for 1-phase devices. Relay assumes the number of phases of the monitored element. Default is 0.0, which results in assuming the voltage values in the "TCC" curve are specified in actual line-to-neutral volts.

DSS property name: kvbase, DSS property index: 20

◆ like() [1/2]

RelayBatch & dss::obj::RelayBatch::like ( const char * value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 52

◆ like() [2/2]

RelayBatch & dss::obj::RelayBatch::like ( const string & value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 52

◆ Mground()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Mground ( )

inline

Ground reach multiplier in per-unit for Distance and TD21 functions.

Default=0.7

DSS property name: Mground, DSS property index: 35

◆ MonitoredObj()

strings dss::obj::RelayBatch::MonitoredObj ( )

inline

Full object name of the circuit element, typically a line, transformer, load, or generator, to which the relay'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::RelayBatch::MonitoredObj_obj ( )

inline

Full object name of the circuit element, typically a line, transformer, load, or generator, to which the relay'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::RelayBatch::MonitoredTerm ( )

inline

Number of the terminal of the circuit element to which the Relay is connected.

1 or 2, typically. Default is 1.

DSS property name: MonitoredTerm, DSS property index: 2

◆ Mphase()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Mphase ( )

inline

Phase reach multiplier in per-unit for Distance and TD21 functions.

Default=0.7

DSS property name: Mphase, DSS property index: 34

◆ Normal()

BatchInt32ArrayProxy dss::obj::RelayBatch::Normal ( )

inline

{Open | Closed} Normal state of the relay.

The relay reverts to this state for reset, change of mode, etc. Defaults to "State" if not specifically declared.

DSS property name: Normal, DSS property index: 39

◆ Normal_str()

strings dss::obj::RelayBatch::Normal_str ( )

inline

{Open | Closed} Normal state of the relay.

The relay reverts to this state for reset, change of mode, etc. Defaults to "State" if not specifically declared.

DSS property name: Normal, DSS property index: 39

◆ overtrip()

BatchFloat64ArrayProxy dss::obj::RelayBatch::overtrip ( )

inline

Trip setting (high value) for Generic relay variable.

Relay trips in definite time if value of variable exceeds this value.

DSS property name: overtrip, DSS property index: 26

◆ Overvoltcurve()

strings dss::obj::RelayBatch::Overvoltcurve ( )

inline

TCC Curve object to use for overvoltage relay.

Curve is assumed to be defined with per unit voltage values. Voltage base should be defined for the relay. Default is none (ignored).

DSS property name: Overvoltcurve, DSS property index: 18

◆ Overvoltcurve_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RelayBatch::Overvoltcurve_obj ( )

inline

TCC Curve object to use for overvoltage relay.

Curve is assumed to be defined with per unit voltage values. Voltage base should be defined for the relay. Default is none (ignored).

DSS property name: Overvoltcurve, DSS property index: 18

◆ pctPickup46()

BatchFloat64ArrayProxy dss::obj::RelayBatch::pctPickup46 ( )

inline

Percent pickup current for 46 relay (neg seq current).

Default is 20.0. When current exceeds this value * BaseAmps, I-squared-t calc starts.

DSS property name: 46Pickup, DSS property index: 23

◆ pctPickup47()

BatchFloat64ArrayProxy dss::obj::RelayBatch::pctPickup47 ( )

inline

Percent voltage pickup for 47 relay (Neg seq voltage).

Default is 2. Specify also base voltage (kvbase) and delay time value.

DSS property name: 47Pickup, DSS property index: 21

◆ Phasecurve()

strings dss::obj::RelayBatch::Phasecurve ( )

inline

Name of the TCC Curve object that determines the phase trip.

Must have been previously defined as a TCC_Curve object. Default is none (ignored). For overcurrent relay, multiplying the current values in the curve by the "phasetrip" value gives the actual current.

DSS property name: Phasecurve, DSS property index: 6

◆ Phasecurve_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RelayBatch::Phasecurve_obj ( )

inline

Name of the TCC Curve object that determines the phase trip.

Must have been previously defined as a TCC_Curve object. Default is none (ignored). For overcurrent relay, multiplying the current values in the curve by the "phasetrip" value gives the actual current.

DSS property name: Phasecurve, DSS property index: 6

◆ PhaseInst()

BatchFloat64ArrayProxy dss::obj::RelayBatch::PhaseInst ( )

inline

Actual amps (Current relay) or kW (reverse power relay) for instantaneous phase trip which is assumed to happen in 0.01 sec + Delay Time.

Default is 0.0, which signifies no inst trip. Use this value for specifying the Reverse Power threshold (kW) for reverse power relays.

DSS property name: PhaseInst, DSS property index: 12

◆ PhaseTrip()

BatchFloat64ArrayProxy dss::obj::RelayBatch::PhaseTrip ( )

inline

Multiplier or actual phase amps for the phase TCC curve.

Defaults to 1.0.

DSS property name: PhaseTrip, DSS property index: 8

◆ RecloseIntervals()

std::vector< VectorXd > dss::obj::RelayBatch::RecloseIntervals ( )

inline

Array of reclose intervals.

If none, specify "NONE". Default for overcurrent relay is (0.5, 2.0, 2.0) seconds. Default for a voltage relay is (5.0). In a voltage relay, this is seconds after restoration of voltage that the reclose occurs. Reverse power relay is one shot to lockout, so this is ignored. A locked out relay must be closed manually (set action=close).

DSS property name: RecloseIntervals, DSS property index: 16

◆ Reset()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Reset ( )

inline

Reset time in sec for relay.

Default is 15. If this much time passes between the last pickup event, and the relay has not locked out, the operation counter resets.

DSS property name: Reset, DSS property index: 14

◆ Shots()

BatchInt32ArrayProxy dss::obj::RelayBatch::Shots ( )

inline

Number of 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::RelayBatch::State ( )

inline

{Open | Closed} Actual state of the relay.

Upon setting, immediately forces state of the relay, overriding the Relay control. Simulates manual control on relay. Defaults to Closed. "Open" causes the controlled element to open and lock out. "Closed" causes the controlled element to close and the relay to reset to its first operation.

DSS property name: State, DSS property index: 40

◆ State_str()

strings dss::obj::RelayBatch::State_str ( )

inline

{Open | Closed} Actual state of the relay.

Upon setting, immediately forces state of the relay, overriding the Relay control. Simulates manual control on relay. Defaults to Closed. "Open" causes the controlled element to open and lock out. "Closed" causes the controlled element to close and the relay to reset to its first operation.

DSS property name: State, DSS property index: 40

◆ SwitchedObj()

strings dss::obj::RelayBatch::SwitchedObj ( )

inline

Name of circuit element switch that the Relay 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::RelayBatch::SwitchedObj_obj ( )

inline

Name of circuit element switch that the Relay 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::RelayBatch::SwitchedTerm ( )

inline

Number of the terminal of the controlled element in which the switch is controlled by the Relay.

1 or 2, typically. Default is 1.

DSS property name: SwitchedTerm, DSS property index: 4

◆ TDGround()

BatchFloat64ArrayProxy dss::obj::RelayBatch::TDGround ( )

inline

Time dial for Ground trip curve.

Multiplier on time axis of specified curve. Default=1.0.

DSS property name: TDGround, DSS property index: 11

◆ TDPhase()

BatchFloat64ArrayProxy dss::obj::RelayBatch::TDPhase ( )

inline

Time dial for Phase trip curve.

Multiplier on time axis of specified curve. Default=1.0.

DSS property name: TDPhase, DSS property index: 10

◆ type()

BatchInt32ArrayProxy dss::obj::RelayBatch::type ( )

inline

One of a legal relay type: Current Voltage Reversepower 46 (neg seq current) 47 (neg seq voltage) Generic (generic over/under relay) Distance TD21 DOC (directional overcurrent)

Default is overcurrent relay (Current) Specify the curve and pickup settings appropriate for each type. Generic relays monitor PC Element Control variables and trip on out of over/under range in definite time.

DSS property name: type, DSS property index: 5

◆ type_str()

strings dss::obj::RelayBatch::type_str ( )

inline

One of a legal relay type: Current Voltage Reversepower 46 (neg seq current) 47 (neg seq voltage) Generic (generic over/under relay) Distance TD21 DOC (directional overcurrent)

Default is overcurrent relay (Current) Specify the curve and pickup settings appropriate for each type. Generic relays monitor PC Element Control variables and trip on out of over/under range in definite time.

DSS property name: type, DSS property index: 5

◆ undertrip()

BatchFloat64ArrayProxy dss::obj::RelayBatch::undertrip ( )

inline

Trip setting (low value) for Generic relay variable.

Relay trips in definite time if value of variable is less than this value.

DSS property name: undertrip, DSS property index: 27

◆ Undervoltcurve()

strings dss::obj::RelayBatch::Undervoltcurve ( )

inline

TCC Curve object to use for undervoltage relay.

Curve is assumed to be defined with per unit voltage values. Voltage base should be defined for the relay. Default is none (ignored).

DSS property name: Undervoltcurve, DSS property index: 19

◆ Undervoltcurve_obj()

std::vector< dss::obj::TCC_Curve > dss::obj::RelayBatch::Undervoltcurve_obj ( )

inline

TCC Curve object to use for undervoltage relay.

Curve is assumed to be defined with per unit voltage values. Voltage base should be defined for the relay. Default is none (ignored).

DSS property name: Undervoltcurve, DSS property index: 19

◆ Variable()

strings dss::obj::RelayBatch::Variable ( )

inline

Name of variable in PC Elements being monitored.

Only applies to Generic relay.

DSS property name: Variable, DSS property index: 25

◆ Z0ang()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Z0ang ( )

inline

Zero sequence reach impedance angle in degrees for Distance and TD21 functions.

Default=68.0

DSS property name: Z0ang, DSS property index: 33

◆ Z0mag()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Z0mag ( )

inline

Zero sequence reach impedance in primary ohms for Distance and TD21 functions.

Default=2.1

DSS property name: Z0mag, DSS property index: 32

◆ Z1ang()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Z1ang ( )

inline

Positive sequence reach impedance angle in degrees for Distance and TD21 functions.

Default=64.0

DSS property name: Z1ang, DSS property index: 31

◆ Z1mag()

BatchFloat64ArrayProxy dss::obj::RelayBatch::Z1mag ( )

inline

Positive sequence reach impedance in primary ohms for Distance and TD21 functions.

Default=0.7

DSS property name: Z1mag, DSS property index: 30

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

include/dss_obj.hpp

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ action()

◆ action_str()

◆ BaseAmps46()

◆ basefreq()

◆ Breakertime()

◆ DebugTrace()

◆ Delay()

◆ DistReverse()

◆ DOC_DelayInner()

◆ DOC_PhaseCurveInner()

◆ DOC_PhaseTripInner()

◆ DOC_TDPhaseInner()

◆ DOC_TDPhaseInner_obj()

◆ DOC_TiltAngleHigh()

◆ DOC_TiltAngleLow()

◆ DOC_TripSettingHigh()

◆ DOC_TripSettingLow()

◆ DOC_TripSettingMag()

◆ enabled()

◆ EventLog()

◆ Groundcurve()

◆ Groundcurve_obj()

◆ GroundInst()

◆ GroundTrip()

◆ isqt46()

◆ kvbase()

◆ like() [1/2]

◆ like() [2/2]

◆ Mground()

◆ MonitoredObj()

◆ MonitoredObj_obj()

◆ MonitoredTerm()

◆ Mphase()

◆ Normal()

◆ Normal_str()

◆ overtrip()

◆ Overvoltcurve()

◆ Overvoltcurve_obj()

◆ pctPickup46()

◆ pctPickup47()

◆ Phasecurve()

◆ Phasecurve_obj()

◆ PhaseInst()

◆ PhaseTrip()

◆ RecloseIntervals()

◆ Reset()

◆ Shots()

◆ State()

◆ State_str()

◆ SwitchedObj()

◆ SwitchedObj_obj()

◆ SwitchedTerm()

◆ TDGround()

◆ TDPhase()

◆ type()

◆ type_str()

◆ undertrip()

◆ Undervoltcurve()

◆ Undervoltcurve_obj()

◆ Variable()

◆ Z0ang()

◆ Z0mag()

◆ Z1ang()

◆ Z1mag()