dss::classic::IXYCurves Class Reference

Inheritance diagram for dss::classic::IXYCurves:

Collaboration diagram for dss::classic::IXYCurves:

Public Member Functions
	IXYCurves (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all XYCurve names in the circuit.
int32_t	Count ()
	Number of XYCurve objects in active circuit.
int32_t	First ()
	Sets the first XYCurve active. More...
string	Name ()
	Get the name of the current active XYCurve.
IXYCurves &	Name (const char *value)
	Sets the active XYCurve by Name.
IXYCurves &	Name (const string &value)
int32_t	Next ()
	Sets the next XYCurve active. More...
int32_t	idx ()
	Get active XYCurve by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active XYCurve by index; index is 1-based: 1..count.
int32_t	Npts ()
	Get/Set Number of points in X-Y curve.
IXYCurves &	Npts (int32_t value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Xarray ()
	Get/set X values as a Array of doubles. More...
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IXYCurves &	Xarray (const VectorT &value)
double	Xscale ()
	Factor to scale X values from original curve.
IXYCurves &	Xscale (double value)
double	Xshift ()
	Amount to shift X value from original curve.
IXYCurves &	Xshift (double value)
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
VectorT	Yarray ()
	Get/Set Y values in curve; Set Npts to max number expected if setting.
template<typename VectorT = Eigen::Matrix<double, Eigen::Dynamic, 1>>
IXYCurves &	Yarray (const VectorT &value)
double	Yscale ()
	Factor to scale Y values from original curve.
IXYCurves &	Yscale (double value)
double	Yshift ()
	Amount to shift Y value from original curve.
IXYCurves &	Yshift (double value)
double	x ()
	Set X value or get interpolated value after setting Y.
IXYCurves &	x (double value)
double	y ()
	Set Y value or get interpolated Y value after setting X.
IXYCurves &	y (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::IXYCurves::First ( )

inline

Sets the first XYCurve active.

Returns 0 if no more.

Next()

int32_t dss::classic::IXYCurves::Next ( )

inline

Sets the next XYCurve active.

Returns 0 if no more.

Xarray()

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

VectorT dss::classic::IXYCurves::Xarray ( )

inline

Get/set X values as a Array of doubles.

Set Npts to max number expected if setting

---

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

• include/dss_classic.hpp