dss::classic::IStorages Class Reference

Inheritance diagram for dss::classic::IStorages:

Collaboration diagram for dss::classic::IStorages:

Public Member Functions
	IStorages (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Storage names in the circuit.
int32_t	Count ()
	Number of Storage objects in active circuit.
int32_t	First ()
	Sets the first Storage active. More...
string	Name ()
	Get the name of the current active Storage.
IStorages &	Name (const char *value)
	Sets the active Storage by Name.
IStorages &	Name (const string &value)
int32_t	Next ()
	Sets the next Storage active. More...
int32_t	idx ()
	Get active Storage by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Storage by index; index is 1-based: 1..count.
double	puSOC ()
	Per unit state of charge.
IStorages &	puSOC (double value)
int32_t	State ()
	Get/set state: 0=Idling; 1=Discharging; -1=Charging;. More...
IStorages &	State (int32_t value)
strings	RegisterNames ()
	Array of Names of all Storage energy meter registers.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	RegisterValues ()
	Array of values in Storage registers.
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::IStorages::First ( )

inline

Sets the first Storage active.

Returns 0 if no more.

Next()

int32_t dss::classic::IStorages::Next ( )

inline

Sets the next Storage active.

Returns 0 if no more.

State()

int32_t dss::classic::IStorages::State ( )

inline

Get/set state: 0=Idling; 1=Discharging; -1=Charging;.

Related enumeration: StorageStates

---

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

• include/dss_classic.hpp