Inheritance diagram for dss::obj::FuseBatch:

Collaboration diagram for dss::obj::FuseBatch:

Public Types
typedef Fuse::Properties	Properties

typedef Fuse	BatchElementClass

typedef Fuse::FuseAction	FuseAction

typedef Fuse::FuseState	FuseState

Public Member Functions
	FuseBatch (APIUtil *util)
	Create a batch of all Fuse elements.

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

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

FuseBatch &	begin_edit ()

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

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

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

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

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

FuseBatch &	MonitoredTerm (int32_t value)

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

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

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

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

FuseBatch &	SwitchedObj (const string &value)

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

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

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

FuseBatch &	SwitchedTerm (int32_t value)

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

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

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

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

FuseBatch &	FuseCurve (const string &value)

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

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

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

FuseBatch &	RatedCurrent (double value)

template<typename T >
FuseBatch &	RatedCurrent (T &value)

template<typename T >
FuseBatch &	RatedCurrent (typename T::iterator it_begin, typename T::iterator it_end)

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

FuseBatch &	Delay (double value)

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

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

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

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

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

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

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

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

FuseBatch &	Normal (std::vector< Fuse::FuseState > &value)

FuseBatch &	Normal (strings &value)

FuseBatch &	Normal (std::vector< strings > &value)

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

FuseBatch &	Normal_str (strings &value)

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

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

FuseBatch &	State (std::vector< Fuse::FuseState > &value)

FuseBatch &	State (strings &value)

FuseBatch &	State (std::vector< strings > &value)

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

FuseBatch &	State_str (strings &value)

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

FuseBatch &	basefreq (double value)

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

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

FuseBatch &	enabled (bool value)

FuseBatch &	enabled (bools &value)

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

FuseBatch &	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() [1/4]

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

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ Action() [2/4]

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

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ Action() [3/4]

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

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ Action() [4/4]

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

inline

DEPRECATED.

See "State" property.

DSS property name: Action, DSS property index: 8

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::FuseBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 11

◆ Delay()

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

bools dss::obj::FuseBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 12

◆ FuseCurve()

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

std::vector< dss::obj::TCC_Curve > dss::obj::FuseBatch::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]

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

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

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

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

BatchInt32ArrayProxy dss::obj::FuseBatch::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< VectorXi > dss::obj::FuseBatch::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()

std::vector< strings > dss::obj::FuseBatch::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()

BatchFloat64ArrayProxy dss::obj::FuseBatch::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< VectorXi > dss::obj::FuseBatch::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()

std::vector< strings > dss::obj::FuseBatch::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()

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

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

BatchInt32ArrayProxy dss::obj::FuseBatch::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

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Action() [1/4]

◆ Action() [2/4]

◆ Action() [3/4]

◆ Action() [4/4]

◆ basefreq()

◆ Delay()

◆ enabled()

◆ FuseCurve()

◆ FuseCurve_obj()

◆ like() [1/2]

◆ like() [2/2]

◆ MonitoredObj()

◆ MonitoredObj_obj()

◆ MonitoredTerm()

◆ Normal()

◆ Normal_str()

◆ RatedCurrent()

◆ State()

◆ State_str()

◆ SwitchedObj()

◆ SwitchedObj_obj()

◆ SwitchedTerm()