dss::obj::GrowthShape Class Reference

Inheritance diagram for dss::obj::GrowthShape:

Collaboration diagram for dss::obj::GrowthShape:

Classes
struct	Properties

Public Member Functions
	GrowthShape (APIUtil *util=nullptr, void *ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.
	GrowthShape (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".
	GrowthShape (APIUtil *util, char *name)
	Create a wrapper for an element given its name.
const char *	name ()
	Returns the object's name.
GrowthShape &	begin_edit ()
	Marks an object for edition. More...
GrowthShape &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...
int32_t	npts ()
	Number of points to expect in subsequent vector. More...
GrowthShape &	npts (int32_t value)
VectorXd	year ()
	Array of year values, or a text file spec, corresponding to the multipliers. More...
GrowthShape &	year (VectorXd &value)
VectorXd	mult ()
	Array of growth multiplier values, or a text file spec, corresponding to the year values. More...
GrowthShape &	mult (VectorXd &value)
string	csvfile ()
	Switch input of growth curve data to a csv file containing (year, mult) points, one per line. More...
GrowthShape &	csvfile (const string &value)
GrowthShape &	csvfile (const char *value)
string	sngfile ()
	Switch input of growth curve data to a binary file of singles containing (year, mult) points, packed one after another. More...
GrowthShape &	sngfile (const string &value)
GrowthShape &	sngfile (const char *value)
string	dblfile ()
	Switch input of growth curve data to a binary file of doubles containing (year, mult) points, packed one after another. More...
GrowthShape &	dblfile (const string &value)
GrowthShape &	dblfile (const char *value)
GrowthShape &	like (const string &value)
	Make like another object, e.g. More...
GrowthShape &	like (const char *value)
	Make like another object, e.g. More...
Public Member Functions inherited from dss::obj::DSSObj
	DSSObj (APIUtil *util=nullptr, void *ptr_=nullptr)

Static Public Attributes
static const char	dss_cls_name [] = "GrowthShape"
static const int32_t	dss_cls_idx = 6

Additional Inherited Members
Public Attributes inherited from dss::obj::DSSObj
APIUtil *	api_util
void *	ptr
Protected Member Functions inherited from dss::obj::DSSObj
void	check_for_error ()
void	set_string (int32_t index, const string &value)
void	set_string (int32_t index, const char *value)
string	get_prop_string (int32_t index)
complex	get_complex (int32_t index)
void	set_complex (int32_t index, complex value)
void	set_string_array (int32_t index, strings &value)
void	set_obj (int32_t index, DSSObj &value)
template<typename T >
T	get_obj (int32_t index)
template<typename T = VectorXd>
T	get_array (int32_t index)
template<typename T = VectorXd>
void	set_array (int32_t index, T value)
Static Protected Member Functions inherited from dss::obj::DSSObj
template<typename T = VectorXd>
static void	set_array (void *ptr, int32_t index, T value)
Protected Attributes inherited from dss::obj::DSSObj
friend	DSSBatch

Member Function Documentation

begin_edit()

GrowthShape & dss::obj::GrowthShape::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

csvfile()

string dss::obj::GrowthShape::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()

string dss::obj::GrowthShape::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

end_edit()

GrowthShape & dss::obj::GrowthShape::end_edit ( int32_t  num_edits = 1 )

inline

Finalizes an object edition.

This will result more compelx side-effects like Yprim and other internal data recalculation, for example.

like() [1/2]

GrowthShape & dss::obj::GrowthShape::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]

GrowthShape & dss::obj::GrowthShape::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()

VectorXd dss::obj::GrowthShape::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()

int32_t dss::obj::GrowthShape::npts ( )

inline

Number of points to expect in subsequent vector.

DSS property name: npts, DSS property index: 1

sngfile()

string dss::obj::GrowthShape::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()

VectorXd dss::obj::GrowthShape::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