dss::classic::IVsources Class Reference

Inheritance diagram for dss::classic::IVsources:

Collaboration diagram for dss::classic::IVsources:

Public Member Functions
	IVsources (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Vsource names in the circuit.
int32_t	Count ()
	Number of Vsource objects in active circuit.
int32_t	First ()
	Sets the first Vsource active. More...
string	Name ()
	Get the name of the current active Vsource.
IVsources &	Name (const char *value)
	Sets the active Vsource by Name.
IVsources &	Name (const string &value)
int32_t	Next ()
	Sets the next Vsource active. More...
int32_t	idx ()
	Get active Vsource by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Vsource by index; index is 1-based: 1..count.
double	AngleDeg ()
	Phase angle of first phase in degrees.
IVsources &	AngleDeg (double value)
double	BasekV ()
	Source voltage in kV.
IVsources &	BasekV (double value)
double	Frequency ()
	Source frequency in Hz.
IVsources &	Frequency (double value)
int32_t	Phases ()
	Number of phases.
IVsources &	Phases (int32_t value)
double	pu ()
	Per-unit value of source voltage.
IVsources &	pu (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::IVsources::First ( )

inline

Sets the first Vsource active.

Returns 0 if no more.

Next()

int32_t dss::classic::IVsources::Next ( )

inline

Sets the next Vsource active.

Returns 0 if no more.

---

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

• include/dss_classic.hpp