Inheritance diagram for dss::obj::LineGeometry:

Collaboration diagram for dss::obj::LineGeometry:

Classes
struct	Properties

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

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

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

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

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

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

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

LineGeometry &	nconds (int32_t value)

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

LineGeometry &	nphases (int32_t value)

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

LineGeometry &	cond (int32_t value)

strings	wire ()
	Code from WireData. More...

LineGeometry &	wire (strings &value)

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

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

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

VectorXd	x ()
	x coordinate. More...

LineGeometry &	x (VectorXd &value)

VectorXd	h ()
	Height of conductor. More...

LineGeometry &	h (VectorXd &value)

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

LineGeometry &	units (int32_t value)

LineGeometry &	units (DimensionUnits value)

LineGeometry &	units (const string &value)

LineGeometry &	units (const char *value)

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

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

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

LineGeometry &	normamps (double value)

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

LineGeometry &	emergamps (double value)

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

LineGeometry &	reduce (bool value)

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

LineGeometry &	spacing (const string &value)

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

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

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

strings	wires ()
	Array of WireData names for use in a line constants calculation. More...

LineGeometry &	wires (strings &value)

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

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

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

strings	cncable ()
	Code from CNData. More...

LineGeometry &	cncable (strings &value)

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

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

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

strings	tscable ()
	Code from TSData. More...

LineGeometry &	tscable (strings &value)

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

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

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

strings	cncables ()
	Array of CNData names for cable parameter calculation. More...

LineGeometry &	cncables (strings &value)

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

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

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

strings	tscables ()
	Array of TSData names for cable parameter calculation. More...

LineGeometry &	tscables (strings &value)

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

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

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

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

LineGeometry &	Seasons (int32_t value)

VectorXd	Ratings ()
	An array of ratings to be used when the seasonal ratings flag is True. More...

LineGeometry &	Ratings (VectorXd &value)

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

LineGeometry &	linetype (int32_t value)

LineGeometry &	linetype (LineType value)

LineGeometry &	linetype (const string &value)

LineGeometry &	linetype (const char *value)

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

LineGeometry &	linetype_str (const string &value)
	Code designating the type of line. More...

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

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

static const int32_t	dss_cls_idx = 13

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

◆ begin_edit()

LineGeometry & dss::obj::LineGeometry::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ cncable()

strings dss::obj::LineGeometry::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< dss::obj::CNData > dss::obj::LineGeometry::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()

strings dss::obj::LineGeometry::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< dss::obj::CNData > dss::obj::LineGeometry::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()

int32_t dss::obj::LineGeometry::cond ( )

inline

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

Default is 1.

DSS property name: cond, DSS property index: 3

◆ emergamps()

double dss::obj::LineGeometry::emergamps ( )

inline

Emergency ampacity, amperes.

Defaults to first conductor if not specified.

DSS property name: emergamps, DSS property index: 9

◆ end_edit()

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

◆ h()

VectorXd dss::obj::LineGeometry::h ( )

inline

Height of conductor.

DSS property name: h, DSS property index: 6

◆ like() [1/2]

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

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

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

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

◆ linetype_str() [2/2]

LineGeometry & dss::obj::LineGeometry::linetype_str ( const string & value )

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

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

double dss::obj::LineGeometry::normamps ( )

inline

Normal ampacity, amperes for the line.

Defaults to first conductor if not specified.

DSS property name: normamps, DSS property index: 8

◆ nphases()

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

VectorXd dss::obj::LineGeometry::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()

bool dss::obj::LineGeometry::reduce ( )

inline

{Yes | No} Default = no.

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

DSS property name: reduce, DSS property index: 10

◆ Seasons()

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

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

dss::obj::LineSpacing dss::obj::LineGeometry::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()

strings dss::obj::LineGeometry::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< dss::obj::TSData > dss::obj::LineGeometry::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()

strings dss::obj::LineGeometry::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< dss::obj::TSData > dss::obj::LineGeometry::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()

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

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

◆ units_str() [2/2]

LineGeometry & dss::obj::LineGeometry::units_str ( const string & value )

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

strings dss::obj::LineGeometry::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< dss::obj::WireData > dss::obj::LineGeometry::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()

strings dss::obj::LineGeometry::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< dss::obj::WireData > dss::obj::LineGeometry::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()

VectorXd dss::obj::LineGeometry::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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ begin_edit()

◆ cncable()

◆ cncable_obj()

◆ cncables()

◆ cncables_obj()

◆ cond()

◆ emergamps()

◆ end_edit()

◆ h()

◆ like() [1/2]

◆ like() [2/2]

◆ linetype()

◆ linetype_str() [1/2]

◆ linetype_str() [2/2]

◆ nconds()

◆ normamps()

◆ nphases()

◆ Ratings()

◆ reduce()

◆ Seasons()

◆ spacing()

◆ spacing_obj()

◆ tscable()

◆ tscable_obj()

◆ tscables()

◆ tscables_obj()

◆ units()

◆ units_str() [1/2]

◆ units_str() [2/2]

◆ wire()

◆ wire_obj()

◆ wires()

◆ wires_obj()

◆ x()