Inheritance diagram for dss::obj::LineGeometryBatch:

Collaboration diagram for dss::obj::LineGeometryBatch:

Public Types
typedef LineGeometry::Properties	Properties

typedef LineGeometry	BatchElementClass

Public Member Functions
	LineGeometryBatch (APIUtil *util)
	Create a batch of all LineGeometry elements.

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

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

LineGeometryBatch &	begin_edit ()

LineGeometryBatch &	end_edit (int32_t num_edits=1)

BatchInt32ArrayProxy	nconds ()
	Number of conductors in this geometry. More...

LineGeometryBatch &	nconds (int32_t value)

template<typename T >
LineGeometryBatch &	nconds (T &value)

template<typename T >
LineGeometryBatch &	nconds (typename T::iterator it_begin, typename T::iterator it_end)

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

LineGeometryBatch &	nphases (int32_t value)

template<typename T >
LineGeometryBatch &	nphases (T &value)

template<typename T >
LineGeometryBatch &	nphases (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	cond ()
	Set this = number of the conductor you wish to define. More...

LineGeometryBatch &	cond (int32_t value)

template<typename T >
LineGeometryBatch &	cond (T &value)

template<typename T >
LineGeometryBatch &	cond (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< strings >	wire ()
	Code from WireData. More...

LineGeometryBatch &	wire (strings &value)

LineGeometryBatch &	wire (std::vector< dss::obj::WireData > &value)

LineGeometryBatch &	wire (std::vector< strings > &value)

LineGeometryBatch &	wire (std::vector< std::vector< dss::obj::WireData > > &value)

std::vector< std::vector< dss::obj::WireData > >	wire_obj ()
	Code from WireData. More...

LineGeometryBatch &	wire_obj (std::vector< dss::obj::WireData > &value)

LineGeometryBatch &	wire_obj (std::vector< std::vector< dss::obj::WireData > > &value)

std::vector< VectorXd >	x ()
	x coordinate. More...

LineGeometryBatch &	x (VectorXd &value)

std::vector< VectorXd >	h ()
	Height of conductor. More...

LineGeometryBatch &	h (VectorXd &value)

BatchInt32ArrayProxy	units ()
	Units for x and h: {mi\|kft\|km\|m\|Ft\|in\|cm } Initial default is "ft", but defaults to last unit defined. More...

LineGeometryBatch &	units (string &value)

LineGeometryBatch &	units (int32_t value)

LineGeometryBatch &	units (DimensionUnits value)

LineGeometryBatch &	units (strings &value)

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

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

strings	units_str ()
	Units for x and h: {mi\|kft\|km\|m\|Ft\|in\|cm } Initial default is "ft", but defaults to last unit defined. More...

LineGeometryBatch &	units_str (string &value)

LineGeometryBatch &	units_str (strings &value)

BatchFloat64ArrayProxy	normamps ()
	Normal ampacity, amperes for the line. More...

LineGeometryBatch &	normamps (double value)

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

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

BatchFloat64ArrayProxy	emergamps ()
	Emergency ampacity, amperes. More...

LineGeometryBatch &	emergamps (double value)

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

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

bools	reduce ()
	{Yes \| No} Default = no. More...

LineGeometryBatch &	reduce (bool value)

LineGeometryBatch &	reduce (bools &value)

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

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

LineGeometryBatch &	spacing (const string &value)

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

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

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

LineGeometryBatch &	wires (strings &value)

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

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

LineGeometryBatch &	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 a line constants calculation. More...

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

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

std::vector< strings >	cncable ()
	Code from CNData. More...

LineGeometryBatch &	cncable (strings &value)

LineGeometryBatch &	cncable (std::vector< dss::obj::CNData > &value)

LineGeometryBatch &	cncable (std::vector< strings > &value)

LineGeometryBatch &	cncable (std::vector< std::vector< dss::obj::CNData > > &value)

std::vector< std::vector< dss::obj::CNData > >	cncable_obj ()
	Code from CNData. More...

LineGeometryBatch &	cncable_obj (std::vector< dss::obj::CNData > &value)

LineGeometryBatch &	cncable_obj (std::vector< std::vector< dss::obj::CNData > > &value)

std::vector< strings >	tscable ()
	Code from TSData. More...

LineGeometryBatch &	tscable (strings &value)

LineGeometryBatch &	tscable (std::vector< dss::obj::TSData > &value)

LineGeometryBatch &	tscable (std::vector< strings > &value)

LineGeometryBatch &	tscable (std::vector< std::vector< dss::obj::TSData > > &value)

std::vector< std::vector< dss::obj::TSData > >	tscable_obj ()
	Code from TSData. More...

LineGeometryBatch &	tscable_obj (std::vector< dss::obj::TSData > &value)

LineGeometryBatch &	tscable_obj (std::vector< std::vector< dss::obj::TSData > > &value)

std::vector< strings >	cncables ()
	Array of CNData names for cable parameter calculation. More...

LineGeometryBatch &	cncables (strings &value)

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

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

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

std::vector< std::vector< dss::obj::CNData > >	cncables_obj ()
	Array of CNData names for cable parameter calculation. More...

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

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

std::vector< strings >	tscables ()
	Array of TSData names for cable parameter calculation. More...

LineGeometryBatch &	tscables (strings &value)

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

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

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

std::vector< std::vector< dss::obj::TSData > >	tscables_obj ()
	Array of TSData names for cable parameter calculation. More...

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

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

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...

LineGeometryBatch &	Seasons (int32_t value)

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

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

LineGeometryBatch &	Ratings (VectorXd &value)

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

LineGeometryBatch &	linetype (string &value)

LineGeometryBatch &	linetype (int32_t value)

LineGeometryBatch &	linetype (LineType value)

LineGeometryBatch &	linetype (strings &value)

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

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

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

LineGeometryBatch &	linetype_str (string &value)

LineGeometryBatch &	linetype_str (strings &value)

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

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

◆ cncable()

std::vector< strings > dss::obj::LineGeometryBatch::cncable ( )

inline

Code from CNData.

MUST BE PREVIOUSLY DEFINED. no default. Specifies use of Concentric Neutral cable parameter calculation.

DSS property name: cncable, DSS property index: 13

◆ cncable_obj()

std::vector< std::vector< dss::obj::CNData > > dss::obj::LineGeometryBatch::cncable_obj ( )

inline

Code from CNData.

MUST BE PREVIOUSLY DEFINED. no default. Specifies use of Concentric Neutral cable parameter calculation.

DSS property name: cncable, DSS property index: 13

◆ cncables()

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

inline

Array of CNData names for cable parameter calculation.

All must be previously defined, and match "nphases" for this geometry. You can later define "nconds-nphases" wires for bare neutral conductors.

DSS property name: cncables, DSS property index: 15

◆ cncables_obj()

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

inline

Array of CNData names for cable parameter calculation.

All must be previously defined, and match "nphases" for this geometry. You can later define "nconds-nphases" wires for bare neutral conductors.

DSS property name: cncables, DSS property index: 15

◆ cond()

BatchInt32ArrayProxy dss::obj::LineGeometryBatch::cond ( )

inline

Set this = number of the conductor you wish to define.

Default is 1.

DSS property name: cond, DSS property index: 3

◆ emergamps()

BatchFloat64ArrayProxy dss::obj::LineGeometryBatch::emergamps ( )

inline

Emergency ampacity, amperes.

Defaults to first conductor if not specified.

DSS property name: emergamps, DSS property index: 9

◆ h()

std::vector< VectorXd > dss::obj::LineGeometryBatch::h ( )

inline

Height of conductor.

DSS property name: h, DSS property index: 6

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 20

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 20

◆ linetype()

BatchInt32ArrayProxy dss::obj::LineGeometryBatch::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: 19

◆ linetype_str()

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

◆ nconds()

BatchInt32ArrayProxy dss::obj::LineGeometryBatch::nconds ( )

inline

Number of conductors in this geometry.

Default is 3. Triggers memory allocations. Define first!

DSS property name: nconds, DSS property index: 1

◆ normamps()

BatchFloat64ArrayProxy dss::obj::LineGeometryBatch::normamps ( )

inline

Normal ampacity, amperes for the line.

Defaults to first conductor if not specified.

DSS property name: normamps, DSS property index: 8

◆ nphases()

BatchInt32ArrayProxy dss::obj::LineGeometryBatch::nphases ( )

inline

Number of phases.

Default =3; All other conductors are considered neutrals and might be reduced out.

DSS property name: nphases, DSS property index: 2

◆ Ratings()

std::vector< VectorXd > dss::obj::LineGeometryBatch::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.Defaults to first conductor if not specified.

DSS property name: Ratings, DSS property index: 18

◆ reduce()

bools dss::obj::LineGeometryBatch::reduce ( )

inline

{Yes | No} Default = no.

Reduce to Nphases (Kron Reduction). Reduce out neutrals.

DSS property name: reduce, DSS property index: 10

◆ Seasons()

BatchInt32ArrayProxy dss::obj::LineGeometryBatch::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.

Defaults to first conductor if not specified.

DSS property name: Seasons, DSS property index: 17

◆ spacing()

strings dss::obj::LineGeometryBatch::spacing ( )

inline

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

Alternative to x, h, and units. MUST BE PREVIOUSLY DEFINED. Must match "nconds" as previously defined for this geometry. Must be used in conjunction with the Wires property.

DSS property name: spacing, DSS property index: 11

◆ spacing_obj()

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

inline

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

Alternative to x, h, and units. MUST BE PREVIOUSLY DEFINED. Must match "nconds" as previously defined for this geometry. Must be used in conjunction with the Wires property.

DSS property name: spacing, DSS property index: 11

◆ tscable()

std::vector< strings > dss::obj::LineGeometryBatch::tscable ( )

inline

Code from TSData.

MUST BE PREVIOUSLY DEFINED. no default. Specifies use of Tape Shield cable parameter calculation.

DSS property name: tscable, DSS property index: 14

◆ tscable_obj()

std::vector< std::vector< dss::obj::TSData > > dss::obj::LineGeometryBatch::tscable_obj ( )

inline

Code from TSData.

MUST BE PREVIOUSLY DEFINED. no default. Specifies use of Tape Shield cable parameter calculation.

DSS property name: tscable, DSS property index: 14

◆ tscables()

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

inline

Array of TSData names for cable parameter calculation.

All must be previously defined, and match "nphases" for this geometry. You can later define "nconds-nphases" wires for bare neutral conductors.

DSS property name: tscables, DSS property index: 16

◆ tscables_obj()

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

inline

Array of TSData names for cable parameter calculation.

All must be previously defined, and match "nphases" for this geometry. You can later define "nconds-nphases" wires for bare neutral conductors.

DSS property name: tscables, DSS property index: 16

◆ units()

BatchInt32ArrayProxy dss::obj::LineGeometryBatch::units ( )

inline

Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined.

DSS property name: units, DSS property index: 7

◆ units_str()

strings dss::obj::LineGeometryBatch::units_str ( )

inline

Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined.

DSS property name: units, DSS property index: 7

◆ wire()

std::vector< strings > dss::obj::LineGeometryBatch::wire ( )

inline

Code from WireData.

MUST BE PREVIOUSLY DEFINED. no default. Specifies use of Overhead Line parameter calculation, Unless Tape Shield cable previously assigned to phases, and this wire is a neutral.

DSS property name: wire, DSS property index: 4

◆ wire_obj()

std::vector< std::vector< dss::obj::WireData > > dss::obj::LineGeometryBatch::wire_obj ( )

inline

Code from WireData.

MUST BE PREVIOUSLY DEFINED. no default. Specifies use of Overhead Line parameter calculation, Unless Tape Shield cable previously assigned to phases, and this wire is a neutral.

DSS property name: wire, DSS property index: 4

◆ wires()

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

inline

Array of WireData names for use in a line constants calculation.

Alternative to individual wire inputs. ALL MUST BE PREVIOUSLY DEFINED. Must match "nconds" as previously defined for this geometry, unless TSData or CNData were previously assigned to phases, and these wires are neutrals. Must be used in conjunction with the Spacing property.

DSS property name: wires, DSS property index: 12

◆ wires_obj()

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

inline

Array of WireData names for use in a line constants calculation.

Alternative to individual wire inputs. ALL MUST BE PREVIOUSLY DEFINED. Must match "nconds" as previously defined for this geometry, unless TSData or CNData were previously assigned to phases, and these wires are neutrals. Must be used in conjunction with the Spacing property.

DSS property name: wires, DSS property index: 12

◆ x()

std::vector< VectorXd > dss::obj::LineGeometryBatch::x ( )

inline

x coordinate.

DSS property name: x, DSS property index: 5

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

◆ cncable()

◆ cncable_obj()

◆ cncables()

◆ cncables_obj()

◆ cond()

◆ emergamps()

◆ h()

◆ like() [1/2]

◆ like() [2/2]

◆ linetype()

◆ linetype_str()

◆ nconds()

◆ normamps()

◆ nphases()

◆ Ratings()

◆ reduce()

◆ Seasons()

◆ spacing()

◆ spacing_obj()

◆ tscable()

◆ tscable_obj()

◆ tscables()

◆ tscables_obj()

◆ units()

◆ units_str()

◆ wire()

◆ wire_obj()

◆ wires()

◆ wires_obj()

◆ x()