Inheritance diagram for dss::obj::IsourceBatch:

Collaboration diagram for dss::obj::IsourceBatch:

Public Types
typedef Isource::Properties	Properties

typedef Isource	BatchElementClass

Public Member Functions
	IsourceBatch (APIUtil *util)
	Create a batch of all Isource elements.

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

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

IsourceBatch &	begin_edit ()

IsourceBatch &	end_edit (int32_t num_edits=1)

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

IsourceBatch &	bus1 (const string &value)

IsourceBatch &	bus1 (strings &value)

BatchFloat64ArrayProxy	amps ()
	Magnitude of current source, each phase, in Amps. More...

IsourceBatch &	amps (double value)

template<typename T >
IsourceBatch &	amps (T &value)

template<typename T >
IsourceBatch &	amps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	angle ()
	Phase angle in degrees of first phase: e.g.,Angle=10.3. More...

IsourceBatch &	angle (double value)

template<typename T >
IsourceBatch &	angle (T &value)

template<typename T >
IsourceBatch &	angle (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	frequency ()
	Source frequency. More...

IsourceBatch &	frequency (double value)

template<typename T >
IsourceBatch &	frequency (T &value)

template<typename T >
IsourceBatch &	frequency (typename T::iterator it_begin, typename T::iterator it_end)

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

IsourceBatch &	phases (int32_t value)

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

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

BatchInt32ArrayProxy	scantype ()
	{pos*\| zero \| none} Maintain specified sequence for harmonic solution. More...

IsourceBatch &	scantype (string &value)

IsourceBatch &	scantype (int32_t value)

IsourceBatch &	scantype (ScanType value)

IsourceBatch &	scantype (strings &value)

IsourceBatch &	scantype (std::vector< int32_t > &value)

IsourceBatch &	scantype (std::vector< ScanType > &value)

strings	scantype_str ()
	{pos*\| zero \| none} Maintain specified sequence for harmonic solution. More...

IsourceBatch &	scantype_str (string &value)

IsourceBatch &	scantype_str (strings &value)

BatchInt32ArrayProxy	sequence ()
	{pos*\| neg \| zero} Set the phase angles for the specified symmetrical component sequence for non-harmonic solution modes. More...

IsourceBatch &	sequence (string &value)

IsourceBatch &	sequence (int32_t value)

IsourceBatch &	sequence (SequenceType value)

IsourceBatch &	sequence (strings &value)

IsourceBatch &	sequence (std::vector< int32_t > &value)

IsourceBatch &	sequence (std::vector< SequenceType > &value)

strings	sequence_str ()
	{pos*\| neg \| zero} Set the phase angles for the specified symmetrical component sequence for non-harmonic solution modes. More...

IsourceBatch &	sequence_str (string &value)

IsourceBatch &	sequence_str (strings &value)

strings	Yearly ()
	LOADSHAPE object to use for the per-unit current for YEARLY-mode simulations. More...

IsourceBatch &	Yearly (dss::obj::LoadShape &value)

IsourceBatch &	Yearly (const string &value)

std::vector< dss::obj::LoadShape >	Yearly_obj ()
	LOADSHAPE object to use for the per-unit current for YEARLY-mode simulations. More...

IsourceBatch &	Yearly_obj (dss::obj::LoadShape &value)

strings	Daily ()
	LOADSHAPE object to use for the per-unit current for DAILY-mode simulations. More...

IsourceBatch &	Daily (dss::obj::LoadShape &value)

IsourceBatch &	Daily (const string &value)

std::vector< dss::obj::LoadShape >	Daily_obj ()
	LOADSHAPE object to use for the per-unit current for DAILY-mode simulations. More...

IsourceBatch &	Daily_obj (dss::obj::LoadShape &value)

strings	Duty ()
	LOADSHAPE object to use for the per-unit current for DUTYCYCLE-mode simulations. More...

IsourceBatch &	Duty (dss::obj::LoadShape &value)

IsourceBatch &	Duty (const string &value)

std::vector< dss::obj::LoadShape >	Duty_obj ()
	LOADSHAPE object to use for the per-unit current for DUTYCYCLE-mode simulations. More...

IsourceBatch &	Duty_obj (dss::obj::LoadShape &value)

strings	Bus2 ()
	Name of bus to which 2nd terminal is connected. More...

IsourceBatch &	Bus2 (const string &value)

IsourceBatch &	Bus2 (strings &value)

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

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

IsourceBatch &	spectrum (const string &value)

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

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

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

IsourceBatch &	basefreq (double value)

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

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

IsourceBatch &	enabled (bool value)

IsourceBatch &	enabled (bools &value)

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

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

◆ amps()

BatchFloat64ArrayProxy dss::obj::IsourceBatch::amps ( )

inline

Magnitude of current source, each phase, in Amps.

DSS property name: amps, DSS property index: 2

◆ angle()

BatchFloat64ArrayProxy dss::obj::IsourceBatch::angle ( )

inline

Phase angle in degrees of first phase: e.g.,Angle=10.3.

Phase shift between phases is assumed 120 degrees when number of phases <= 3

DSS property name: angle, DSS property index: 3

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::IsourceBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 13

◆ bus1()

strings dss::obj::IsourceBatch::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

◆ Bus2()

strings dss::obj::IsourceBatch::Bus2 ( )

inline

Name of bus to which 2nd terminal is connected.

bus2=busname bus2=busname.1.2.3

Default is Bus1.0.0.0 (grounded-wye connection)

DSS property name: Bus2, DSS property index: 11

◆ Daily()

strings dss::obj::IsourceBatch::Daily ( )

inline

LOADSHAPE object to use for the per-unit current for DAILY-mode simulations.

Set the Mult property of the LOADSHAPE to the pu curve. Qmult is not used. If UseActual=Yes then the Mult curve should be actual A.

Must be previously defined as a LOADSHAPE object.

Sets Yearly curve if it is not already defined. Set to NONE to reset to no loadahape for Yearly mode. The default is no variation.

DSS property name: Daily, DSS property index: 9

◆ Daily_obj()

std::vector< dss::obj::LoadShape > dss::obj::IsourceBatch::Daily_obj ( )

inline

LOADSHAPE object to use for the per-unit current for DAILY-mode simulations.

Set the Mult property of the LOADSHAPE to the pu curve. Qmult is not used. If UseActual=Yes then the Mult curve should be actual A.

Must be previously defined as a LOADSHAPE object.

Sets Yearly curve if it is not already defined. Set to NONE to reset to no loadahape for Yearly mode. The default is no variation.

DSS property name: Daily, DSS property index: 9

◆ Duty()

strings dss::obj::IsourceBatch::Duty ( )

inline

LOADSHAPE object to use for the per-unit current for DUTYCYCLE-mode simulations.

Set the Mult property of the LOADSHAPE to the pu curve. Qmult is not used. If UseActual=Yes then the Mult curve should be actual A.

Must be previously defined as a LOADSHAPE object.

Defaults to Daily load shape when Daily is defined. Set to NONE to reset to no loadahape for Yearly mode. The default is no variation.

DSS property name: Duty, DSS property index: 10

◆ Duty_obj()

std::vector< dss::obj::LoadShape > dss::obj::IsourceBatch::Duty_obj ( )

inline

LOADSHAPE object to use for the per-unit current for DUTYCYCLE-mode simulations.

Set the Mult property of the LOADSHAPE to the pu curve. Qmult is not used. If UseActual=Yes then the Mult curve should be actual A.

Must be previously defined as a LOADSHAPE object.

Defaults to Daily load shape when Daily is defined. Set to NONE to reset to no loadahape for Yearly mode. The default is no variation.

DSS property name: Duty, DSS property index: 10

◆ enabled()

bools dss::obj::IsourceBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 14

◆ frequency()

BatchFloat64ArrayProxy dss::obj::IsourceBatch::frequency ( )

inline

Source frequency.

Defaults to circuit fundamental frequency.

DSS property name: frequency, DSS property index: 4

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 15

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 15

◆ phases()

BatchInt32ArrayProxy dss::obj::IsourceBatch::phases ( )

inline

Number of phases.

Defaults to 3. For 3 or less, phase shift is 120 degrees.

DSS property name: phases, DSS property index: 5

◆ scantype()

BatchInt32ArrayProxy dss::obj::IsourceBatch::scantype ( )

inline

{pos*| zero | none} Maintain specified sequence for harmonic solution.

Default is positive sequence. Otherwise, angle between phases rotates with harmonic.

DSS property name: scantype, DSS property index: 6

◆ scantype_str()

strings dss::obj::IsourceBatch::scantype_str ( )

inline

{pos*| zero | none} Maintain specified sequence for harmonic solution.

Default is positive sequence. Otherwise, angle between phases rotates with harmonic.

DSS property name: scantype, DSS property index: 6

◆ sequence()

BatchInt32ArrayProxy dss::obj::IsourceBatch::sequence ( )

inline

{pos*| neg | zero} Set the phase angles for the specified symmetrical component sequence for non-harmonic solution modes.

Default is positive sequence.

DSS property name: sequence, DSS property index: 7

◆ sequence_str()

strings dss::obj::IsourceBatch::sequence_str ( )

inline

{pos*| neg | zero} Set the phase angles for the specified symmetrical component sequence for non-harmonic solution modes.

Default is positive sequence.

DSS property name: sequence, DSS property index: 7

◆ spectrum()

strings dss::obj::IsourceBatch::spectrum ( )

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 12

◆ spectrum_obj()

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

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 12

◆ Yearly()

strings dss::obj::IsourceBatch::Yearly ( )

inline

LOADSHAPE object to use for the per-unit current for YEARLY-mode simulations.

Set the Mult property of the LOADSHAPE to the pu curve. Qmult is not used. If UseActual=Yes then the Mult curve should be actual Amp.

Must be previously defined as a LOADSHAPE object.

Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set to NONE to reset to no loadahape for Yearly mode. The default is no variation.

DSS property name: Yearly, DSS property index: 8

◆ Yearly_obj()

std::vector< dss::obj::LoadShape > dss::obj::IsourceBatch::Yearly_obj ( )

inline

LOADSHAPE object to use for the per-unit current for YEARLY-mode simulations.

Set the Mult property of the LOADSHAPE to the pu curve. Qmult is not used. If UseActual=Yes then the Mult curve should be actual Amp.

Must be previously defined as a LOADSHAPE object.

Is set to the Daily load shape when Daily is defined. The daily load shape is repeated in this case. Set to NONE to reset to no loadahape for Yearly mode. The default is no variation.

DSS property name: Yearly, 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

◆ amps()

◆ angle()

◆ basefreq()

◆ bus1()

◆ Bus2()

◆ Daily()

◆ Daily_obj()

◆ Duty()

◆ Duty_obj()

◆ enabled()

◆ frequency()

◆ like() [1/2]

◆ like() [2/2]

◆ phases()

◆ scantype()

◆ scantype_str()

◆ sequence()

◆ sequence_str()

◆ spectrum()

◆ spectrum_obj()

◆ Yearly()

◆ Yearly_obj()