Inheritance diagram for dss::obj::GICsource:

Collaboration diagram for dss::obj::GICsource:

Classes
struct	Properties

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

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

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

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

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

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

double	Volts ()
	Voltage magnitude, in volts, of the GIC voltage induced across the associated line. More...

GICsource &	Volts (double value)

double	angle ()
	Phase angle in degrees of first phase. More...

GICsource &	angle (double value)

double	frequency ()
	Source frequency. More...

GICsource &	frequency (double value)

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

GICsource &	phases (int32_t value)

double	EN ()
	Northward Electric field (V/km). More...

GICsource &	EN (double value)

double	EE ()
	Eastward Electric field (V/km). More...

GICsource &	EE (double value)

double	Lat1 ()
	Latitude of Bus1 of the line(degrees) More...

GICsource &	Lat1 (double value)

double	Lon1 ()
	Longitude of Bus1 of the line (degrees) More...

GICsource &	Lon1 (double value)

double	Lat2 ()
	Latitude of Bus2 of the line (degrees) More...

GICsource &	Lat2 (double value)

double	Lon2 ()
	Longitude of Bus2 of the line (degrees) More...

GICsource &	Lon2 (double value)

string	spectrum ()
	Not used. More...

GICsource &	spectrum (const string &value)

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

dss::obj::Spectrum	spectrum_obj ()
	Not used. More...

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

double	basefreq ()
	Not used. More...

GICsource &	basefreq (double value)

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

GICsource &	enabled (bool value)

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

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

static const int32_t	dss_cls_idx = 39

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

◆ angle()

double dss::obj::GICsource::angle ( )

inline

Phase angle in degrees of first phase.

Default=0.0. See Voltage property

DSS property name: angle, DSS property index: 2

◆ basefreq()

double dss::obj::GICsource::basefreq ( )

inline

Not used.

DSS property name: basefreq, DSS property index: 12

◆ begin_edit()

GICsource & dss::obj::GICsource::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ EE()

double dss::obj::GICsource::EE ( )

inline

Eastward Electric field (V/km).

If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EE, DSS property index: 6

◆ EN()

double dss::obj::GICsource::EN ( )

inline

Northward Electric field (V/km).

If specified, Voltage and Angle are computed from EN, EE, lat and lon values.

DSS property name: EN, DSS property index: 5

◆ enabled()

bool dss::obj::GICsource::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 13

◆ end_edit()

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

inline

Source frequency.

Defaults to 0.1 Hz. So GICSource=0 at power frequency.

DSS property name: frequency, DSS property index: 3

◆ Lat1()

double dss::obj::GICsource::Lat1 ( )

inline

Latitude of Bus1 of the line(degrees)

DSS property name: Lat1, DSS property index: 7

◆ Lat2()

double dss::obj::GICsource::Lat2 ( )

inline

Latitude of Bus2 of the line (degrees)

DSS property name: Lat2, DSS property index: 9

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ Lon1()

double dss::obj::GICsource::Lon1 ( )

inline

Longitude of Bus1 of the line (degrees)

DSS property name: Lon1, DSS property index: 8

◆ Lon2()

double dss::obj::GICsource::Lon2 ( )

inline

Longitude of Bus2 of the line (degrees)

DSS property name: Lon2, DSS property index: 10

◆ phases()

int32_t dss::obj::GICsource::phases ( )

inline

Number of phases.

Defaults to 3. All three phases are assumed in phase (zero sequence)

DSS property name: phases, DSS property index: 4

◆ spectrum()

string dss::obj::GICsource::spectrum ( )

inline

Not used.

DSS property name: spectrum, DSS property index: 11

◆ spectrum_obj()

dss::obj::Spectrum dss::obj::GICsource::spectrum_obj ( )

inline

Not used.

DSS property name: spectrum, DSS property index: 11

◆ Volts()

double dss::obj::GICsource::Volts ( )

inline

Voltage magnitude, in volts, of the GIC voltage induced across the associated line.

When specified, induced voltage is assumed defined by Voltage and Angle properties.

Specify this value

OR

EN, EE, lat1, lon1, lat2, lon2.

Not both!! Last one entered will take precedence. Assumed identical in each phase of the Line object.

DSS property name: Volts, DSS property index: 1

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

◆ angle()

◆ basefreq()

◆ begin_edit()

◆ EE()

◆ EN()

◆ enabled()

◆ end_edit()

◆ frequency()

◆ Lat1()

◆ Lat2()

◆ like() [1/2]

◆ like() [2/2]

◆ Lon1()

◆ Lon2()

◆ phases()

◆ spectrum()

◆ spectrum_obj()

◆ Volts()