Inheritance diagram for dss::obj::VSConverterBatch:

Collaboration diagram for dss::obj::VSConverterBatch:

Public Types
typedef VSConverter::Properties	Properties

typedef VSConverter	BatchElementClass

typedef VSConverter::VSConverterControlMode	VSConverterControlMode

Public Member Functions
	VSConverterBatch (APIUtil *util)
	Create a batch of all VSConverter elements.

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

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

VSConverterBatch &	begin_edit ()

VSConverterBatch &	end_edit (int32_t num_edits=1)

BatchInt32ArrayProxy	phases ()
	Number of AC plus DC conductors. More...

VSConverterBatch &	phases (int32_t value)

template<typename T >
VSConverterBatch &	phases (T &value)

template<typename T >
VSConverterBatch &	phases (typename T::iterator it_begin, typename T::iterator it_end)

strings	Bus1 ()
	Name of converter bus, containing both AC and DC conductors. More...

VSConverterBatch &	Bus1 (const string &value)

VSConverterBatch &	Bus1 (strings &value)

BatchFloat64ArrayProxy	kVac ()
	Nominal AC line-neutral voltage in kV. More...

VSConverterBatch &	kVac (double value)

template<typename T >
VSConverterBatch &	kVac (T &value)

template<typename T >
VSConverterBatch &	kVac (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kVdc ()
	Nominal DC voltage in kV. More...

VSConverterBatch &	kVdc (double value)

template<typename T >
VSConverterBatch &	kVdc (T &value)

template<typename T >
VSConverterBatch &	kVdc (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kW ()
	Nominal converter power in kW. More...

VSConverterBatch &	kW (double value)

template<typename T >
VSConverterBatch &	kW (T &value)

template<typename T >
VSConverterBatch &	kW (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Ndc ()
	Number of DC conductors. More...

VSConverterBatch &	Ndc (int32_t value)

template<typename T >
VSConverterBatch &	Ndc (T &value)

template<typename T >
VSConverterBatch &	Ndc (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Rac ()
	AC resistance (ohms) for the converter transformer, plus any series reactors. More...

VSConverterBatch &	Rac (double value)

template<typename T >
VSConverterBatch &	Rac (T &value)

template<typename T >
VSConverterBatch &	Rac (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xac ()
	AC reactance (ohms) for the converter transformer, plus any series reactors. More...

VSConverterBatch &	Xac (double value)

template<typename T >
VSConverterBatch &	Xac (T &value)

template<typename T >
VSConverterBatch &	Xac (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	m0 ()
	Fixed or initial value of the modulation index. More...

VSConverterBatch &	m0 (double value)

template<typename T >
VSConverterBatch &	m0 (T &value)

template<typename T >
VSConverterBatch &	m0 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	d0 ()
	Fixed or initial value of the power angle in degrees. More...

VSConverterBatch &	d0 (double value)

template<typename T >
VSConverterBatch &	d0 (T &value)

template<typename T >
VSConverterBatch &	d0 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Mmin ()
	Minimum value of modulation index. More...

VSConverterBatch &	Mmin (double value)

template<typename T >
VSConverterBatch &	Mmin (T &value)

template<typename T >
VSConverterBatch &	Mmin (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Mmax ()
	Maximum value of modulation index. More...

VSConverterBatch &	Mmax (double value)

template<typename T >
VSConverterBatch &	Mmax (T &value)

template<typename T >
VSConverterBatch &	Mmax (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Iacmax ()
	Maximum value of AC line current, per-unit of nominal. More...

VSConverterBatch &	Iacmax (double value)

template<typename T >
VSConverterBatch &	Iacmax (T &value)

template<typename T >
VSConverterBatch &	Iacmax (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Idcmax ()
	Maximum value of DC current, per-unit of nominal. More...

VSConverterBatch &	Idcmax (double value)

template<typename T >
VSConverterBatch &	Idcmax (T &value)

template<typename T >
VSConverterBatch &	Idcmax (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Vacref ()
	Reference AC line-to-neutral voltage, RMS Volts. More...

VSConverterBatch &	Vacref (double value)

template<typename T >
VSConverterBatch &	Vacref (T &value)

template<typename T >
VSConverterBatch &	Vacref (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Pacref ()
	Reference total AC real power, Watts. More...

VSConverterBatch &	Pacref (double value)

template<typename T >
VSConverterBatch &	Pacref (T &value)

template<typename T >
VSConverterBatch &	Pacref (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Qacref ()
	Reference total AC reactive power, Vars. More...

VSConverterBatch &	Qacref (double value)

template<typename T >
VSConverterBatch &	Qacref (T &value)

template<typename T >
VSConverterBatch &	Qacref (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Vdcref ()
	Reference DC voltage, Volts. More...

VSConverterBatch &	Vdcref (double value)

template<typename T >
VSConverterBatch &	Vdcref (T &value)

template<typename T >
VSConverterBatch &	Vdcref (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	VscMode ()
	Control Mode (Fixed\|PacVac\|PacQac\|VdcVac\|VdcQac). More...

VSConverterBatch &	VscMode (string &value)

VSConverterBatch &	VscMode (int32_t value)

VSConverterBatch &	VscMode (VSConverter::VSConverterControlMode value)

VSConverterBatch &	VscMode (strings &value)

VSConverterBatch &	VscMode (std::vector< int32_t > &value)

VSConverterBatch &	VscMode (std::vector< VSConverter::VSConverterControlMode > &value)

strings	VscMode_str ()
	Control Mode (Fixed\|PacVac\|PacQac\|VdcVac\|VdcQac). More...

VSConverterBatch &	VscMode_str (string &value)

VSConverterBatch &	VscMode_str (strings &value)

strings	spectrum ()
	Name of harmonic spectrum for this device. More...

VSConverterBatch &	spectrum (dss::obj::Spectrum &value)

VSConverterBatch &	spectrum (const string &value)

std::vector< dss::obj::Spectrum >	spectrum_obj ()
	Name of harmonic spectrum for this device. More...

VSConverterBatch &	spectrum_obj (dss::obj::Spectrum &value)

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

VSConverterBatch &	basefreq (double value)

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

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

VSConverterBatch &	enabled (bool value)

VSConverterBatch &	enabled (bools &value)

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

VSConverterBatch &	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

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 21

◆ Bus1()

strings dss::obj::VSConverterBatch::Bus1 ( )

inline

Name of converter bus, containing both AC and DC conductors.

Bus2 is always ground.

DSS property name: Bus1, DSS property index: 2

◆ d0()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::d0 ( )

inline

Fixed or initial value of the power angle in degrees.

Default is 0.

DSS property name: d0, DSS property index: 10

◆ enabled()

bools dss::obj::VSConverterBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 22

◆ Iacmax()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Iacmax ( )

inline

Maximum value of AC line current, per-unit of nominal.

Default is 2.

DSS property name: Iacmax, DSS property index: 13

◆ Idcmax()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Idcmax ( )

inline

Maximum value of DC current, per-unit of nominal.

Default is 2.

DSS property name: Idcmax, DSS property index: 14

◆ kVac()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::kVac ( )

inline

Nominal AC line-neutral voltage in kV.

Must be specified > 0.

DSS property name: kVac, DSS property index: 3

◆ kVdc()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::kVdc ( )

inline

Nominal DC voltage in kV.

Must be specified > 0.

DSS property name: kVdc, DSS property index: 4

◆ kW()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::kW ( )

inline

Nominal converter power in kW.

Must be specified > 0.

DSS property name: kW, DSS property index: 5

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 23

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 23

◆ m0()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::m0 ( )

inline

Fixed or initial value of the modulation index.

Default is 0.5.

DSS property name: m0, DSS property index: 9

◆ Mmax()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Mmax ( )

inline

Maximum value of modulation index.

Default is 0.9.

DSS property name: Mmax, DSS property index: 12

◆ Mmin()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Mmin ( )

inline

Minimum value of modulation index.

Default is 0.1.

DSS property name: Mmin, DSS property index: 11

◆ Ndc()

BatchInt32ArrayProxy dss::obj::VSConverterBatch::Ndc ( )

inline

Number of DC conductors.

Default is 1. DC conductors numbered after AC phases.

DSS property name: Ndc, DSS property index: 6

◆ Pacref()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Pacref ( )

inline

Reference total AC real power, Watts.

Default is 0. Applies to PacVac and PacQac control modes, influencing d.

DSS property name: Pacref, DSS property index: 16

◆ phases()

BatchInt32ArrayProxy dss::obj::VSConverterBatch::phases ( )

inline

Number of AC plus DC conductors.

Default is 4. AC phases numbered before DC conductors.

DSS property name: phases, DSS property index: 1

◆ Qacref()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Qacref ( )

inline

Reference total AC reactive power, Vars.

Default is 0. Applies to PacQac and VdcQac control modes, influencing m.

DSS property name: Qacref, DSS property index: 17

◆ Rac()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Rac ( )

inline

AC resistance (ohms) for the converter transformer, plus any series reactors.

Default is 0. Must be 0 for Vac control mode.

DSS property name: Rac, DSS property index: 7

◆ spectrum()

strings dss::obj::VSConverterBatch::spectrum ( )

inline

Name of harmonic spectrum for this device.

DSS property name: spectrum, DSS property index: 20

◆ spectrum_obj()

std::vector< dss::obj::Spectrum > dss::obj::VSConverterBatch::spectrum_obj ( )

inline

Name of harmonic spectrum for this device.

DSS property name: spectrum, DSS property index: 20

◆ Vacref()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Vacref ( )

inline

Reference AC line-to-neutral voltage, RMS Volts.

Default is 0. Applies to PacVac and VdcVac control modes, influencing m.

DSS property name: Vacref, DSS property index: 15

◆ Vdcref()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Vdcref ( )

inline

Reference DC voltage, Volts.

Default is 0. Applies to VdcVac control mode, influencing d.

DSS property name: Vdcref, DSS property index: 18

◆ VscMode()

BatchInt32ArrayProxy dss::obj::VSConverterBatch::VscMode ( )

inline

Control Mode (Fixed|PacVac|PacQac|VdcVac|VdcQac).

Default is Fixed.

DSS property name: VscMode, DSS property index: 19

◆ VscMode_str()

strings dss::obj::VSConverterBatch::VscMode_str ( )

inline

Control Mode (Fixed|PacVac|PacQac|VdcVac|VdcQac).

Default is Fixed.

DSS property name: VscMode, DSS property index: 19

◆ Xac()

BatchFloat64ArrayProxy dss::obj::VSConverterBatch::Xac ( )

inline

AC reactance (ohms) for the converter transformer, plus any series reactors.

Default is 0. Must be 0 for Vac control mode. Must be >0 for PacVac, PacQac or VacVdc control mode.

DSS property name: Xac, DSS property index: 8

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

◆ basefreq()

◆ Bus1()

◆ d0()

◆ enabled()

◆ Iacmax()

◆ Idcmax()

◆ kVac()

◆ kVdc()

◆ kW()

◆ like() [1/2]

◆ like() [2/2]

◆ m0()

◆ Mmax()

◆ Mmin()

◆ Ndc()

◆ Pacref()

◆ phases()

◆ Qacref()

◆ Rac()

◆ spectrum()

◆ spectrum_obj()

◆ Vacref()

◆ Vdcref()

◆ VscMode()

◆ VscMode_str()

◆ Xac()