Inheritance diagram for dss::obj::Relay:

Collaboration diagram for dss::obj::Relay:

Classes
struct	Properties

Public Types
enum class	RelayType : int32_t { Current = 0 , Voltage = 1 , ReversePower = 3 , relay46 = 4 , relay47 = 5 , Generic = 6 , Distance = 7 , TD21 = 8 , DOC = 9 }
	Relay: Type (DSS enumeration for Relay) More...

enum class	RelayAction : int32_t { close = 2 , open = 1 , trip = 1 }
	Relay: Action (DSS enumeration for Relay) More...

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

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

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

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

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

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

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

Relay &	MonitoredObj (const string &value)

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

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

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

Relay &	MonitoredTerm (int32_t value)

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

Relay &	SwitchedObj (const string &value)

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

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

Relay &	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 Relay. More...

Relay &	SwitchedTerm (int32_t value)

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

Relay &	type (int32_t value)

Relay &	type (RelayType value)

Relay &	type (const string &value)

Relay &	type (const char *value)

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

Relay &	type_str (const string &value)
	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...

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

Relay &	Phasecurve (const string &value)

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

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

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

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

Relay &	Groundcurve (const string &value)

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

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

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

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

Relay &	PhaseTrip (double value)

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

Relay &	GroundTrip (double value)

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

Relay &	TDPhase (double value)

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

Relay &	TDGround (double value)

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

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

Relay &	GroundInst (double value)

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

Relay &	Reset (double value)

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

Relay &	Shots (int32_t value)

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

Relay &	RecloseIntervals (VectorXd &value)

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

Relay &	Delay (double value)

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

Relay &	Overvoltcurve (const string &value)

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

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

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

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

Relay &	Undervoltcurve (const string &value)

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

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

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

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

Relay &	kvbase (double value)

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

Relay &	pctPickup47 (double value)

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

Relay &	BaseAmps46 (double value)

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

Relay &	pctPickup46 (double value)

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

Relay &	isqt46 (double value)

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

Relay &	Variable (const string &value)

Relay &	Variable (const char *value)

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

Relay &	overtrip (double value)

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

Relay &	undertrip (double value)

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

Relay &	Breakertime (double value)

RelayAction	action ()
	DEPRECATED. More...

Relay &	action (int32_t value)

Relay &	action (RelayAction value)

Relay &	action (const string &value)

Relay &	action (const char *value)

string	action_str ()
	DEPRECATED. More...

Relay &	action_str (const string &value)
	DEPRECATED. More...

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

Relay &	Z1mag (double value)

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

Relay &	Z1ang (double value)

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

Relay &	Z0mag (double value)

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

Relay &	Z0ang (double value)

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

Relay &	Mphase (double value)

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

Relay &	Mground (double value)

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

Relay &	EventLog (bool value)

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

Relay &	DebugTrace (bool value)

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

Relay &	DistReverse (bool value)

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

Relay &	Normal (int32_t value)

Relay &	Normal (RelayState value)

Relay &	Normal (const string &value)

Relay &	Normal (const char *value)

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

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

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

Relay &	State (int32_t value)

Relay &	State (RelayState value)

Relay &	State (const string &value)

Relay &	State (const char *value)

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

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

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

Relay &	DOC_TiltAngleLow (double value)

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

Relay &	DOC_TiltAngleHigh (double value)

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

Relay &	DOC_TripSettingLow (double value)

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

Relay &	DOC_TripSettingHigh (double value)

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

Relay &	DOC_TripSettingMag (double value)

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

Relay &	DOC_DelayInner (double value)

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

Relay &	DOC_PhaseCurveInner (double value)

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

Relay &	DOC_PhaseTripInner (double value)

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

Relay &	DOC_TDPhaseInner (const string &value)

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

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

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

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

Relay &	basefreq (double value)

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

Relay &	enabled (bool value)

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

Relay &	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 [] = "Relay"

static const int32_t	dss_cls_idx = 30

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

◆ RelayAction

enum class dss::obj::Relay::RelayAction : int32_t

strong

Relay: Action (DSS enumeration for Relay)

Enumerator
close	close
open	open
trip	trip

◆ RelayState

enum class dss::obj::Relay::RelayState : int32_t

strong

