dss::obj::SpectrumBatch Class Reference

Inheritance diagram for dss::obj::SpectrumBatch:

Collaboration diagram for dss::obj::SpectrumBatch:

Public Types
typedef Spectrum::Properties	Properties
typedef Spectrum	BatchElementClass

Public Member Functions
	SpectrumBatch (APIUtil *util)
	Create a batch of all Spectrum elements.
	SpectrumBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all Spectrum elements that match an integer property value.
	SpectrumBatch (APIUtil *util, const char *regexp)
	Create a batch of all Spectrum elements that match a regular expression.
SpectrumBatch &	begin_edit ()
SpectrumBatch &	end_edit (int32_t num_edits=1)
BatchInt32ArrayProxy	NumHarm ()
	Number of frequencies in this spectrum. More...
SpectrumBatch &	NumHarm (int32_t value)
template<typename T >
SpectrumBatch &	NumHarm (T &value)
template<typename T >
SpectrumBatch &	NumHarm (typename T::iterator it_begin, typename T::iterator it_end)
std::vector< VectorXd >	harmonic ()
	Array of harmonic values. More...
SpectrumBatch &	harmonic (VectorXd &value)
std::vector< VectorXd >	pctmag ()
	Array of magnitude values, assumed to be in PERCENT. More...
SpectrumBatch &	pctmag (VectorXd &value)
std::vector< VectorXd >	angle ()
	Array of phase angle values, degrees.You can also use the syntax angle = (file=filename) !for text file one value per line angle = (dblfile=filename) !for packed file of doubles angle = (sngfile=filename) !for packed file of singles. More...
SpectrumBatch &	angle (VectorXd &value)
strings	CSVFile ()
	File of spectrum points with (harmonic, magnitude-percent, angle-degrees) values, one set of 3 per line, in CSV format. More...
SpectrumBatch &	CSVFile (const string &value)
SpectrumBatch &	CSVFile (strings &value)
SpectrumBatch &	like (const string &value)
	Make like another object, e.g. More...
SpectrumBatch &	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

angle()

std::vector< VectorXd > dss::obj::SpectrumBatch::angle ( )

inline

Array of phase angle values, degrees.You can also use the syntax angle = (file=filename) !for text file one value per line angle = (dblfile=filename) !for packed file of doubles angle = (sngfile=filename) !for packed file of singles.

DSS property name: angle, DSS property index: 4

CSVFile()

strings dss::obj::SpectrumBatch::CSVFile ( )

inline

File of spectrum points with (harmonic, magnitude-percent, angle-degrees) values, one set of 3 per line, in CSV format.

If fewer than NUMHARM frequencies found in the file, NUMHARM is set to the smaller value.

DSS property name: CSVFile, DSS property index: 5

harmonic()

std::vector< VectorXd > dss::obj::SpectrumBatch::harmonic ( )

inline

Array of harmonic values.

You can also use the syntax harmonic = (file=filename) !for text file one value per line harmonic = (dblfile=filename) !for packed file of doubles harmonic = (sngfile=filename) !for packed file of singles

DSS property name: harmonic, DSS property index: 2

like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 6

like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 6

NumHarm()

BatchInt32ArrayProxy dss::obj::SpectrumBatch::NumHarm ( )

inline

Number of frequencies in this spectrum.

(See CSVFile)

DSS property name: NumHarm, DSS property index: 1

pctmag()

std::vector< VectorXd > dss::obj::SpectrumBatch::pctmag ( )

inline

Array of magnitude values, assumed to be in PERCENT.

You can also use the syntax mag = (file=filename) !for text file one value per line mag = (dblfile=filename) !for packed file of doubles mag = (sngfile=filename) !for packed file of singles

DSS property name: mag, DSS property index: 3

---

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

• include/dss_obj.hpp