dss::classic::ICapacitors Class Reference

Inheritance diagram for dss::classic::ICapacitors:

Collaboration diagram for dss::classic::ICapacitors:

Public Member Functions
	ICapacitors (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Capacitor names in the circuit.
int32_t	Count ()
	Number of Capacitor objects in active circuit.
int32_t	First ()
	Sets the first Capacitor active. More...
string	Name ()
	Get the name of the current active Capacitor.
ICapacitors &	Name (const char *value)
	Sets the active Capacitor by Name.
ICapacitors &	Name (const string &value)
int32_t	Next ()
	Sets the next Capacitor active. More...
int32_t	idx ()
	Get active Capacitor by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Capacitor by index; index is 1-based: 1..count.
bool	AddStep ()
void	Close ()
void	Open ()
bool	SubtractStep ()
int32_t	AvailableSteps ()
	Number of Steps available in cap bank to be switched ON.
bool	IsDelta ()
	Delta connection or wye?
ICapacitors &	IsDelta (bool value)
int32_t	NumSteps ()
	Number of steps (default 1) for distributing and switching the total bank kVAR.
ICapacitors &	NumSteps (int32_t value)
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
VectorT	States ()
	A array of integer [0..numsteps-1] indicating state of each step. More...
template<typename VectorT = Eigen::Matrix<int32_t, Eigen::Dynamic, 1>>
ICapacitors &	States (const VectorT &value)
double	kV ()
	Bank kV rating. More...
ICapacitors &	kV (double value)
double	kvar ()
	Total bank KVAR, distributed equally among phases and steps.
ICapacitors &	kvar (double 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::ICapacitors::First ( )

inline

Sets the first Capacitor active.

Returns 0 if no more.

kV()

double dss::classic::ICapacitors::kV ( )

inline

Bank kV rating.

Use LL for 2 or 3 phases, or actual can rating for 1 phase.

Next()

int32_t dss::classic::ICapacitors::Next ( )

inline

Sets the next Capacitor active.

Returns 0 if no more.

States()

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

VectorT dss::classic::ICapacitors::States ( )

inline

A array of integer [0..numsteps-1] indicating state of each step.

If the read value is -1 an error has occurred.

---

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

• include/dss_classic.hpp