Inheritance diagram for dss::classic::IPDElements:

Collaboration diagram for dss::classic::IPDElements:

Public Member Functions
	IPDElements (dss::APIUtil *util)

double	AccumulatedL ()
	accummulated failure rate for this branch on downline

int32_t	Count ()
	Number of PD elements (including disabled elements)

double	FaultRate ()
	Get/Set Number of failures per year. More...

IPDElements &	FaultRate (double value)

int32_t	First ()
	Set the first enabled PD element to be the active element. More...

int32_t	FromTerminal ()
	Number of the terminal of active PD element that is on the "from" side. More...

bool	IsShunt ()
	Boolean indicating of PD element should be treated as a shunt element rather than a series element. More...

double	Lambda ()
	Failure rate for this branch. More...

string	Name ()
	Get/Set name of active PD Element. More...

IPDElements &	Name (const char *value)

IPDElements &	Name (const string &value)

int32_t	Next ()
	Advance to the next PD element in the circuit. More...

int32_t	Numcustomers ()
	Number of customers, this branch.

int32_t	ParentPDElement ()
	Sets the parent PD element to be the active circuit element. More...

double	RepairTime ()
	Average repair time for this element in hours.

IPDElements &	RepairTime (double value)

int32_t	SectionID ()
	Integer ID of the feeder section that this PDElement branch is part of.

double	TotalMiles ()
	Total miles of line from this element to the end of the zone. More...

int32_t	Totalcustomers ()
	Total number of customers from this branch to the end of the zone.

double	pctPermanent ()
	Get/Set percent of faults that are permanent (require repair). More...

IPDElements &	pctPermanent (double value)

strings	AllNames ()
	Array of strings consisting of all PD element names. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllMaxCurrents (bool AllNodes=false)
	Array of doubles with the maximum current across the conductors, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllPctNorm (bool AllNodes=false)
	Array of doubles with the maximum current across the conductors as a percentage of the Normal Ampere Rating, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllPctEmerg (bool AllNodes=false)
	Array of doubles with the maximum current across the conductors as a percentage of the Emergency Ampere Rating, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllCurrents ()
	Complex array of currents for all conductors, all terminals, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllCurrentsMagAng ()
	Complex array (magnitude and angle format) of currents for all conductors, all terminals, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllCplxSeqCurrents ()
	Complex double array of Sequence Currents for all conductors of all terminals, for each PD elements. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllSeqCurrents ()
	Double array of the symmetrical component currents into each 3-phase terminal, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllPowers ()
	Complex array of powers into each conductor of each terminal, for each PD element. More...

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllSeqPowers ()
	Double array of sequence powers into each 3-phase teminal, for each PD element. More...

template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT	AllNumPhases ()
	Integer array listing the number of phases of all PD elements. More...

template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT	AllNumConductors ()
	Integer array listing the number of conductors of all PD elements. More...

template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT	AllNumTerminals ()
	Integer array listing the number of terminals of all PD elements. More...

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

◆ AllCplxSeqCurrents()

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

VectorT dss::classic::IPDElements::AllCplxSeqCurrents ( )

inline

Complex double array of Sequence Currents for all conductors of all terminals, for each PD elements.

(API Extension)

◆ AllCurrents()

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

VectorT dss::classic::IPDElements::AllCurrents ( )

inline

Complex array of currents for all conductors, all terminals, for each PD element.

(API Extension)

◆ AllCurrentsMagAng()

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

VectorT dss::classic::IPDElements::AllCurrentsMagAng ( )

inline

Complex array (magnitude and angle format) of currents for all conductors, all terminals, for each PD element.

(API Extension)

◆ AllMaxCurrents()

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

VectorT dss::classic::IPDElements::AllMaxCurrents ( bool AllNodes = false )

inline

Array of doubles with the maximum current across the conductors, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the "export capacity" command. Pass true to force the analysis to all terminals.

(API Extension)

◆ AllNames()

strings dss::classic::IPDElements::AllNames ( )

inline

Array of strings consisting of all PD element names.

(API Extension)

◆ AllNumConductors()

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

VectorT dss::classic::IPDElements::AllNumConductors ( )

