Inheritance diagram for dss::obj::GICLineBatch:

Collaboration diagram for dss::obj::GICLineBatch:

Public Types
typedef GICLine::Properties	Properties

typedef GICLine	BatchElementClass

Public Member Functions
	GICLineBatch (APIUtil *util)
	Create a batch of all GICLine elements.

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

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

GICLineBatch &	begin_edit ()

GICLineBatch &	end_edit (int32_t num_edits=1)

strings	bus1 ()
	Name of bus to which the main terminal (1) is connected. More...

GICLineBatch &	bus1 (const string &value)

GICLineBatch &	bus1 (strings &value)

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

GICLineBatch &	bus2 (const string &value)

GICLineBatch &	bus2 (strings &value)

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

GICLineBatch &	Volts (double value)

template<typename T >
GICLineBatch &	Volts (T &value)

template<typename T >
GICLineBatch &	Volts (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Angle ()
	Phase angle in degrees of first phase. More...

GICLineBatch &	Angle (double value)

template<typename T >
GICLineBatch &	Angle (T &value)

template<typename T >
GICLineBatch &	Angle (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	frequency ()
	Source frequency. More...

GICLineBatch &	frequency (double value)

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

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

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

GICLineBatch &	phases (int32_t value)

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

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

BatchFloat64ArrayProxy	R ()
	Resistance of line, ohms of impedance in series with GIC voltage source. More...

GICLineBatch &	R (double value)

template<typename T >
GICLineBatch &	R (T &value)

template<typename T >
GICLineBatch &	R (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	X ()
	Reactance at base frequency, ohms. More...

GICLineBatch &	X (double value)

template<typename T >
GICLineBatch &	X (T &value)

template<typename T >
GICLineBatch &	X (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	C ()
	Value of line blocking capacitance in microfarads. More...

GICLineBatch &	C (double value)

template<typename T >
GICLineBatch &	C (T &value)

template<typename T >
GICLineBatch &	C (typename T::iterator it_begin, typename T::iterator it_end)

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

GICLineBatch &	EN (double value)

template<typename T >
GICLineBatch &	EN (T &value)

template<typename T >
GICLineBatch &	EN (typename T::iterator it_begin, typename T::iterator it_end)

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

GICLineBatch &	EE (double value)

template<typename T >
GICLineBatch &	EE (T &value)

template<typename T >
GICLineBatch &	EE (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Lat1 ()
	Latitude of Bus1 (degrees) More...

GICLineBatch &	Lat1 (double value)

template<typename T >
GICLineBatch &	Lat1 (T &value)

template<typename T >
GICLineBatch &	Lat1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Lon1 ()
	Longitude of Bus1 (degrees) More...

GICLineBatch &	Lon1 (double value)

template<typename T >
GICLineBatch &	Lon1 (T &value)

template<typename T >
GICLineBatch &	Lon1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Lat2 ()
	Latitude of Bus2 (degrees) More...

GICLineBatch &	Lat2 (double value)

template<typename T >
GICLineBatch &	Lat2 (T &value)

template<typename T >
GICLineBatch &	Lat2 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Lon2 ()
	Longitude of Bus2 (degrees) More...

GICLineBatch &	Lon2 (double value)

template<typename T >
GICLineBatch &	Lon2 (T &value)

template<typename T >
GICLineBatch &	Lon2 (typename T::iterator it_begin, typename T::iterator it_end)

strings	spectrum ()
	Inherited Property for all PCElements. More...

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

GICLineBatch &	spectrum (const string &value)

std::vector< dss::obj::Spectrum >	spectrum_obj ()
	Inherited Property for all PCElements. More...

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

BatchFloat64ArrayProxy	basefreq ()
	Inherited Property for all PCElements. More...

GICLineBatch &	basefreq (double value)

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

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

GICLineBatch &	enabled (bool value)

GICLineBatch &	enabled (bools &value)

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

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

◆ Angle()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::Angle ( )

inline

Phase angle in degrees of first phase.

Default=0.0. See Voltage property

DSS property name: Angle, DSS property index: 4

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::basefreq ( )

inline

Inherited Property for all PCElements.

Base frequency for specification of reactance value.

DSS property name: basefreq, DSS property index: 17

◆ bus1()

strings dss::obj::GICLineBatch::bus1 ( )

inline

Name of bus to which the main terminal (1) is connected.

bus1=busname bus1=busname.1.2.3

DSS property name: bus1, DSS property index: 1

◆ bus2()

strings dss::obj::GICLineBatch::bus2 ( )

inline

Name of bus to which 2nd terminal is connected.

bus2=busname bus2=busname.1.2.3

No Default; must be specified.

DSS property name: bus2, DSS property index: 2

◆ C()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::C ( )

inline

Value of line blocking capacitance in microfarads.

Default = 0.0, implying that there is no line blocking capacitor.

DSS property name: C, DSS property index: 9

◆ EE()

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

◆ EN()

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

◆ enabled()

bools dss::obj::GICLineBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 18

◆ frequency()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::frequency ( )

inline

Source frequency.

Defaults to 0.1 Hz.

DSS property name: frequency, DSS property index: 5

◆ Lat1()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::Lat1 ( )

inline

Latitude of Bus1 (degrees)

DSS property name: Lat1, DSS property index: 12

◆ Lat2()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::Lat2 ( )

inline

Latitude of Bus2 (degrees)

DSS property name: Lat2, DSS property index: 14

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 19

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 19

◆ Lon1()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::Lon1 ( )

inline

Longitude of Bus1 (degrees)

DSS property name: Lon1, DSS property index: 13

◆ Lon2()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::Lon2 ( )

inline

Longitude of Bus2 (degrees)

DSS property name: Lon2, DSS property index: 15

◆ phases()

BatchInt32ArrayProxy dss::obj::GICLineBatch::phases ( )

inline

Number of phases.

Defaults to 3.

DSS property name: phases, DSS property index: 6

◆ R()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::R ( )

inline

Resistance of line, ohms of impedance in series with GIC voltage source.

DSS property name: R, DSS property index: 7

◆ spectrum()

strings dss::obj::GICLineBatch::spectrum ( )

inline

Inherited Property for all PCElements.

Name of harmonic spectrum for this source. Default is "defaultvsource", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 16

◆ spectrum_obj()

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

inline

Inherited Property for all PCElements.

Name of harmonic spectrum for this source. Default is "defaultvsource", which is defined when the DSS starts.

DSS property name: spectrum, DSS property index: 16

◆ Volts()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::Volts ( )

inline

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

When spedified, voltage source 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: 3

◆ X()

BatchFloat64ArrayProxy dss::obj::GICLineBatch::X ( )

inline

Reactance at base frequency, ohms.

Default = 0.0. This value is generally not important for GIC studies but may be used if desired.

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

◆ Angle()

◆ basefreq()

◆ bus1()

◆ bus2()

◆ C()

◆ EE()

◆ EN()

◆ enabled()

◆ frequency()

◆ Lat1()

◆ Lat2()

◆ like() [1/2]

◆ like() [2/2]

◆ Lon1()

◆ Lon2()

◆ phases()

◆ R()

◆ spectrum()

◆ spectrum_obj()

◆ Volts()

◆ X()