Inheritance diagram for dss::obj::WireData:

Collaboration diagram for dss::obj::WireData:

Classes
struct	Properties

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

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

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

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

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

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

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

WireData &	Rdc (double value)

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

WireData &	Rac (double value)

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

WireData &	Runits (int32_t value)

WireData &	Runits (DimensionUnits value)

WireData &	Runits (const string &value)

WireData &	Runits (const char *value)

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

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

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

WireData &	GMRac (double value)

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

WireData &	GMRunits (int32_t value)

WireData &	GMRunits (DimensionUnits value)

WireData &	GMRunits (const string &value)

WireData &	GMRunits (const char *value)

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

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

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

WireData &	radius (double value)

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

WireData &	radunits (int32_t value)

WireData &	radunits (DimensionUnits value)

WireData &	radunits (const string &value)

WireData &	radunits (const char *value)

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

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

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

WireData &	normamps (double value)

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

WireData &	emergamps (double value)

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

WireData &	diam (double 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...

WireData &	Seasons (int32_t value)

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

WireData &	Ratings (VectorXd &value)

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

WireData &	Capradius (double value)

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

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

static const int32_t	dss_cls_idx = 9

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

WireData & dss::obj::WireData::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ Capradius()

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

double dss::obj::WireData::diam ( )

inline

Diameter; Alternative method for entering radius.

DSS property name: diam, DSS property index: 10

◆ emergamps()

double dss::obj::WireData::emergamps ( )

inline

Emergency ampacity, amperes.

Defaults to 1.5 * Normal Amps if not specified.

DSS property name: emergamps, DSS property index: 9

◆ end_edit()

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

◆ GMRac()

double dss::obj::WireData::GMRac ( )

inline

GMR at 60 Hz.

Defaults to .7788*radius if not specified.

DSS property name: GMRac, DSS property index: 4

◆ GMRunits()

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

string dss::obj::WireData::GMRunits_str ( )

inline

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

DSS property name: GMRunits, DSS property index: 5

◆ GMRunits_str() [2/2]

WireData & dss::obj::WireData::GMRunits_str ( const string & value )

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]

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

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

double dss::obj::WireData::normamps ( )

inline

Normal ampacity, amperes.

Defaults to Emergency amps/1.5 if not specified.

DSS property name: normamps, DSS property index: 8

◆ Rac()

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

double dss::obj::WireData::radius ( )

inline

Outside radius of conductor.

Defaults to GMR/0.7788 if not specified.

DSS property name: radius, DSS property index: 6

◆ radunits()

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

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

◆ radunits_str() [2/2]

WireData & dss::obj::WireData::radunits_str ( const string & value )

inline

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

DSS property name: radunits, DSS property index: 7

◆ Ratings()

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

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

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

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

◆ Runits_str() [2/2]

WireData & dss::obj::WireData::Runits_str ( const string & value )

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

int32_t dss::obj::WireData::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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ begin_edit()

◆ Capradius()

◆ diam()

◆ emergamps()

◆ end_edit()

◆ GMRac()

◆ GMRunits()

◆ GMRunits_str() [1/2]

◆ GMRunits_str() [2/2]

◆ like() [1/2]

◆ like() [2/2]

◆ normamps()

◆ Rac()

◆ radius()

◆ radunits()

◆ radunits_str() [1/2]

◆ radunits_str() [2/2]

◆ Ratings()

◆ Rdc()

◆ Runits()

◆ Runits_str() [1/2]

◆ Runits_str() [2/2]

◆ Seasons()