inline

Integer array listing the number of conductors of all PD elements.

(API Extension)

◆ AllNumPhases()

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

VectorT dss::classic::IPDElements::AllNumPhases ( )

inline

Integer array listing the number of phases of all PD elements.

(API Extension)

◆ AllNumTerminals()

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

VectorT dss::classic::IPDElements::AllNumTerminals ( )

inline

Integer array listing the number of terminals of all PD elements.

(API Extension)

◆ AllPctEmerg()

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

VectorT dss::classic::IPDElements::AllPctEmerg ( bool AllNodes = false )

inline

Array of doubles with the maximum current across the conductors as a percentage of the Emergency Ampere Rating, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the "export capacity" command. Pass true to force the analysis to all terminals.

(API Extension)

◆ AllPctNorm()

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

VectorT dss::classic::IPDElements::AllPctNorm ( bool AllNodes = false )

inline

Array of doubles with the maximum current across the conductors as a percentage of the Normal Ampere Rating, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the "export capacity" command. Pass true to force the analysis to all terminals.

(API Extension)

◆ AllPowers()

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

VectorT dss::classic::IPDElements::AllPowers ( )

inline

Complex array of powers into each conductor of each terminal, for each PD element.

(API Extension)

◆ AllSeqCurrents()

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

VectorT dss::classic::IPDElements::AllSeqCurrents ( )

inline

Double array of the symmetrical component currents into each 3-phase terminal, for each PD element.

(API Extension)

◆ AllSeqPowers()

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

VectorT dss::classic::IPDElements::AllSeqPowers ( )

inline

Double array of sequence powers into each 3-phase teminal, for each PD element.

(API Extension)

◆ FaultRate()

double dss::classic::IPDElements::FaultRate ( )

inline

Get/Set Number of failures per year.

For LINE elements: Number of failures per unit length per year.

◆ First()

int32_t dss::classic::IPDElements::First ( )

inline

Set the first enabled PD element to be the active element.

Returns 0 if none found.

◆ FromTerminal()

int32_t dss::classic::IPDElements::FromTerminal ( )

inline

Number of the terminal of active PD element that is on the "from" side.

This is set after the meter zone is determined.

◆ IsShunt()

bool dss::classic::IPDElements::IsShunt ( )

inline

Boolean indicating of PD element should be treated as a shunt element rather than a series element.

Applies to Capacitor and Reactor elements in particular.

◆ Lambda()

double dss::classic::IPDElements::Lambda ( )

inline

Failure rate for this branch.

Faults per year including length of line.

◆ Name()

string dss::classic::IPDElements::Name ( )

inline

Get/Set name of active PD Element.

Returns null string if active element is not PDElement type.

◆ Next()

int32_t dss::classic::IPDElements::Next ( )

inline

Advance to the next PD element in the circuit.

Enabled elements only. Returns 0 when no more elements.

◆ ParentPDElement()

int32_t dss::classic::IPDElements::ParentPDElement ( )

inline

Sets the parent PD element to be the active circuit element.

Returns 0 if no more elements upline.

◆ pctPermanent()

double dss::classic::IPDElements::pctPermanent ( )

inline

Get/Set percent of faults that are permanent (require repair).

Otherwise, fault is assumed to be transient/temporary.

◆ TotalMiles()

double dss::classic::IPDElements::TotalMiles ( )

inline

Total miles of line from this element to the end of the zone.

For recloser siting algorithm.

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

include/dss_classic.hpp

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ AllCplxSeqCurrents()

◆ AllCurrents()

◆ AllCurrentsMagAng()

◆ AllMaxCurrents()

◆ AllNames()

◆ AllNumConductors()

◆ AllNumPhases()

◆ AllNumTerminals()

◆ AllPctEmerg()

◆ AllPctNorm()

◆ AllPowers()

◆ AllSeqCurrents()

◆ AllSeqPowers()

◆ FaultRate()

◆ First()

◆ FromTerminal()

◆ IsShunt()

◆ Lambda()

◆ Name()

◆ Next()

◆ ParentPDElement()

◆ pctPermanent()

◆ TotalMiles()