Inheritance diagram for dss::obj::VCCS:

Collaboration diagram for dss::obj::VCCS:

Classes
struct	Properties

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

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

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

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

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

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

string	bus1 ()
	Name of bus to which source is connected. More...

VCCS &	bus1 (const string &value)

VCCS &	bus1 (const char *value)

int32_t	phases ()
	Number of phases. More...

VCCS &	phases (int32_t value)

double	prated ()
	Total rated power, in Watts. More...

VCCS &	prated (double value)

double	vrated ()
	Rated line-to-line voltage, in Volts. More...

VCCS &	vrated (double value)

double	ppct ()
	Steady-state operating output, in percent of rated. More...

VCCS &	ppct (double value)

string	bp1 ()
	XYCurve defining the input piece-wise linear block. More...

VCCS &	bp1 (const string &value)

VCCS &	bp1 (dss::obj::XYcurve &value)

dss::obj::XYcurve	bp1_obj ()
	XYCurve defining the input piece-wise linear block. More...

VCCS &	bp1_obj (dss::obj::XYcurve &value)

string	bp2 ()
	XYCurve defining the output piece-wise linear block. More...

VCCS &	bp2 (const string &value)

VCCS &	bp2 (dss::obj::XYcurve &value)

dss::obj::XYcurve	bp2_obj ()
	XYCurve defining the output piece-wise linear block. More...

VCCS &	bp2_obj (dss::obj::XYcurve &value)

string	filter ()
	XYCurve defining the digital filter coefficients (x numerator, y denominator). More...

VCCS &	filter (const string &value)

VCCS &	filter (dss::obj::XYcurve &value)

dss::obj::XYcurve	filter_obj ()
	XYCurve defining the digital filter coefficients (x numerator, y denominator). More...

VCCS &	filter_obj (dss::obj::XYcurve &value)

double	fsample ()
	Sample frequency [Hz} for the digital filter. More...

VCCS &	fsample (double value)

bool	rmsmode ()
	True if only Hz is used to represent a phase-locked loop (PLL), ignoring the BP1, BP2 and time-domain transformations. More...

VCCS &	rmsmode (bool value)

double	imaxpu ()
	Maximum output current in per-unit of rated; defaults to 1.1. More...

VCCS &	imaxpu (double value)

double	vrmstau ()
	Time constant in sensing Vrms for the PLL; defaults to 0.0015. More...

VCCS &	vrmstau (double value)

double	irmstau ()
	Time constant in producing Irms from the PLL; defaults to 0.0015. More...

VCCS &	irmstau (double value)

string	spectrum ()
	Harmonic spectrum assumed for this source. More...

VCCS &	spectrum (const string &value)

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

dss::obj::Spectrum	spectrum_obj ()
	Harmonic spectrum assumed for this source. More...

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

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

VCCS &	basefreq (double value)

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

VCCS &	enabled (bool value)

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

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

static const int32_t	dss_cls_idx = 18

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 Function Documentation

◆ basefreq()

double dss::obj::VCCS::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15

◆ begin_edit()

VCCS & dss::obj::VCCS::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ bp1()

string dss::obj::VCCS::bp1 ( )

inline

XYCurve defining the input piece-wise linear block.

DSS property name: bp1, DSS property index: 6

◆ bp1_obj()

dss::obj::XYcurve dss::obj::VCCS::bp1_obj ( )

inline

XYCurve defining the input piece-wise linear block.

DSS property name: bp1, DSS property index: 6

◆ bp2()

string dss::obj::VCCS::bp2 ( )

inline

XYCurve defining the output piece-wise linear block.

DSS property name: bp2, DSS property index: 7

◆ bp2_obj()

dss::obj::XYcurve dss::obj::VCCS::bp2_obj ( )

inline

XYCurve defining the output piece-wise linear block.

DSS property name: bp2, DSS property index: 7

◆ bus1()

string dss::obj::VCCS::bus1 ( )

inline

Name of bus to which source is connected.

bus1=busname bus1=busname.1.2.3

DSS property name: bus1, DSS property index: 1

◆ enabled()

bool dss::obj::VCCS::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 16

◆ end_edit()

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

◆ filter()

string dss::obj::VCCS::filter ( )

inline

XYCurve defining the digital filter coefficients (x numerator, y denominator).

DSS property name: filter, DSS property index: 8

◆ filter_obj()

dss::obj::XYcurve dss::obj::VCCS::filter_obj ( )

inline

XYCurve defining the digital filter coefficients (x numerator, y denominator).

DSS property name: filter, DSS property index: 8

◆ fsample()

double dss::obj::VCCS::fsample ( )

inline

Sample frequency [Hz} for the digital filter.

DSS property name: fsample, DSS property index: 9

◆ imaxpu()

double dss::obj::VCCS::imaxpu ( )

inline

Maximum output current in per-unit of rated; defaults to 1.1.

DSS property name: imaxpu, DSS property index: 11

◆ irmstau()

double dss::obj::VCCS::irmstau ( )

inline

Time constant in producing Irms from the PLL; defaults to 0.0015.

DSS property name: irmstau, DSS property index: 13

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 17

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 17

◆ phases()

int32_t dss::obj::VCCS::phases ( )

inline

Number of phases.

Defaults to 1.

DSS property name: phases, DSS property index: 2

◆ ppct()

double dss::obj::VCCS::ppct ( )

inline

Steady-state operating output, in percent of rated.

DSS property name: ppct, DSS property index: 5

◆ prated()

double dss::obj::VCCS::prated ( )

inline

Total rated power, in Watts.

DSS property name: prated, DSS property index: 3

◆ rmsmode()

bool dss::obj::VCCS::rmsmode ( )

inline

True if only Hz is used to represent a phase-locked loop (PLL), ignoring the BP1, BP2 and time-domain transformations.

Default is no.

DSS property name: rmsmode, DSS property index: 10

◆ spectrum()

string dss::obj::VCCS::spectrum ( )

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 14

◆ spectrum_obj()

dss::obj::Spectrum dss::obj::VCCS::spectrum_obj ( )

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 14

◆ vrated()

double dss::obj::VCCS::vrated ( )

inline

Rated line-to-line voltage, in Volts.

DSS property name: vrated, DSS property index: 4

◆ vrmstau()

double dss::obj::VCCS::vrmstau ( )

inline

Time constant in sensing Vrms for the PLL; defaults to 0.0015.

DSS property name: vrmstau, DSS property index: 12

The documentation for this class was generated from the following file:

include/dss_obj.hpp

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ bp1()

◆ bp1_obj()

◆ bp2()

◆ bp2_obj()

◆ bus1()

◆ enabled()

◆ end_edit()

◆ filter()

◆ filter_obj()

◆ fsample()

◆ imaxpu()

◆ irmstau()

◆ like() [1/2]

◆ like() [2/2]

◆ phases()

◆ ppct()

◆ prated()

◆ rmsmode()

◆ spectrum()

◆ spectrum_obj()

◆ vrated()

◆ vrmstau()