Inheritance diagram for dss::obj::Isource:

Collaboration diagram for dss::obj::Isource:

Classes
struct	Properties

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

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

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

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

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

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

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

Isource &	bus1 (const string &value)

Isource &	bus1 (const char *value)

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

Isource &	amps (double value)

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

Isource &	angle (double value)

double	frequency ()
	Source frequency. More...

Isource &	frequency (double value)

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

Isource &	phases (int32_t value)

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

Isource &	scantype (int32_t value)

Isource &	scantype (ScanType value)

Isource &	scantype (const string &value)

Isource &	scantype (const char *value)

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

Isource &	scantype_str (const string &value)
	{pos*\| zero \| none} Maintain specified sequence for harmonic solution. More...

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

Isource &	sequence (int32_t value)

Isource &	sequence (SequenceType value)

Isource &	sequence (const string &value)

Isource &	sequence (const char *value)

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

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

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

Isource &	Yearly (const string &value)

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

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

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

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

Isource &	Daily (const string &value)

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

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

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

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

Isource &	Duty (const string &value)

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

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

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

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

Isource &	Bus2 (const string &value)

Isource &	Bus2 (const char *value)

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

Isource &	spectrum (const string &value)

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

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

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

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

Isource &	basefreq (double value)

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

Isource &	enabled (bool value)

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

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

static const int32_t	dss_cls_idx = 17

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

◆ amps()

double dss::obj::Isource::amps ( )

inline

Magnitude of current source, each phase, in Amps.

DSS property name: amps, DSS property index: 2

◆ angle()

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

double dss::obj::Isource::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 13

◆ begin_edit()

Isource & dss::obj::Isource::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ bus1()

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

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

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

dss::obj::LoadShape dss::obj::Isource::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()

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

dss::obj::LoadShape dss::obj::Isource::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()

bool dss::obj::Isource::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 14

◆ end_edit()

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

◆ frequency()

double dss::obj::Isource::frequency ( )

inline

Source frequency.

Defaults to circuit fundamental frequency.

DSS property name: frequency, DSS property index: 4

◆ like() [1/2]

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

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

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

ScanType dss::obj::Isource::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() [1/2]

string dss::obj::Isource::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

◆ scantype_str() [2/2]

Isource & dss::obj::Isource::scantype_str ( const string & value )

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()

SequenceType dss::obj::Isource::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() [1/2]

string dss::obj::Isource::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

◆ sequence_str() [2/2]

Isource & dss::obj::Isource::sequence_str ( const string & value )

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()

string dss::obj::Isource::spectrum ( )

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 12

◆ spectrum_obj()

dss::obj::Spectrum dss::obj::Isource::spectrum_obj ( )

inline

Harmonic spectrum assumed for this source.

Default is "default".

DSS property name: spectrum, DSS property index: 12

◆ Yearly()

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

dss::obj::LoadShape dss::obj::Isource::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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ amps()

◆ angle()

◆ basefreq()

◆ begin_edit()

◆ bus1()

◆ Bus2()

◆ Daily()

◆ Daily_obj()

◆ Duty()

◆ Duty_obj()

◆ enabled()

◆ end_edit()

◆ frequency()

◆ like() [1/2]

◆ like() [2/2]

◆ phases()

◆ scantype()

◆ scantype_str() [1/2]

◆ scantype_str() [2/2]

◆ sequence()

◆ sequence_str() [1/2]

◆ sequence_str() [2/2]

◆ spectrum()

◆ spectrum_obj()

◆ Yearly()

◆ Yearly_obj()