dss::obj::GrowthShapeBatch Class Reference

Inheritance diagram for dss::obj::GrowthShapeBatch:

Collaboration diagram for dss::obj::GrowthShapeBatch:

Public Types
typedef GrowthShape::Properties	Properties
typedef GrowthShape	BatchElementClass

Public Member Functions
	GrowthShapeBatch (APIUtil *util)
	Create a batch of all GrowthShape elements.
	GrowthShapeBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all GrowthShape elements that match an integer property value.
	GrowthShapeBatch (APIUtil *util, const char *regexp)
	Create a batch of all GrowthShape elements that match a regular expression.
GrowthShapeBatch &	begin_edit ()
GrowthShapeBatch &	end_edit (int32_t num_edits=1)
BatchInt32ArrayProxy	npts ()
	Number of points to expect in subsequent vector. More...
GrowthShapeBatch &	npts (int32_t value)
template<typename T >
GrowthShapeBatch &	npts (T &value)
template<typename T >
GrowthShapeBatch &	npts (typename T::iterator it_begin, typename T::iterator it_end)
std::vector< VectorXd >	year ()
	Array of year values, or a text file spec, corresponding to the multipliers. More...
GrowthShapeBatch &	year (VectorXd &value)
std::vector< VectorXd >	mult ()
	Array of growth multiplier values, or a text file spec, corresponding to the year values. More...
GrowthShapeBatch &	mult (VectorXd &value)
strings	csvfile ()
	Switch input of growth curve data to a csv file containing (year, mult) points, one per line. More...
GrowthShapeBatch &	csvfile (const string &value)
GrowthShapeBatch &	csvfile (strings &value)
strings	sngfile ()
	Switch input of growth curve data to a binary file of singles containing (year, mult) points, packed one after another. More...
GrowthShapeBatch &	sngfile (const string &value)
GrowthShapeBatch &	sngfile (strings &value)
strings	dblfile ()
	Switch input of growth curve data to a binary file of doubles containing (year, mult) points, packed one after another. More...
GrowthShapeBatch &	dblfile (const string &value)
GrowthShapeBatch &	dblfile (strings &value)
GrowthShapeBatch &	like (const string &value)
	Make like another object, e.g. More...
GrowthShapeBatch &	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::GrowthShapeBatch::csvfile ( )

inline

Switch input of growth curve data to a csv file containing (year, mult) points, one per line.

DSS property name: csvfile, DSS property index: 4

dblfile()

strings dss::obj::GrowthShapeBatch::dblfile ( )

inline

Switch input of growth curve data to a binary file of doubles containing (year, mult) points, packed one after another.

DSS property name: dblfile, DSS property index: 6

like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 7

like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 7

mult()

std::vector< VectorXd > dss::obj::GrowthShapeBatch::mult ( )

inline

Array of growth multiplier values, or a text file spec, corresponding to the year values.

Enter the multiplier by which you would multiply the previous year's load to get the present year's.

Examples:

Year = [1, 2, 5] Mult=[1.05, 1.025, 1.02]. Year= (File=years.txt) Mult= (file=mults.txt).

Text files contain one value per line.

DSS property name: mult, DSS property index: 3

npts()

BatchInt32ArrayProxy dss::obj::GrowthShapeBatch::npts ( )

inline

Number of points to expect in subsequent vector.

DSS property name: npts, DSS property index: 1

sngfile()

strings dss::obj::GrowthShapeBatch::sngfile ( )

inline

Switch input of growth curve data to a binary file of singles containing (year, mult) points, packed one after another.

DSS property name: sngfile, DSS property index: 5

year()

std::vector< VectorXd > dss::obj::GrowthShapeBatch::year ( )

inline

Array of year values, or a text file spec, corresponding to the multipliers.

Enter only those years where the growth changes. May be any integer sequence – just so it is consistent. See help on Mult.

DSS property name: year, DSS property index: 2

---

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

• include/dss_obj.hpp