dss::classic::ISensors Class Reference

Inheritance diagram for dss::classic::ISensors:

Collaboration diagram for dss::classic::ISensors:

Public Member Functions
	ISensors (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Sensor names in the circuit.
int32_t	Count ()
	Number of Sensor objects in active circuit.
int32_t	First ()
	Sets the first Sensor active. More...
string	Name ()
	Get the name of the current active Sensor.
ISensors &	Name (const char *value)
	Sets the active Sensor by Name.
ISensors &	Name (const string &value)
int32_t	Next ()
	Sets the next Sensor active. More...
int32_t	idx ()
	Get active Sensor by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Sensor by index; index is 1-based: 1..count.
void	Reset ()
void	ResetAll ()
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Currents ()
	Array of doubles for the line current measurements; don't use with kWS and kVARS.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ISensors &	Currents (const VectorT &value)
bool	IsDelta ()
	True if measured voltages are line-line. More...
ISensors &	IsDelta (bool value)
string	MeteredElement ()
	Full Name of the measured element.
ISensors &	MeteredElement (const char *value)
ISensors &	MeteredElement (const string &value)
int32_t	MeteredTerminal ()
	Number of the measured terminal in the measured element.
ISensors &	MeteredTerminal (int32_t value)
double	PctError ()
	Assumed percent error in the Sensor measurement. More...
ISensors &	PctError (double value)
bool	ReverseDelta ()
	True if voltage measurements are 1-3, 3-2, 2-1.
ISensors &	ReverseDelta (bool value)
double	Weight ()
	Weighting factor for this Sensor measurement with respect to other Sensors. More...
ISensors &	Weight (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	kVARS ()
	Array of doubles for Q measurements. More...
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ISensors &	kVARS (const VectorT &value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	kVS ()
	Array of doubles for the LL or LN (depending on Delta connection) voltage measurements.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ISensors &	kVS (const VectorT &value)
double	kVbase ()
	Voltage base for the sensor measurements. More...
ISensors &	kVbase (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	kWS ()
	Array of doubles for P measurements. More...
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
ISensors &	kWS (const VectorT &value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	AllocationFactor ()
	Array of doubles for the allocation factors for each phase.
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::ISensors::First ( )

inline

Sets the first Sensor active.

Returns 0 if no more.

IsDelta()

bool dss::classic::ISensors::IsDelta ( )

inline

True if measured voltages are line-line.

Currents are always line currents.

kVARS()

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

VectorT dss::classic::ISensors::kVARS ( )

inline

Array of doubles for Q measurements.

Overwrites Currents with a new estimate using kWS.

kVbase()

double dss::classic::ISensors::kVbase ( )

inline

Voltage base for the sensor measurements.

LL for 2 and 3-phase sensors, LN for 1-phase sensors.

kWS()

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

VectorT dss::classic::ISensors::kWS ( )

inline

Array of doubles for P measurements.

Overwrites Currents with a new estimate using kVARS.

Next()

int32_t dss::classic::ISensors::Next ( )

inline

Sets the next Sensor active.

Returns 0 if no more.

PctError()

double dss::classic::ISensors::PctError ( )

inline

Assumed percent error in the Sensor measurement.

Default is 1.

Weight()

double dss::classic::ISensors::Weight ( )

inline

Weighting factor for this Sensor measurement with respect to other Sensors.

Default is 1.

---

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

• include/dss_classic.hpp