Relay: State (DSS enumeration for Relay)

Enumerator
closed	closed
open	open
trip	trip

◆ RelayType

enum class dss::obj::Relay::RelayType : int32_t

strong

Relay: Type (DSS enumeration for Relay)

Enumerator
Current	Current.
Voltage	Voltage.
ReversePower	ReversePower.
relay46	46
relay47	47
Generic	Generic.
Distance	Distance.
TD21	TD21.
DOC	DOC.

Member Function Documentation

◆ action()

RelayAction dss::obj::Relay::action ( )

inline

DEPRECATED.

See "State" property

DSS property name: action, DSS property index: 29

◆ action_str() [1/2]

string dss::obj::Relay::action_str ( )

inline

DEPRECATED.

See "State" property

DSS property name: action, DSS property index: 29

◆ action_str() [2/2]

Relay & dss::obj::Relay::action_str ( const string & value )

inline

DEPRECATED.

See "State" property

DSS property name: action, DSS property index: 29

◆ BaseAmps46()

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

double dss::obj::Relay::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 50

◆ begin_edit()

Relay & dss::obj::Relay::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ Breakertime()

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

bool dss::obj::Relay::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()

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

bool dss::obj::Relay::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()

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

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

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

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

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

double dss::obj::Relay::DOC_TiltAngleHigh ( )

inline

Tilt angle for higher current magnitudes.

Default is 90.

DSS property name: DOC_TiltAngleHigh, DSS property index: 42

◆ DOC_TiltAngleLow()

double dss::obj::Relay::DOC_TiltAngleLow ( )

inline

Tilt angle for lower current magnitudes.

Default is 90.

DSS property name: DOC_TiltAngleLow, DSS property index: 41

◆ DOC_TripSettingHigh()

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

double dss::obj::Relay::DOC_TripSettingLow ( )

inline

Trip setting for lower current magnitude.

Default is 0.

DSS property name: DOC_TripSettingLow, DSS property index: 43

◆ DOC_TripSettingMag()

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

bool dss::obj::Relay::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 51

◆ end_edit()

Relay & dss::obj::Relay::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.

◆ EventLog()

bool dss::obj::Relay::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()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

◆ Normal_str() [2/2]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

◆ State_str() [2/2]

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

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

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

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

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

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

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

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

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

◆ type_str() [2/2]

Relay & dss::obj::Relay::type_str ( const string & value )

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

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

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

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

string dss::obj::Relay::Variable ( )

inline

Name of variable in PC Elements being monitored.

Only applies to Generic relay.

DSS property name: Variable, DSS property index: 25

◆ Z0ang()

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

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

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

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ RelayAction

◆ RelayState

◆ RelayType

Member Function Documentation

◆ action()

◆ action_str() [1/2]

◆ action_str() [2/2]

◆ BaseAmps46()

◆ basefreq()

◆ begin_edit()

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

◆ end_edit()

◆ EventLog()

◆ Groundcurve()

◆ Groundcurve_obj()

◆ GroundInst()

◆ GroundTrip()

◆ isqt46()

◆ kvbase()

◆ like() [1/2]

◆ like() [2/2]

◆ Mground()

◆ MonitoredObj()

◆ MonitoredObj_obj()

◆ MonitoredTerm()

◆ Mphase()

◆ Normal()

◆ Normal_str() [1/2]

◆ Normal_str() [2/2]

◆ overtrip()

◆ Overvoltcurve()

◆ Overvoltcurve_obj()

◆ pctPickup46()

◆ pctPickup47()

◆ Phasecurve()

◆ Phasecurve_obj()

◆ PhaseInst()

◆ PhaseTrip()

◆ RecloseIntervals()

◆ Reset()

◆ Shots()

◆ State()

◆ State_str() [1/2]

◆ State_str() [2/2]

◆ SwitchedObj()

◆ SwitchedObj_obj()

◆ SwitchedTerm()

◆ TDGround()

◆ TDPhase()

◆ type()

◆ type_str() [1/2]

◆ type_str() [2/2]

◆ undertrip()

◆ Undervoltcurve()

◆ Undervoltcurve_obj()

◆ Variable()

◆ Z0ang()

◆ Z0mag()

◆ Z1ang()

◆ Z1mag()