Inheritance diagram for dss::obj::LineBatch:

Collaboration diagram for dss::obj::LineBatch:

Public Types
typedef Line::Properties	Properties

typedef Line	BatchElementClass

Public Member Functions
	LineBatch (APIUtil *util)
	Create a batch of all Line elements.

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

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

LineBatch &	begin_edit ()

LineBatch &	end_edit (int32_t num_edits=1)

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

LineBatch &	bus1 (const string &value)

LineBatch &	bus1 (strings &value)

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

LineBatch &	bus2 (const string &value)

LineBatch &	bus2 (strings &value)

strings	linecode ()
	Name of linecode object describing line impedances. More...

LineBatch &	linecode (dss::obj::LineCode &value)

LineBatch &	linecode (const string &value)

std::vector< dss::obj::LineCode >	linecode_obj ()
	Name of linecode object describing line impedances. More...

LineBatch &	linecode_obj (dss::obj::LineCode &value)

BatchFloat64ArrayProxy	length ()
	Length of line. More...

LineBatch &	length (double value)

template<typename T >
LineBatch &	length (T &value)

template<typename T >
LineBatch &	length (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	phases ()
	Number of phases, this line. More...

LineBatch &	phases (int32_t value)

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

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

BatchFloat64ArrayProxy	r1 ()
	Positive-sequence Resistance, ohms per unit length. More...

LineBatch &	r1 (double value)

template<typename T >
LineBatch &	r1 (T &value)

template<typename T >
LineBatch &	r1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	x1 ()
	Positive-sequence Reactance, ohms per unit length. More...

LineBatch &	x1 (double value)

template<typename T >
LineBatch &	x1 (T &value)

template<typename T >
LineBatch &	x1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	r0 ()
	Zero-sequence Resistance, ohms per unit length. More...

LineBatch &	r0 (double value)

template<typename T >
LineBatch &	r0 (T &value)

template<typename T >
LineBatch &	r0 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	x0 ()
	Zero-sequence Reactance, ohms per unit length. More...

LineBatch &	x0 (double value)

template<typename T >
LineBatch &	x0 (T &value)

template<typename T >
LineBatch &	x0 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	C1 ()
	Positive-sequence capacitance, nf per unit length. More...

LineBatch &	C1 (double value)

template<typename T >
LineBatch &	C1 (T &value)

template<typename T >
LineBatch &	C1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	C0 ()
	Zero-sequence capacitance, nf per unit length. More...

LineBatch &	C0 (double value)

template<typename T >
LineBatch &	C0 (T &value)

template<typename T >
LineBatch &	C0 (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	rmatrix ()
	Resistance matrix, lower triangle, ohms per unit length. More...

LineBatch &	rmatrix (VectorXd &value)

std::vector< VectorXd >	xmatrix ()
	Reactance matrix, lower triangle, ohms per unit length. More...

LineBatch &	xmatrix (VectorXd &value)

std::vector< VectorXd >	cmatrix ()
	Nodal Capacitance matrix, lower triangle, nf per unit length.Order of the matrix is the number of phases. More...

LineBatch &	cmatrix (VectorXd &value)

bools	Switch ()
	{y/n \| T/F} Default= no/false. More...

LineBatch &	Switch (bool value)

LineBatch &	Switch (bools &value)

BatchFloat64ArrayProxy	Rg ()
	Carson earth return resistance per unit length used to compute impedance values at base frequency. More...

LineBatch &	Rg (double value)

template<typename T >
LineBatch &	Rg (T &value)

template<typename T >
LineBatch &	Rg (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xg ()
	Carson earth return reactance per unit length used to compute impedance values at base frequency. More...

LineBatch &	Xg (double value)

template<typename T >
LineBatch &	Xg (T &value)

template<typename T >
LineBatch &	Xg (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	rho ()
	Default=100 meter ohms. More...

LineBatch &	rho (double value)

template<typename T >
LineBatch &	rho (T &value)

template<typename T >
LineBatch &	rho (typename T::iterator it_begin, typename T::iterator it_end)

strings	geometry ()
	Geometry code for LineGeometry Object. More...

LineBatch &	geometry (dss::obj::LineGeometry &value)

LineBatch &	geometry (const string &value)

std::vector< dss::obj::LineGeometry >	geometry_obj ()
	Geometry code for LineGeometry Object. More...

LineBatch &	geometry_obj (dss::obj::LineGeometry &value)

BatchInt32ArrayProxy	units ()
	Length Units = {none \| mi\|kft\|km\|m\|Ft\|in\|cm } Default is None - assumes length units match impedance units. More...

LineBatch &	units (string &value)

LineBatch &	units (int32_t value)

LineBatch &	units (DimensionUnits value)

LineBatch &	units (strings &value)

LineBatch &	units (std::vector< int32_t > &value)

LineBatch &	units (std::vector< DimensionUnits > &value)

strings	units_str ()
	Length Units = {none \| mi\|kft\|km\|m\|Ft\|in\|cm } Default is None - assumes length units match impedance units. More...

LineBatch &	units_str (string &value)

LineBatch &	units_str (strings &value)

strings	spacing ()
	Reference to a LineSpacing for use in a line constants calculation. More...

LineBatch &	spacing (dss::obj::LineSpacing &value)

LineBatch &	spacing (const string &value)

std::vector< dss::obj::LineSpacing >	spacing_obj ()
	Reference to a LineSpacing for use in a line constants calculation. More...

LineBatch &	spacing_obj (dss::obj::LineSpacing &value)

std::vector< strings >	wires ()
	Array of WireData names for use in an overhead line constants calculation. More...

LineBatch &	wires (strings &value)

LineBatch &	wires (std::vector< dss::obj::WireData > &value)

LineBatch &	wires (std::vector< strings > &value)

LineBatch &	wires (std::vector< std::vector< dss::obj::WireData > > &value)

std::vector< std::vector< dss::obj::WireData > >	wires_obj ()
	Array of WireData names for use in an overhead line constants calculation. More...

LineBatch &	wires_obj (std::vector< dss::obj::WireData > &value)

LineBatch &	wires_obj (std::vector< std::vector< dss::obj::WireData > > &value)

BatchInt32ArrayProxy	earthmodel ()
	One of {Carson \| FullCarson \| Deri}. More...

LineBatch &	earthmodel (string &value)

LineBatch &	earthmodel (int32_t value)

LineBatch &	earthmodel (EarthModel value)

LineBatch &	earthmodel (strings &value)

LineBatch &	earthmodel (std::vector< int32_t > &value)

LineBatch &	earthmodel (std::vector< EarthModel > &value)

strings	earthmodel_str ()
	One of {Carson \| FullCarson \| Deri}. More...

LineBatch &	earthmodel_str (string &value)

LineBatch &	earthmodel_str (strings &value)

std::vector< strings >	cncables ()
	Array of CNData names for use in a cable constants calculation. More...

LineBatch &	cncables (strings &value)

LineBatch &	cncables (std::vector< dss::obj::CNData > &value)

LineBatch &	cncables (std::vector< strings > &value)

LineBatch &	cncables (std::vector< std::vector< dss::obj::CNData > > &value)

std::vector< std::vector< dss::obj::CNData > >	cncables_obj ()
	Array of CNData names for use in a cable constants calculation. More...

LineBatch &	cncables_obj (std::vector< dss::obj::CNData > &value)

LineBatch &	cncables_obj (std::vector< std::vector< dss::obj::CNData > > &value)

std::vector< strings >	tscables ()
	Array of TSData names for use in a cable constants calculation. More...

LineBatch &	tscables (strings &value)

LineBatch &	tscables (std::vector< dss::obj::TSData > &value)

LineBatch &	tscables (std::vector< strings > &value)

LineBatch &	tscables (std::vector< std::vector< dss::obj::TSData > > &value)

std::vector< std::vector< dss::obj::TSData > >	tscables_obj ()
	Array of TSData names for use in a cable constants calculation. More...

LineBatch &	tscables_obj (std::vector< dss::obj::TSData > &value)

LineBatch &	tscables_obj (std::vector< std::vector< dss::obj::TSData > > &value)

BatchFloat64ArrayProxy	B1 ()
	Alternate way to specify C1. More...

LineBatch &	B1 (double value)

template<typename T >
LineBatch &	B1 (T &value)

template<typename T >
LineBatch &	B1 (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	B0 ()
	Alternate way to specify C0. More...

LineBatch &	B0 (double value)

template<typename T >
LineBatch &	B0 (T &value)

template<typename T >
LineBatch &	B0 (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Seasons ()
	Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the "Ratings" property. More...

LineBatch &	Seasons (int32_t value)

template<typename T >
LineBatch &	Seasons (T &value)

template<typename T >
LineBatch &	Seasons (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	Ratings ()
	An array of ratings to be used when the seasonal ratings flag is True. More...

LineBatch &	Ratings (VectorXd &value)

BatchInt32ArrayProxy	linetype ()
	Code designating the type of line. More...

LineBatch &	linetype (string &value)

LineBatch &	linetype (int32_t value)

LineBatch &	linetype (LineType value)

LineBatch &	linetype (strings &value)

LineBatch &	linetype (std::vector< int32_t > &value)

LineBatch &	linetype (std::vector< LineType > &value)

strings	linetype_str ()
	Code designating the type of line. More...

LineBatch &	linetype_str (string &value)

LineBatch &	linetype_str (strings &value)

BatchFloat64ArrayProxy	normamps ()
	Normal rated current. More...

LineBatch &	normamps (double value)

template<typename T >
LineBatch &	normamps (T &value)

template<typename T >
LineBatch &	normamps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	emergamps ()
	Maximum or emerg current. More...

LineBatch &	emergamps (double value)

template<typename T >
LineBatch &	emergamps (T &value)

template<typename T >
LineBatch &	emergamps (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	faultrate ()
	Failure rate PER UNIT LENGTH per year. More...

LineBatch &	faultrate (double value)

template<typename T >
LineBatch &	faultrate (T &value)

template<typename T >
LineBatch &	faultrate (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctperm ()
	Percent of failures that become permanent. More...

LineBatch &	pctperm (double value)

template<typename T >
LineBatch &	pctperm (T &value)

template<typename T >
LineBatch &	pctperm (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	repair ()
	Hours to repair. More...

LineBatch &	repair (double value)

template<typename T >
LineBatch &	repair (T &value)

template<typename T >
LineBatch &	repair (typename T::iterator it_begin, typename T::iterator it_end)

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

LineBatch &	basefreq (double value)

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

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

LineBatch &	enabled (bool value)

LineBatch &	enabled (bools &value)

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

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

◆ B0()

BatchFloat64ArrayProxy dss::obj::LineBatch::B0 ( )

inline

Alternate way to specify C0.

MicroS per unit length

DSS property name: B0, DSS property index: 27

◆ B1()

BatchFloat64ArrayProxy dss::obj::LineBatch::B1 ( )

inline

Alternate way to specify C1.

MicroS per unit length

DSS property name: B1, DSS property index: 26

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::LineBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 36

◆ bus1()

strings dss::obj::LineBatch::bus1 ( )

inline

Name of bus to which first terminal is connected.

Example: bus1=busname (assumes all terminals connected in normal phase order) bus1=busname.3.1.2.0 (specify terminal to node connections explicitly)

DSS property name: bus1, DSS property index: 1

◆ bus2()

strings dss::obj::LineBatch::bus2 ( )

inline

Name of bus to which 2nd terminal is connected.

DSS property name: bus2, DSS property index: 2

◆ C0()

BatchFloat64ArrayProxy dss::obj::LineBatch::C0 ( )

inline

Zero-sequence capacitance, nf per unit length.

Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.See also B0.

DSS property name: C0, DSS property index: 11

◆ C1()

BatchFloat64ArrayProxy dss::obj::LineBatch::C1 ( )

inline

Positive-sequence capacitance, nf per unit length.

Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Cmatrix and B1.

DSS property name: C1, DSS property index: 10

◆ cmatrix()

std::vector< VectorXd > dss::obj::LineBatch::cmatrix ( )

inline

Nodal Capacitance matrix, lower triangle, nf per unit length.Order of the matrix is the number of phases.

May be used to specify the shunt capacitance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: cmatrix, DSS property index: 14

◆ cncables()

std::vector< strings > dss::obj::LineBatch::cncables ( )

inline

Array of CNData names for use in a cable constants calculation.

Must be used in conjunction with the Spacing property. Specify the Spacing first, using "nphases" cncables. You may later specify "nconds-nphases" wires for separate neutrals

DSS property name: cncables, DSS property index: 24

◆ cncables_obj()

std::vector< std::vector< dss::obj::CNData > > dss::obj::LineBatch::cncables_obj ( )

inline

Array of CNData names for use in a cable constants calculation.

Must be used in conjunction with the Spacing property. Specify the Spacing first, using "nphases" cncables. You may later specify "nconds-nphases" wires for separate neutrals

DSS property name: cncables, DSS property index: 24

◆ earthmodel()

BatchInt32ArrayProxy dss::obj::LineBatch::earthmodel ( )

inline

One of {Carson | FullCarson | Deri}.

Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the "geometry" property is used.

DSS property name: EarthModel, DSS property index: 23

◆ earthmodel_str()

strings dss::obj::LineBatch::earthmodel_str ( )

inline

One of {Carson | FullCarson | Deri}.

Default is the global value established with the Set EarthModel command. See the Options Help on EarthModel option. This is used to override the global value for this line. This option applies only when the "geometry" property is used.

DSS property name: EarthModel, DSS property index: 23

◆ emergamps()

BatchFloat64ArrayProxy dss::obj::LineBatch::emergamps ( )

inline

Maximum or emerg current.

DSS property name: emergamps, DSS property index: 32

◆ enabled()

bools dss::obj::LineBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 37

◆ faultrate()

BatchFloat64ArrayProxy dss::obj::LineBatch::faultrate ( )

inline

Failure rate PER UNIT LENGTH per year.

Length must be same units as LENGTH property. Default is 0.1 fault per unit length per year.

DSS property name: faultrate, DSS property index: 33

◆ geometry()

strings dss::obj::LineBatch::geometry ( )

inline

Geometry code for LineGeometry Object.

Supercedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: geometry, DSS property index: 19

◆ geometry_obj()

std::vector< dss::obj::LineGeometry > dss::obj::LineBatch::geometry_obj ( )

inline

Geometry code for LineGeometry Object.

Supercedes any previous definition of line impedance. Line constants are computed for each frequency change or rho change. CAUTION: may alter number of phases. You cannot subsequently change the number of phases unless you change how the line impedance is defined.

DSS property name: geometry, DSS property index: 19

◆ length()

BatchFloat64ArrayProxy dss::obj::LineBatch::length ( )

inline

Length of line.

Default is 1.0. If units do not match the impedance data, specify "units" property.

DSS property name: length, DSS property index: 4

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 38

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 38

◆ linecode()

strings dss::obj::LineBatch::linecode ( )

inline

Name of linecode object describing line impedances.

If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: linecode, DSS property index: 3

◆ linecode_obj()

std::vector< dss::obj::LineCode > dss::obj::LineBatch::linecode_obj ( )

inline

Name of linecode object describing line impedances.

If you use a line code, you do not need to specify the impedances here. The line code must have been PREVIOUSLY defined. The values specified last will prevail over those specified earlier (left-to-right sequence of properties). You can subsequently change the number of phases if symmetrical component quantities are specified.If no line code or impedance data are specified, the line object defaults to 336 MCM ACSR on 4 ft spacing.

DSS property name: linecode, DSS property index: 3

◆ linetype()

BatchInt32ArrayProxy dss::obj::LineBatch::linetype ( )

inline

Code designating the type of line.

One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30

◆ linetype_str()

strings dss::obj::LineBatch::linetype_str ( )

inline

Code designating the type of line.

One of: OH, UG, UG_TS, UG_CN, SWT_LDBRK, SWT_FUSE, SWT_SECT, SWT_REC, SWT_DISC, SWT_BRK, SWT_ELBOW

OpenDSS currently does not use this internally. For whatever purpose the user defines. Default is OH.

DSS property name: LineType, DSS property index: 30

◆ normamps()

BatchFloat64ArrayProxy dss::obj::LineBatch::normamps ( )

inline

Normal rated current.

DSS property name: normamps, DSS property index: 31

◆ pctperm()

BatchFloat64ArrayProxy dss::obj::LineBatch::pctperm ( )

inline

Percent of failures that become permanent.

Default is 20.

DSS property name: pctperm, DSS property index: 34

◆ phases()

BatchInt32ArrayProxy dss::obj::LineBatch::phases ( )

inline

Number of phases, this line.

DSS property name: phases, DSS property index: 5

◆ r0()

BatchFloat64ArrayProxy dss::obj::LineBatch::r0 ( )

inline

Zero-sequence Resistance, ohms per unit length.

Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: r0, DSS property index: 8

◆ r1()

BatchFloat64ArrayProxy dss::obj::LineBatch::r1 ( )

inline

Positive-sequence Resistance, ohms per unit length.

Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Rmatrix.

DSS property name: r1, DSS property index: 6

◆ Ratings()

std::vector< VectorXd > dss::obj::LineBatch::Ratings ( )

inline

An array of ratings to be used when the seasonal ratings flag is True.

It can be used to insert multiple ratings to change during a QSTS simulation to evaluate different ratings in lines.

DSS property name: Ratings, DSS property index: 29

◆ repair()

BatchFloat64ArrayProxy dss::obj::LineBatch::repair ( )

inline

Hours to repair.

Default is 3 hr.

DSS property name: repair, DSS property index: 35

◆ Rg()

BatchFloat64ArrayProxy dss::obj::LineBatch::Rg ( )

inline

Carson earth return resistance per unit length used to compute impedance values at base frequency.

Default is 0.01805 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Rg, DSS property index: 16

◆ rho()

BatchFloat64ArrayProxy dss::obj::LineBatch::rho ( )

inline

Default=100 meter ohms.

Earth resitivity used to compute earth correction factor. Overrides Line geometry definition if specified.

DSS property name: rho, DSS property index: 18

◆ rmatrix()

std::vector< VectorXd > dss::obj::LineBatch::rmatrix ( )

inline

Resistance matrix, lower triangle, ohms per unit length.

Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: rmatrix, DSS property index: 12

◆ Seasons()

BatchInt32ArrayProxy dss::obj::LineBatch::Seasons ( )

inline

Defines the number of ratings to be defined for the wire, to be used only when defining seasonal ratings using the "Ratings" property.

DSS property name: Seasons, DSS property index: 28

◆ spacing()

strings dss::obj::LineBatch::spacing ( )

inline

Reference to a LineSpacing for use in a line constants calculation.

Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: spacing, DSS property index: 21

◆ spacing_obj()

std::vector< dss::obj::LineSpacing > dss::obj::LineBatch::spacing_obj ( )

inline

Reference to a LineSpacing for use in a line constants calculation.

Must be used in conjunction with the Wires property. Specify this before the wires property.

DSS property name: spacing, DSS property index: 21

◆ Switch()

bools dss::obj::LineBatch::Switch ( )

inline

{y/n | T/F} Default= no/false.

Designates this line as a switch for graphics and algorithmic purposes. SIDE EFFECT: Sets r1 = 1.0; x1 = 1.0; r0 = 1.0; x0 = 1.0; c1 = 1.1 ; c0 = 1.0; length = 0.001; You must reset if you want something different.

DSS property name: Switch, DSS property index: 15

◆ tscables()

std::vector< strings > dss::obj::LineBatch::tscables ( )

inline

Array of TSData names for use in a cable constants calculation.

Must be used in conjunction with the Spacing property. Specify the Spacing first, using "nphases" tscables. You may later specify "nconds-nphases" wires for separate neutrals

DSS property name: tscables, DSS property index: 25

◆ tscables_obj()

std::vector< std::vector< dss::obj::TSData > > dss::obj::LineBatch::tscables_obj ( )

inline

Array of TSData names for use in a cable constants calculation.

Must be used in conjunction with the Spacing property. Specify the Spacing first, using "nphases" tscables. You may later specify "nconds-nphases" wires for separate neutrals

DSS property name: tscables, DSS property index: 25

◆ units()

BatchInt32ArrayProxy dss::obj::LineBatch::units ( )

inline

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: units, DSS property index: 20

◆ units_str()

strings dss::obj::LineBatch::units_str ( )

inline

Length Units = {none | mi|kft|km|m|Ft|in|cm } Default is None - assumes length units match impedance units.

DSS property name: units, DSS property index: 20

◆ wires()

std::vector< strings > dss::obj::LineBatch::wires ( )

inline

Array of WireData names for use in an overhead line constants calculation.

Must be used in conjunction with the Spacing property. Specify the Spacing first, and "ncond" wires. May also be used to specify bare neutrals with cables, using "ncond-nphase" wires.

DSS property name: wires, DSS property index: 22

◆ wires_obj()

std::vector< std::vector< dss::obj::WireData > > dss::obj::LineBatch::wires_obj ( )

inline

Array of WireData names for use in an overhead line constants calculation.

Must be used in conjunction with the Spacing property. Specify the Spacing first, and "ncond" wires. May also be used to specify bare neutrals with cables, using "ncond-nphase" wires.

DSS property name: wires, DSS property index: 22

◆ x0()

BatchFloat64ArrayProxy dss::obj::LineBatch::x0 ( )

inline

Zero-sequence Reactance, ohms per unit length.

Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition.

DSS property name: x0, DSS property index: 9

◆ x1()

BatchFloat64ArrayProxy dss::obj::LineBatch::x1 ( )

inline

Positive-sequence Reactance, ohms per unit length.

Setting any of R1, R0, X1, X0, C1, C0 forces the program to use the symmetrical component line definition. See also Xmatrix

DSS property name: x1, DSS property index: 7

◆ Xg()

BatchFloat64ArrayProxy dss::obj::LineBatch::Xg ( )

inline

Carson earth return reactance per unit length used to compute impedance values at base frequency.

For making better frequency adjustments. Default is 0.155081 = 60 Hz value in ohms per kft (matches default line impedances). This value is required for harmonic solutions if you wish to adjust the earth return impedances for frequency. If not, set both Rg and Xg = 0.

DSS property name: Xg, DSS property index: 17

◆ xmatrix()

std::vector< VectorXd > dss::obj::LineBatch::xmatrix ( )

inline

Reactance matrix, lower triangle, ohms per unit length.

Order of the matrix is the number of phases. May be used to specify the impedance of any line configuration. Using any of Rmatrix, Xmatrix, Cmatrix forces program to use the matrix values for line impedance definition. For balanced line models, you may use the standard symmetrical component data definition instead.

DSS property name: xmatrix, DSS property index: 13

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

◆ B0()

◆ B1()

◆ basefreq()

◆ bus1()

◆ bus2()

◆ C0()

◆ C1()

◆ cmatrix()

◆ cncables()

◆ cncables_obj()

◆ earthmodel()

◆ earthmodel_str()

◆ emergamps()

◆ enabled()

◆ faultrate()

◆ geometry()

◆ geometry_obj()

◆ length()

◆ like() [1/2]

◆ like() [2/2]

◆ linecode()

◆ linecode_obj()

◆ linetype()

◆ linetype_str()

◆ normamps()

◆ pctperm()

◆ phases()

◆ r0()

◆ r1()

◆ Ratings()

◆ repair()

◆ Rg()

◆ rho()

◆ rmatrix()

◆ Seasons()

◆ spacing()

◆ spacing_obj()

◆ Switch()

◆ tscables()

◆ tscables_obj()

◆ units()

◆ units_str()

◆ wires()

◆ wires_obj()

◆ x0()

◆ x1()

◆ Xg()

◆ xmatrix()