DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
dss::classic::IBus Class Reference
Inheritance diagram for dss::classic::IBus:
[legend]
Collaboration diagram for dss::classic::IBus:
[legend]

Public Member Functions

 IBus (dss::APIUtil *util)
 
IBusoperator[] (int32_t key)
 
IBusoperator[] (const char *key)
 
IBusoperator[] (const string &key)
 
strings AllPCEatBus ()
 Returns an array with the names of all PCE connected to the active bus.
 
strings AllPDEatBus ()
 Returns an array with the names of all PDE connected to the active bus.
 
int32_t GetUniqueNodeNumber (int32_t StartNumber)
 
bool ZscRefresh ()
 
bool Coorddefined ()
 False=0 else True. More...
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT CplxSeqVoltages ()
 Complex Double array of Sequence Voltages (0, 1, 2) at this Bus.
 
double Cust_Duration ()
 Accumulated customer outage durations.
 
double Cust_Interrupts ()
 Annual number of customer-interruptions from this bus.
 
double Distance ()
 Distance from energymeter (if non-zero)
 
double Int_Duration ()
 Average interruption duration, hr.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Isc ()
 Short circuit currents at bus; Complex Array.
 
double Lambda ()
 Accumulated failure rate downstream from this bus; faults per year.
 
int32_t N_Customers ()
 Total numbers of customers served downline from this bus.
 
double N_interrupts ()
 Number of interruptions this bus per year.
 
string Name ()
 Name of Bus.
 
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT Nodes ()
 Integer Array of Node Numbers defined at the bus in same order as the voltages.
 
int32_t NumNodes ()
 Number of Nodes this bus.
 
int32_t SectionID ()
 Integer ID of the feeder section in which this bus is located.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT SeqVoltages ()
 Double Array of sequence voltages at this bus.
 
double TotalMiles ()
 Total length of line downline from this bus, in miles. More...
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT VLL ()
 For 2- and 3-phase buses, returns array of complex numbers represetin L-L voltages in volts. More...
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT VMagAngle ()
 Array of doubles containing voltages in Magnitude (VLN), angle (deg)
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Voc ()
 Open circuit voltage; Complex array.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Voltages ()
 Complex array of voltages at this bus.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT YscMatrix ()
 Complex array of Ysc matrix at bus. More...
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Zsc0 ()
 Complex Zero-Sequence short circuit impedance at bus.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT Zsc1 ()
 Complex Positive-Sequence short circuit impedance at bus. More...
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT ZscMatrix ()
 Complex array of Zsc matrix at bus. More...
 
double kVBase ()
 Base voltage at bus in kV.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT puVLL ()
 Returns Complex array of pu L-L voltages for 2- and 3-phase buses. More...
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT puVmagAngle ()
 Array of doubles containig voltage magnitude, angle pairs in per unit.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT puVoltages ()
 Complex Array of pu voltages at the bus.
 
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT ZSC012Matrix ()
 Array of doubles (complex) containing the complete 012 Zsc matrix.
 
double x ()
 X Coordinate for bus (double)
 
IBusx (double value)
 
double y ()
 Y coordinate for bus(double)
 
IBusy (double value)
 
strings LoadList ()
 List of strings: Full Names of LOAD elements connected to the active bus.
 
strings LineList ()
 List of strings: Full Names of LINE elements connected to the active bus.
 
- 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.
 
APIUtilapi_util
 API utility functions.
 

Member Function Documentation

◆ Coorddefined()

bool dss::classic::IBus::Coorddefined ( )
inline

False=0 else True.

Indicates whether a coordinate has been defined for this bus

◆ puVLL()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT dss::classic::IBus::puVLL ( )
inline

Returns Complex array of pu L-L voltages for 2- and 3-phase buses.

Returns -1.0 for 1-phase bus. If more than 3 phases, returns only 3 phases.

◆ TotalMiles()

double dss::classic::IBus::TotalMiles ( )
inline

Total length of line downline from this bus, in miles.

For recloser siting algorithm.

◆ VLL()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT dss::classic::IBus::VLL ( )
inline

For 2- and 3-phase buses, returns array of complex numbers represetin L-L voltages in volts.

Returns -1.0 for 1-phase bus. If more than 3 phases, returns only first 3.

◆ YscMatrix()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT dss::classic::IBus::YscMatrix ( )
inline

Complex array of Ysc matrix at bus.

Column by column.

◆ Zsc1()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT dss::classic::IBus::Zsc1 ( )
inline

Complex Positive-Sequence short circuit impedance at bus.

◆ ZscMatrix()

template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT dss::classic::IBus::ZscMatrix ( )
inline

Complex array of Zsc matrix at bus.

Column by column.


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