Inheritance diagram for dss::obj::VCCSBatch:

Collaboration diagram for dss::obj::VCCSBatch:

Public Types
typedef VCCS::Properties	Properties

typedef VCCS	BatchElementClass

Public Member Functions
	VCCSBatch (APIUtil *util)
	Create a batch of all VCCS elements.

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

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

VCCSBatch &	begin_edit ()

VCCSBatch &	end_edit (int32_t num_edits=1)

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

VCCSBatch &	bus1 (const string &value)

VCCSBatch &	bus1 (strings &value)

BatchInt32ArrayProxy	phases ()
	Number of phases. More...

VCCSBatch &	phases (int32_t value)

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

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

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

VCCSBatch &	prated (double value)

template<typename T >
VCCSBatch &	prated (T &value)

template<typename T >
VCCSBatch &	prated (typename T::iterator it_begin, typename T::iterator it_end)

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

VCCSBatch &	vrated (double value)

template<typename T >
VCCSBatch &	vrated (T &value)

template<typename T >
VCCSBatch &	vrated (typename T::iterator it_begin, typename T::iterator it_end)

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

VCCSBatch &	ppct (double value)

template<typename T >
VCCSBatch &	ppct (T &value)

template<typename T >
VCCSBatch &	ppct (typename T::iterator it_begin, typename T::iterator it_end)

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

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

VCCSBatch &	bp1 (const string &value)

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

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

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

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

VCCSBatch &	bp2 (const string &value)

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

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

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

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

VCCSBatch &	filter (const string &value)

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

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

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

VCCSBatch &	fsample (double value)

template<typename T >
VCCSBatch &	fsample (T &value)

template<typename T >
VCCSBatch &	fsample (typename T::iterator it_begin, typename T::iterator it_end)

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

VCCSBatch &	rmsmode (bool value)

VCCSBatch &	rmsmode (bools &value)

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

VCCSBatch &	imaxpu (double value)

template<typename T >
VCCSBatch &	imaxpu (T &value)

template<typename T >
VCCSBatch &	imaxpu (typename T::iterator it_begin, typename T::iterator it_end)

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

VCCSBatch &	vrmstau (double value)

template<typename T >
VCCSBatch &	vrmstau (T &value)

template<typename T >
VCCSBatch &	vrmstau (typename T::iterator it_begin, typename T::iterator it_end)

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

VCCSBatch &	irmstau (double value)

template<typename T >
VCCSBatch &	irmstau (T &value)

template<typename T >
VCCSBatch &	irmstau (typename T::iterator it_begin, typename T::iterator it_end)

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

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

VCCSBatch &	spectrum (const string &value)

std::vector< dss::obj::Spectrum >	spectrum_obj ()
	Harmonic spectrum assumed for this source. More...

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

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

VCCSBatch &	basefreq (double value)

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

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

VCCSBatch &	enabled (bool value)

VCCSBatch &	enabled (bools &value)

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

VCCSBatch &	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::VCCSBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 15

◆ bp1()

strings dss::obj::VCCSBatch::bp1 ( )

inline

XYCurve defining the input piece-wise linear block.

DSS property name: bp1, DSS property index: 6

◆ bp1_obj()

std::vector< dss::obj::XYcurve > dss::obj::VCCSBatch::bp1_obj ( )

inline

XYCurve defining the input piece-wise linear block.

DSS property name: bp1, DSS property index: 6

◆ bp2()

strings dss::obj::VCCSBatch::bp2 ( )

inline

XYCurve defining the output piece-wise linear block.

DSS property name: bp2, DSS property index: 7

◆ bp2_obj()

std::vector< dss::obj::XYcurve > dss::obj::VCCSBatch::bp2_obj ( )

inline

XYCurve defining the output piece-wise linear block.

DSS property name: bp2, DSS property index: 7

◆ bus1()

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

bools dss::obj::VCCSBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 16

◆ filter()

strings dss::obj::VCCSBatch::filter ( )

inline

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

DSS property name: filter, DSS property index: 8

◆ filter_obj()

std::vector< dss::obj::XYcurve > dss::obj::VCCSBatch::filter_obj ( )

inline

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

DSS property name: filter, DSS property index: 8

◆ fsample()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::fsample ( )

inline

Sample frequency [Hz} for the digital filter.

DSS property name: fsample, DSS property index: 9

◆ imaxpu()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::imaxpu ( )

inline

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

DSS property name: imaxpu, DSS property index: 11

◆ irmstau()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::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]

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

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

BatchInt32ArrayProxy dss::obj::VCCSBatch::phases ( )

inline

Number of phases.

Defaults to 1.

DSS property name: phases, DSS property index: 2

◆ ppct()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::ppct ( )

inline

Steady-state operating output, in percent of rated.

DSS property name: ppct, DSS property index: 5

◆ prated()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::prated ( )

inline

Total rated power, in Watts.

DSS property name: prated, DSS property index: 3

◆ rmsmode()

bools dss::obj::VCCSBatch::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()

strings dss::obj::VCCSBatch::spectrum ( )

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 14

◆ spectrum_obj()

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

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 14

◆ vrated()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::vrated ( )

inline

Rated line-to-line voltage, in Volts.

DSS property name: vrated, DSS property index: 4

◆ vrmstau()

BatchFloat64ArrayProxy dss::obj::VCCSBatch::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

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ bp1()

◆ bp1_obj()

◆ bp2()

◆ bp2_obj()

◆ bus1()

◆ enabled()

◆ filter()

◆ filter_obj()

◆ fsample()

◆ imaxpu()

◆ irmstau()

◆ like() [1/2]

◆ like() [2/2]

◆ phases()

◆ ppct()

◆ prated()

◆ rmsmode()

◆ spectrum()

◆ spectrum_obj()

◆ vrated()

◆ vrmstau()