Inheritance diagram for dss::obj::WireDataBatch:

Collaboration diagram for dss::obj::WireDataBatch:

Public Types
typedef WireData::Properties	Properties

typedef WireData	BatchElementClass

Public Member Functions
	WireDataBatch (APIUtil *util)
	Create a batch of all WireData elements.

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

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

WireDataBatch &	begin_edit ()

WireDataBatch &	end_edit (int32_t num_edits=1)

BatchFloat64ArrayProxy	Rdc ()
	dc Resistance, ohms per unit length (see Runits). More...

WireDataBatch &	Rdc (double value)

template<typename T >
WireDataBatch &	Rdc (T &value)

template<typename T >
WireDataBatch &	Rdc (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Rac ()
	Resistance at 60 Hz per unit length. More...

WireDataBatch &	Rac (double value)

template<typename T >
WireDataBatch &	Rac (T &value)

template<typename T >
WireDataBatch &	Rac (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Runits ()
	Length units for resistance: ohms per {mi\|kft\|km\|m\|Ft\|in\|cm\|mm} Default=none. More...

WireDataBatch &	Runits (string &value)

WireDataBatch &	Runits (int32_t value)

WireDataBatch &	Runits (DimensionUnits value)

WireDataBatch &	Runits (strings &value)

WireDataBatch &	Runits (std::vector< int32_t > &value)

WireDataBatch &	Runits (std::vector< DimensionUnits > &value)

strings	Runits_str ()
	Length units for resistance: ohms per {mi\|kft\|km\|m\|Ft\|in\|cm\|mm} Default=none. More...

WireDataBatch &	Runits_str (string &value)

WireDataBatch &	Runits_str (strings &value)

BatchFloat64ArrayProxy	GMRac ()
	GMR at 60 Hz. More...

WireDataBatch &	GMRac (double value)

template<typename T >
WireDataBatch &	GMRac (T &value)

template<typename T >
WireDataBatch &	GMRac (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	GMRunits ()
	Units for GMR: {mi\|kft\|km\|m\|Ft\|in\|cm\|mm} Default=none. More...

WireDataBatch &	GMRunits (string &value)

WireDataBatch &	GMRunits (int32_t value)

WireDataBatch &	GMRunits (DimensionUnits value)

WireDataBatch &	GMRunits (strings &value)

WireDataBatch &	GMRunits (std::vector< int32_t > &value)

WireDataBatch &	GMRunits (std::vector< DimensionUnits > &value)

strings	GMRunits_str ()
	Units for GMR: {mi\|kft\|km\|m\|Ft\|in\|cm\|mm} Default=none. More...

WireDataBatch &	GMRunits_str (string &value)

WireDataBatch &	GMRunits_str (strings &value)

BatchFloat64ArrayProxy	radius ()
	Outside radius of conductor. More...

WireDataBatch &	radius (double value)

template<typename T >
WireDataBatch &	radius (T &value)

template<typename T >
WireDataBatch &	radius (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	radunits ()
	Units for outside radius: {mi\|kft\|km\|m\|Ft\|in\|cm\|mm} Default=none. More...

WireDataBatch &	radunits (string &value)

WireDataBatch &	radunits (int32_t value)

WireDataBatch &	radunits (DimensionUnits value)

WireDataBatch &	radunits (strings &value)

WireDataBatch &	radunits (std::vector< int32_t > &value)

WireDataBatch &	radunits (std::vector< DimensionUnits > &value)

strings	radunits_str ()
	Units for outside radius: {mi\|kft\|km\|m\|Ft\|in\|cm\|mm} Default=none. More...

WireDataBatch &	radunits_str (string &value)

WireDataBatch &	radunits_str (strings &value)

BatchFloat64ArrayProxy	normamps ()
	Normal ampacity, amperes. More...

WireDataBatch &	normamps (double value)

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

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

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

WireDataBatch &	emergamps (double value)

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

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

BatchFloat64ArrayProxy	diam ()
	Diameter; Alternative method for entering radius. More...

WireDataBatch &	diam (double value)

template<typename T >
WireDataBatch &	diam (T &value)

template<typename T >
WireDataBatch &	diam (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...

WireDataBatch &	Seasons (int32_t value)

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

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

WireDataBatch &	Ratings (VectorXd &value)

BatchFloat64ArrayProxy	Capradius ()
	Equivalent conductor radius for capacitance calcs. More...

WireDataBatch &	Capradius (double value)

template<typename T >
WireDataBatch &	Capradius (T &value)

template<typename T >
WireDataBatch &	Capradius (typename T::iterator it_begin, typename T::iterator it_end)

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

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

◆ Capradius()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::Capradius ( )

inline

Equivalent conductor radius for capacitance calcs.

Specify this for bundled conductors. Defaults to same value as radius. Define Diam or Radius property first.

DSS property name: Capradius, DSS property index: 13

◆ diam()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::diam ( )

inline

Diameter; Alternative method for entering radius.

DSS property name: diam, DSS property index: 10

◆ emergamps()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::emergamps ( )

inline

Emergency ampacity, amperes.

Defaults to 1.5 * Normal Amps if not specified.

DSS property name: emergamps, DSS property index: 9

◆ GMRac()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::GMRac ( )

inline

GMR at 60 Hz.

Defaults to .7788*radius if not specified.

DSS property name: GMRac, DSS property index: 4

◆ GMRunits()

BatchInt32ArrayProxy dss::obj::WireDataBatch::GMRunits ( )

inline

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 5

◆ GMRunits_str()

strings dss::obj::WireDataBatch::GMRunits_str ( )

inline

Units for GMR: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: GMRunits, DSS property index: 5

◆ like() [1/2]

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

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ normamps()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::normamps ( )

inline

Normal ampacity, amperes.

Defaults to Emergency amps/1.5 if not specified.

DSS property name: normamps, DSS property index: 8

◆ Rac()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::Rac ( )

inline

Resistance at 60 Hz per unit length.

Defaults to 1.02*Rdc if not specified.

DSS property name: Rac, DSS property index: 2

◆ radius()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::radius ( )

inline

Outside radius of conductor.

Defaults to GMR/0.7788 if not specified.

DSS property name: radius, DSS property index: 6

◆ radunits()

BatchInt32ArrayProxy dss::obj::WireDataBatch::radunits ( )

inline

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 7

◆ radunits_str()

strings dss::obj::WireDataBatch::radunits_str ( )

inline

Units for outside radius: {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: radunits, DSS property index: 7

◆ Ratings()

std::vector< VectorXd > dss::obj::WireDataBatch::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: 12

◆ Rdc()

BatchFloat64ArrayProxy dss::obj::WireDataBatch::Rdc ( )

inline

dc Resistance, ohms per unit length (see Runits).

Defaults to Rac/1.02 if not specified.

DSS property name: Rdc, DSS property index: 1

◆ Runits()

BatchInt32ArrayProxy dss::obj::WireDataBatch::Runits ( )

inline

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 3

◆ Runits_str()

strings dss::obj::WireDataBatch::Runits_str ( )

inline

Length units for resistance: ohms per {mi|kft|km|m|Ft|in|cm|mm} Default=none.

DSS property name: Runits, DSS property index: 3

◆ Seasons()

BatchInt32ArrayProxy dss::obj::WireDataBatch::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: 11

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

◆ Capradius()

◆ diam()

◆ emergamps()

◆ GMRac()

◆ GMRunits()

◆ GMRunits_str()

◆ like() [1/2]

◆ like() [2/2]

◆ normamps()

◆ Rac()

◆ radius()

◆ radunits()

◆ radunits_str()

◆ Ratings()

◆ Rdc()

◆ Runits()

◆ Runits_str()

◆ Seasons()