Inheritance diagram for dss::obj::Fuse:

Collaboration diagram for dss::obj::Fuse:

Classes
struct	Properties

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

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

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

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

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

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

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

Fuse &	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 Fuse is connected. More...

Fuse &	MonitoredObj (const string &value)

Fuse &	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 Fuse is connected. More...

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

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

Fuse &	MonitoredTerm (int32_t value)

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

Fuse &	SwitchedObj (const string &value)

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

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

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

Fuse &	SwitchedTerm (int32_t value)

string	FuseCurve ()
	Name of the TCC Curve object that determines the fuse blowing. More...

Fuse &	FuseCurve (const string &value)

Fuse &	FuseCurve (dss::obj::TCC_Curve &value)

dss::obj::TCC_Curve	FuseCurve_obj ()
	Name of the TCC Curve object that determines the fuse blowing. More...

Fuse &	FuseCurve_obj (dss::obj::TCC_Curve &value)

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

Fuse &	RatedCurrent (double value)

double	Delay ()
	Fixed delay time (sec) added to Fuse blowing time determined from the TCC curve. More...

Fuse &	Delay (double value)

Fuse &	Action (int32_t value)
	DEPRECATED. More...

Fuse &	Action (FuseAction value)
	DEPRECATED. More...

Fuse &	Action (const string &value)
	DEPRECATED. More...

Fuse &	Action (const char *value)
	DEPRECATED. More...

std::vector< FuseState >	Normal ()
	ARRAY of strings {Open \| Closed} representing the Normal state of the fuse in each phase of the controlled element. More...

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

Fuse &	Normal (strings &value)

strings	Normal_str ()
	ARRAY of strings {Open \| Closed} representing the Normal state of the fuse in each phase of the controlled element. More...

Fuse &	Normal_str (strings &value)

std::vector< FuseState >	State ()
	ARRAY of strings {Open \| Closed} representing the Actual state of the fuse in each phase of the controlled element. More...

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

Fuse &	State (strings &value)

strings	State_str ()
	ARRAY of strings {Open \| Closed} representing the Actual state of the fuse in each phase of the controlled element. More...

Fuse &	State_str (strings &value)

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

Fuse &	basefreq (double value)

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

Fuse &	enabled (bool value)

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

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

static const int32_t	dss_cls_idx = 32

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

◆ FuseAction

enum class dss::obj::Fuse::FuseAction : int32_t

strong

Fuse: Action (DSS enumeration for Fuse)

Enumerator
close	close
open	open

◆ FuseState

enum class dss::obj::Fuse::FuseState : int32_t

strong

Fuse: State (DSS enumeration for Fuse)

Enumerator
closed	closed
open	open

Member Function Documentation

◆ Action() [1/4]

Fuse & dss::obj::Fuse::Action ( const char * value )

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ Action() [2/4]

Fuse & dss::obj::Fuse::Action ( const string & value )

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ Action() [3/4]

Fuse & dss::obj::Fuse::Action ( FuseAction value )

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ Action() [4/4]

Fuse & dss::obj::Fuse::Action ( int32_t value )

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ basefreq()

double dss::obj::Fuse::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 11

◆ begin_edit()

Fuse & dss::obj::Fuse::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ Delay()

double dss::obj::Fuse::Delay ( )

inline

Fixed delay time (sec) added to Fuse blowing time determined from the TCC curve.

Default is 0.0. Used to represent fuse clearing time or any other delay.

DSS property name: Delay, DSS property index: 7

◆ enabled()

bool dss::obj::Fuse::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 12

◆ end_edit()

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

◆ FuseCurve()

string dss::obj::Fuse::FuseCurve ( )

inline

Name of the TCC Curve object that determines the fuse blowing.

Must have been previously defined as a TCC_Curve object. Default is "Tlink". Multiplying the current values in the curve by the "RatedCurrent" value gives the actual current.

DSS property name: FuseCurve, DSS property index: 5

◆ FuseCurve_obj()

dss::obj::TCC_Curve dss::obj::Fuse::FuseCurve_obj ( )

inline

Name of the TCC Curve object that determines the fuse blowing.

Must have been previously defined as a TCC_Curve object. Default is "Tlink". Multiplying the current values in the curve by the "RatedCurrent" value gives the actual current.

DSS property name: FuseCurve, DSS property index: 5

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 13

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 13

◆ MonitoredObj()

string dss::obj::Fuse::MonitoredObj ( )

inline

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

inline

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

inline

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

1 or 2, typically. Default is 1.

DSS property name: MonitoredTerm, DSS property index: 2

◆ Normal()

std::vector< FuseState > dss::obj::Fuse::Normal ( )

inline

ARRAY of strings {Open | Closed} representing the Normal state of the fuse in each phase of the controlled element.

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

DSS property name: Normal, DSS property index: 9

◆ Normal_str()

strings dss::obj::Fuse::Normal_str ( )

inline

ARRAY of strings {Open | Closed} representing the Normal state of the fuse in each phase of the controlled element.

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

DSS property name: Normal, DSS property index: 9

◆ RatedCurrent()

double dss::obj::Fuse::RatedCurrent ( )

inline

Multiplier or actual phase amps for the phase TCC curve.

Defaults to 1.0.

DSS property name: RatedCurrent, DSS property index: 6

◆ State()

std::vector< FuseState > dss::obj::Fuse::State ( )

inline

ARRAY of strings {Open | Closed} representing the Actual state of the fuse in each phase of the controlled element.

Upon setting, immediately forces state of fuse(s). Simulates manual control on Fuse. Defaults to Closed for all phases.

DSS property name: State, DSS property index: 10

◆ State_str()

strings dss::obj::Fuse::State_str ( )

inline

ARRAY of strings {Open | Closed} representing the Actual state of the fuse in each phase of the controlled element.

Upon setting, immediately forces state of fuse(s). Simulates manual control on Fuse. Defaults to Closed for all phases.

DSS property name: State, DSS property index: 10

◆ SwitchedObj()

string dss::obj::Fuse::SwitchedObj ( )

inline

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

inline

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

inline

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

1 or 2, typically. Default is 1. Assumes all phases of the element have a fuse of this type.

DSS property name: SwitchedTerm, DSS property index: 4

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

◆ FuseAction

◆ FuseState

Member Function Documentation

◆ Action() [1/4]

◆ Action() [2/4]

◆ Action() [3/4]

◆ Action() [4/4]

◆ basefreq()

◆ begin_edit()

◆ Delay()

◆ enabled()

◆ end_edit()

◆ FuseCurve()

◆ FuseCurve_obj()

◆ like() [1/2]

◆ like() [2/2]

◆ MonitoredObj()

◆ MonitoredObj_obj()

◆ MonitoredTerm()

◆ Normal()

◆ Normal_str()

◆ RatedCurrent()

◆ State()

◆ State_str()

◆ SwitchedObj()

◆ SwitchedObj_obj()

◆ SwitchedTerm()