Inheritance diagram for dss::obj::XYcurveBatch:

Collaboration diagram for dss::obj::XYcurveBatch:

Public Types
typedef XYcurve::Properties	Properties

typedef XYcurve	BatchElementClass

Public Member Functions
	XYcurveBatch (APIUtil *util)
	Create a batch of all XYcurve elements.

	XYcurveBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all XYcurve elements that match an integer property value.

	XYcurveBatch (APIUtil util, const char regexp)
	Create a batch of all XYcurve elements that match a regular expression.

XYcurveBatch &	begin_edit ()

XYcurveBatch &	end_edit (int32_t num_edits=1)

BatchInt32ArrayProxy	npts ()
	Max number of points to expect in curve. More...

XYcurveBatch &	npts (int32_t value)

template<typename T >
XYcurveBatch &	npts (T &value)

template<typename T >
XYcurveBatch &	npts (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	Points ()
	One way to enter the points in a curve. More...

XYcurveBatch &	Points (VectorXd &value)

std::vector< VectorXd >	Yarray ()
	Alternate way to enter Y values. More...

XYcurveBatch &	Yarray (VectorXd &value)

std::vector< VectorXd >	Xarray ()
	Alternate way to enter X values. More...

XYcurveBatch &	Xarray (VectorXd &value)

strings	csvfile ()
	Switch input of X-Y curve data to a CSV file containing X, Y points one per line. More...

XYcurveBatch &	csvfile (const string &value)

XYcurveBatch &	csvfile (strings &value)

strings	sngfile ()
	Switch input of X-Y curve data to a binary file of SINGLES containing X, Y points packed one after another. More...

XYcurveBatch &	sngfile (const string &value)

XYcurveBatch &	sngfile (strings &value)

strings	dblfile ()
	Switch input of X-Y curve data to a binary file of DOUBLES containing X, Y points packed one after another. More...

XYcurveBatch &	dblfile (const string &value)

XYcurveBatch &	dblfile (strings &value)

BatchFloat64ArrayProxy	x ()
	Enter a value and then retrieve the interpolated Y value from the Y property. More...

XYcurveBatch &	x (double value)

template<typename T >
XYcurveBatch &	x (T &value)

template<typename T >
XYcurveBatch &	x (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	y ()
	Enter a value and then retrieve the interpolated X value from the X property. More...

XYcurveBatch &	y (double value)

template<typename T >
XYcurveBatch &	y (T &value)

template<typename T >
XYcurveBatch &	y (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xshift ()
	Shift X property values (in/out) by this amount of offset. More...

XYcurveBatch &	Xshift (double value)

template<typename T >
XYcurveBatch &	Xshift (T &value)

template<typename T >
XYcurveBatch &	Xshift (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Yshift ()
	Shift Y property values (in/out) by this amount of offset. More...

XYcurveBatch &	Yshift (double value)

template<typename T >
XYcurveBatch &	Yshift (T &value)

template<typename T >
XYcurveBatch &	Yshift (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Xscale ()
	Scale X property values (in/out) by this factor. More...

XYcurveBatch &	Xscale (double value)

template<typename T >
XYcurveBatch &	Xscale (T &value)

template<typename T >
XYcurveBatch &	Xscale (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Yscale ()
	Scale Y property values (in/out) by this factor. More...

XYcurveBatch &	Yscale (double value)

template<typename T >
XYcurveBatch &	Yscale (T &value)

template<typename T >
XYcurveBatch &	Yscale (typename T::iterator it_begin, typename T::iterator it_end)

XYcurveBatch &	like (const string &value)
	Make like another object, e.g. More...

XYcurveBatch &	like (const char *value)
	Make like another object, e.g. More...

Public Member Functions inherited from dss::obj::DSSBatch
	DSSBatch (APIUtil *util, int32_t cls_idx)
	Create a batch of all elements in the DSS class.

	DSSBatch (APIUtil *util, int32_t cls_idx, int32_t prop_idx, int32_t prop_value)
	Create a batch of all elements that match an integer property value.

	DSSBatch (APIUtil util, int32_t cls_idx, const char regexp)
	Create a batch of all elements that match a regular expression.

	DSSBatch (APIUtil *util)
	Create an uninitialized batch instance.

strings	name ()

Additional Inherited Members
Public Attributes inherited from dss::obj::DSSBatch
APIUtil *	api_util

void **	pointer

int32_t	count [2]

Protected Member Functions inherited from dss::obj::DSSBatch
void	check_for_error ()

bools	get_batch_bool (int32_t index)

std::vector< complex >	get_batch_complex (int32_t index)

template<typename T = VectorXd>
std::vector< T >	get_batch_valarray (int32_t index)

void	set_batch_complex_for_each (int32_t index, std::vector< complex > &values)

template<typename T >
void	set_batch_val (int32_t index, const T &value)

template<typename T = VectorXd>
T	get_batch_val (int32_t index)

template<typename T >
void	set_batch_val_for_each (int32_t index, typename T::iterator v, typename T::iterator v_end)

Static Protected Member Functions inherited from dss::obj::DSSBatch
template<typename T = VectorXd>
static T	get_batch_val (int32_t index, DSSBatch &batch)

Member Function Documentation

◆ csvfile()

strings dss::obj::XYcurveBatch::csvfile ( )

inline

Switch input of X-Y curve data to a CSV file containing X, Y points one per line.

NOTE: This action may reset the number of points to a lower value.

DSS property name: csvfile, DSS property index: 5

◆ dblfile()

strings dss::obj::XYcurveBatch::dblfile ( )

inline

Switch input of X-Y curve data to a binary file of DOUBLES containing X, Y points packed one after another.

NOTE: This action may reset the number of points to a lower value.

DSS property name: dblfile, DSS property index: 7

◆ like() [1/2]

XYcurveBatch & dss::obj::XYcurveBatch::like ( const char * value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ like() [2/2]

XYcurveBatch & dss::obj::XYcurveBatch::like ( const string & value )

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ npts()

BatchInt32ArrayProxy dss::obj::XYcurveBatch::npts ( )

inline

Max number of points to expect in curve.

This could get reset to the actual number of points defined if less than specified.

DSS property name: npts, DSS property index: 1

◆ Points()

std::vector< VectorXd > dss::obj::XYcurveBatch::Points ( )

inline

One way to enter the points in a curve.

Enter x and y values as one array in the order [x1, y1, x2, y2, ...]. For example:

Points=[1,100 2,200 3, 300]

Values separated by commas or white space. Zero fills arrays if insufficient number of values.

DSS property name: Points, DSS property index: 2

◆ sngfile()

strings dss::obj::XYcurveBatch::sngfile ( )

inline

Switch input of X-Y curve data to a binary file of SINGLES containing X, Y points packed one after another.

NOTE: This action may reset the number of points to a lower value.

DSS property name: sngfile, DSS property index: 6

◆ x()

BatchFloat64ArrayProxy dss::obj::XYcurveBatch::x ( )

inline

Enter a value and then retrieve the interpolated Y value from the Y property.

On input shifted then scaled to original curve. Scaled then shifted on output.

DSS property name: x, DSS property index: 8

◆ Xarray()

std::vector< VectorXd > dss::obj::XYcurveBatch::Xarray ( )

inline

Alternate way to enter X values.

Enter an array of X values corresponding to the Y values. You can also use the syntax: Xarray = (file=filename) !for text file one value per line Xarray = (dblfile=filename) !for packed file of doubles Xarray = (sngfile=filename) !for packed file of singles

Note: this property will reset Npts to a smaller value if the number of values in the files are fewer.

DSS property name: Xarray, DSS property index: 4

◆ Xscale()

BatchFloat64ArrayProxy dss::obj::XYcurveBatch::Xscale ( )

inline

Scale X property values (in/out) by this factor.

Default = 1.0. Does not change original definition of arrays.

DSS property name: Xscale, DSS property index: 12

◆ Xshift()

BatchFloat64ArrayProxy dss::obj::XYcurveBatch::Xshift ( )

inline

Shift X property values (in/out) by this amount of offset.

Default = 0. Does not change original definition of arrays.

DSS property name: Xshift, DSS property index: 10

◆ y()

BatchFloat64ArrayProxy dss::obj::XYcurveBatch::y ( )

inline

Enter a value and then retrieve the interpolated X value from the X property.

On input shifted then scaled to original curve. Scaled then shifted on output.

DSS property name: y, DSS property index: 9

◆ Yarray()

std::vector< VectorXd > dss::obj::XYcurveBatch::Yarray ( )

inline

Alternate way to enter Y values.

Enter an array of Y values corresponding to the X values. You can also use the syntax: Yarray = (file=filename) !for text file one value per line Yarray = (dblfile=filename) !for packed file of doubles Yarray = (sngfile=filename) !for packed file of singles

Note: this property will reset Npts to a smaller value if the number of values in the files are fewer.

DSS property name: Yarray, DSS property index: 3

◆ Yscale()

BatchFloat64ArrayProxy dss::obj::XYcurveBatch::Yscale ( )

inline

Scale Y property values (in/out) by this factor.

Default = 1.0. Does not change original definition of arrays.

DSS property name: Yscale, DSS property index: 13

◆ Yshift()

BatchFloat64ArrayProxy dss::obj::XYcurveBatch::Yshift ( )

inline

Shift Y property values (in/out) by this amount of offset.

Default = 0. Does not change original definition of arrays.

DSS property name: Yshift, DSS property index: 11

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

include/dss_obj.hpp

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ csvfile()

◆ dblfile()

◆ like() [1/2]

◆ like() [2/2]

◆ npts()

◆ Points()

◆ sngfile()

◆ x()

◆ Xarray()

◆ Xscale()

◆ Xshift()

◆ y()

◆ Yarray()

◆ Yscale()

◆ Yshift()