dss::classic::IMonitors Class Reference

Inheritance diagram for dss::classic::IMonitors:

Collaboration diagram for dss::classic::IMonitors:

Public Member Functions
	IMonitors (dss::APIUtil *util)
template<typename VectorT = Eigen::VectorXd>
VectorT	Channel (int32_t Index)
	Array of float64 for the specified channel (usage: MyArray = DSSMonitor.Channel(i)). More...
strings	AllNames ()
	Array of strings with all Monitor names in the circuit.
int32_t	Count ()
	Number of Monitor objects in active circuit.
int32_t	First ()
	Sets the first Monitor active. More...
string	Name ()
	Get the name of the current active Monitor.
IMonitors &	Name (const char *value)
	Sets the active Monitor by Name.
IMonitors &	Name (const string &value)
int32_t	Next ()
	Sets the next Monitor active. More...
int32_t	idx ()
	Get active Monitor by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Monitor by index; index is 1-based: 1..count.
void	Process ()
void	ProcessAll ()
void	Reset ()
void	ResetAll ()
void	Sample ()
void	SampleAll ()
void	Save ()
void	SaveAll ()
void	Show ()
template<typename VectorT = Eigen::Matrix<int8_t, Eigen::Dynamic, 1>>
VectorT	ByteStream ()
	Byte Array containing monitor stream values. More...
string	Element ()
	Full object name of element being monitored.
IMonitors &	Element (const char *value)
IMonitors &	Element (const string &value)
string	FileName ()
	Name of CSV file associated with active Monitor.
int32_t	FileVersion ()
	Monitor File Version (integer)
strings	Header ()
	Header string; Array of strings containing Channel names.
int32_t	Mode ()
	Set Monitor mode (bitmask integer - see DSS Help)
IMonitors &	Mode (int32_t value)
int32_t	NumChannels ()
	Number of Channels in the active Monitor.
int32_t	RecordSize ()
	Size of each record in ByteStream (Integer). More...
int32_t	SampleCount ()
	Number of Samples in Monitor at Present.
int32_t	Terminal ()
	Terminal number of element being monitored.
IMonitors &	Terminal (int32_t value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	dblFreq ()
	Array of doubles containing frequency values for harmonics mode solutions; Empty for time mode solutions (use dblHour)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	dblHour ()
	Array of doubles containing time value in hours for time-sampled monitor values; Empty if frequency-sampled values for harmonics solution (see dblFreq)
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

ByteStream()

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

VectorT dss::classic::IMonitors::ByteStream ( )

inline

Byte Array containing monitor stream values.

Make sure a "save" is done first (standard solution modes do this automatically)

Channel()

template<typename VectorT = Eigen::VectorXd>

VectorT dss::classic::IMonitors::Channel ( int32_t  Index )

inline

Array of float64 for the specified channel (usage: MyArray = DSSMonitor.Channel(i)).

A Save or SaveAll should be executed first. Done automatically by most standard solution modes. Channels start at index 1.

First()

int32_t dss::classic::IMonitors::First ( )

inline

Sets the first Monitor active.

Returns 0 if no more.

Next()

int32_t dss::classic::IMonitors::Next ( )

inline

Sets the next Monitor active.

Returns 0 if no more.

RecordSize()

int32_t dss::classic::IMonitors::RecordSize ( )

inline

Size of each record in ByteStream (Integer).

Same as NumChannels.

---

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

• include/dss_classic.hpp