dss::classic::ILines Class Reference

Inheritance diagram for dss::classic::ILines:

Collaboration diagram for dss::classic::ILines:

Public Member Functions
	ILines (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Line names in the circuit.
int32_t	Count ()
	Number of Line objects in active circuit.
int32_t	First ()
	Sets the first Line active. More...
string	Name ()
	Get the name of the current active Line.
ILines &	Name (const char *value)
	Sets the active Line by Name.
ILines &	Name (const string &value)
int32_t	Next ()
	Sets the next Line active. More...
int32_t	idx ()
	Get active Line by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Line by index; index is 1-based: 1..count.
int32_t	New (const char *Name)
int32_t	New (const string &Name)
string	Bus1 ()
	Name of bus for terminal 1.
ILines &	Bus1 (const char *value)
ILines &	Bus1 (const string &value)
string	Bus2 ()
	Name of bus for terminal 2.
ILines &	Bus2 (const char *value)
ILines &	Bus2 (const string &value)
double	C0 ()
	Zero Sequence capacitance, nanofarads per unit length.
ILines &	C0 (double value)
double	C1 ()
	Positive Sequence capacitance, nanofarads per unit length.
ILines &	C1 (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Cmatrix ()
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILines &	Cmatrix (const VectorT &value)
double	EmergAmps ()
	Emergency (maximum) ampere rating of Line.
ILines &	EmergAmps (double value)
string	Geometry ()
	Line geometry code.
ILines &	Geometry (const char *value)
ILines &	Geometry (const string &value)
double	Length ()
	Length of line section in units compatible with the LineCode definition.
ILines &	Length (double value)
string	LineCode ()
	Name of LineCode object that defines the impedances.
ILines &	LineCode (const char *value)
ILines &	LineCode (const string &value)
double	NormAmps ()
	Normal ampere rating of Line.
ILines &	NormAmps (double value)
int32_t	NumCust ()
	Number of customers on this line section.
int32_t	Parent ()
	Sets Parent of the active Line to be the active line. More...
int32_t	Phases ()
	Number of Phases, this Line element.
ILines &	Phases (int32_t value)
double	R0 ()
	Zero Sequence resistance, ohms per unit length.
ILines &	R0 (double value)
double	R1 ()
	Positive Sequence resistance, ohms per unit length.
ILines &	R1 (double value)
double	Rg ()
	Earth return resistance value used to compute line impedances at power frequency.
ILines &	Rg (double value)
double	Rho ()
	Earth Resistivity, m-ohms.
ILines &	Rho (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Rmatrix ()
	Resistance matrix (full), ohms per unit length. More...
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILines &	Rmatrix (const VectorT &value)
string	Spacing ()
	Line spacing code.
ILines &	Spacing (const char *value)
ILines &	Spacing (const string &value)
int32_t	TotalCust ()
	Total Number of customers served from this line section.
int32_t	Units ()
ILines &	Units (int32_t value)
double	X0 ()
	Zero Sequence reactance ohms per unit length.
ILines &	X0 (double value)
double	X1 ()
	Positive Sequence reactance, ohms per unit length.
ILines &	X1 (double value)
double	Xg ()
	Earth return reactance value used to compute line impedances at power frequency.
ILines &	Xg (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Xmatrix ()
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILines &	Xmatrix (const VectorT &value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Yprim ()
	Yprimitive: Does Nothing at present on Put; Dangerous.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ILines &	Yprim (const VectorT &value)
double	SeasonRating ()
	Delivers the rating for the current season (in Amps) if the "SeasonalRatings" option is active.
bool	IsSwitch ()
	Sets/gets the Line element switch status. More...
ILines &	IsSwitch (bool value)
Public Member Functions inherited from dss::ContextState
	ContextState (APIUtil *util)

Additional Inherited Members
Public Attributes inherited from dss::ContextState
void *	ctx
	Pointer to the DSSContext for easy access.
APIUtil *	api_util
	API utility functions.

Member Function Documentation

First()

int32_t dss::classic::ILines::First ( )

inline

Sets the first Line active.

Returns 0 if no more.

IsSwitch()

bool dss::classic::ILines::IsSwitch ( )

inline

Sets/gets the Line element switch status.

Setting it has side-effects to the line parameters.

Next()

int32_t dss::classic::ILines::Next ( )

inline

Sets the next Line active.

Returns 0 if no more.

Parent()

int32_t dss::classic::ILines::Parent ( )

inline

Sets Parent of the active Line to be the active line.

Returns 0 if no parent or action fails.

Rmatrix()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>

VectorT dss::classic::ILines::Rmatrix ( )

inline

Resistance matrix (full), ohms per unit length.

Array of doubles.

---

The documentation for this class was generated from the following file:

• include/dss_classic.hpp