Inheritance diagram for dss::obj::VSConverter:

Collaboration diagram for dss::obj::VSConverter:

Classes
struct	Properties

Public Types
enum class	VSConverterControlMode : int32_t { Fixed = 0 , PacVac = 1 , PacQac = 2 , VdcVac = 3 , VdcQac = 4 }
	VSConverter: Control Mode (DSS enumeration for VSConverter) More...

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

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

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

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

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

VSConverter &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...

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

VSConverter &	phases (int32_t value)

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

VSConverter &	Bus1 (const string &value)

VSConverter &	Bus1 (const char *value)

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

VSConverter &	kVac (double value)

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

VSConverter &	kVdc (double value)

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

VSConverter &	kW (double value)

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

VSConverter &	Ndc (int32_t value)

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

VSConverter &	Rac (double value)

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

VSConverter &	Xac (double value)

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

VSConverter &	m0 (double value)

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

VSConverter &	d0 (double value)

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

VSConverter &	Mmin (double value)

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

VSConverter &	Mmax (double value)

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

VSConverter &	Iacmax (double value)

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

VSConverter &	Idcmax (double value)

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

VSConverter &	Vacref (double value)

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

VSConverter &	Pacref (double value)

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

VSConverter &	Qacref (double value)

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

VSConverter &	Vdcref (double value)

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

VSConverter &	VscMode (int32_t value)

VSConverter &	VscMode (VSConverterControlMode value)

VSConverter &	VscMode (const string &value)

VSConverter &	VscMode (const char *value)

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

VSConverter &	VscMode_str (const string &value)
	Control Mode (Fixed\|PacVac\|PacQac\|VdcVac\|VdcQac). More...

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

VSConverter &	spectrum (const string &value)

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

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

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

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

VSConverter &	basefreq (double value)

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

VSConverter &	enabled (bool value)

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

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

static const int32_t	dss_cls_idx = 45

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

◆ VSConverterControlMode

enum class dss::obj::VSConverter::VSConverterControlMode : int32_t

strong

VSConverter: Control Mode (DSS enumeration for VSConverter)

Enumerator
Fixed	Fixed.
PacVac	PacVac.
PacQac	PacQac.
VdcVac	VdcVac.
VdcQac	VdcQac.

Member Function Documentation

◆ basefreq()

double dss::obj::VSConverter::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 21

◆ begin_edit()

VSConverter & dss::obj::VSConverter::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ Bus1()

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

double dss::obj::VSConverter::d0 ( )

inline

Fixed or initial value of the power angle in degrees.

Default is 0.

DSS property name: d0, DSS property index: 10

◆ enabled()

bool dss::obj::VSConverter::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 22

◆ end_edit()

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

◆ Iacmax()

double dss::obj::VSConverter::Iacmax ( )

inline

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

Default is 2.

DSS property name: Iacmax, DSS property index: 13

◆ Idcmax()

double dss::obj::VSConverter::Idcmax ( )

inline

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

Default is 2.

DSS property name: Idcmax, DSS property index: 14

◆ kVac()

double dss::obj::VSConverter::kVac ( )

inline

Nominal AC line-neutral voltage in kV.

Must be specified > 0.

DSS property name: kVac, DSS property index: 3

◆ kVdc()

double dss::obj::VSConverter::kVdc ( )

inline

Nominal DC voltage in kV.

Must be specified > 0.

DSS property name: kVdc, DSS property index: 4

◆ kW()

double dss::obj::VSConverter::kW ( )

inline

Nominal converter power in kW.

Must be specified > 0.

DSS property name: kW, DSS property index: 5

◆ like() [1/2]

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

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

double dss::obj::VSConverter::m0 ( )

inline

Fixed or initial value of the modulation index.

Default is 0.5.

DSS property name: m0, DSS property index: 9

◆ Mmax()

double dss::obj::VSConverter::Mmax ( )

inline

Maximum value of modulation index.

Default is 0.9.

DSS property name: Mmax, DSS property index: 12

◆ Mmin()

double dss::obj::VSConverter::Mmin ( )

inline

Minimum value of modulation index.

Default is 0.1.

DSS property name: Mmin, DSS property index: 11

◆ Ndc()

int32_t dss::obj::VSConverter::Ndc ( )

inline

Number of DC conductors.

Default is 1. DC conductors numbered after AC phases.

DSS property name: Ndc, DSS property index: 6

◆ Pacref()

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

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

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

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

string dss::obj::VSConverter::spectrum ( )

inline

Name of harmonic spectrum for this device.

DSS property name: spectrum, DSS property index: 20

◆ spectrum_obj()

dss::obj::Spectrum dss::obj::VSConverter::spectrum_obj ( )

inline

Name of harmonic spectrum for this device.

DSS property name: spectrum, DSS property index: 20

◆ Vacref()

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

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

VSConverterControlMode dss::obj::VSConverter::VscMode ( )

inline

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

Default is Fixed.

DSS property name: VscMode, DSS property index: 19

◆ VscMode_str() [1/2]

string dss::obj::VSConverter::VscMode_str ( )

inline

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

Default is Fixed.

DSS property name: VscMode, DSS property index: 19

◆ VscMode_str() [2/2]

VSConverter & dss::obj::VSConverter::VscMode_str ( const string & value )

inline

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

Default is Fixed.

DSS property name: VscMode, DSS property index: 19

◆ Xac()

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ VSConverterControlMode

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ Bus1()

◆ d0()

◆ enabled()

◆ end_edit()

◆ 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() [1/2]

◆ VscMode_str() [2/2]

◆ Xac()