dss::obj::TCC_Curve Class Reference

Inheritance diagram for dss::obj::TCC_Curve:

Collaboration diagram for dss::obj::TCC_Curve:

Classes
struct	Properties

Public Member Functions
	TCC_Curve (APIUtil *util=nullptr, void *ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.
	TCC_Curve (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".
	TCC_Curve (APIUtil *util, char *name)
	Create a wrapper for an element given its name.
const char *	name ()
	Returns the object's name.
TCC_Curve &	begin_edit ()
	Marks an object for edition. More...
TCC_Curve &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...
int32_t	npts ()
	Number of points to expect in time-current arrays. More...
TCC_Curve &	npts (int32_t value)
VectorXd	C_array ()
	Array of current (or voltage) values corresponding to time values (see help on T_Array). More...
TCC_Curve &	C_array (VectorXd &value)
VectorXd	T_array ()
	Array of time values in sec. More...
TCC_Curve &	T_array (VectorXd &value)
TCC_Curve &	like (const string &value)
	Make like another object, e.g. More...
TCC_Curve &	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 [] = "TCC_Curve"
static const int32_t	dss_cls_idx = 7

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()

TCC_Curve & dss::obj::TCC_Curve::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

C_array()

VectorXd dss::obj::TCC_Curve::C_array ( )

inline

Array of current (or voltage) values corresponding to time values (see help on T_Array).

DSS property name: C_array, DSS property index: 2

end_edit()

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

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 4

like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 4

npts()

int32_t dss::obj::TCC_Curve::npts ( )

inline

Number of points to expect in time-current arrays.

DSS property name: npts, DSS property index: 1

T_array()

VectorXd dss::obj::TCC_Curve::T_array ( )

inline

Array of time values in sec.

Typical array syntax: t_array = (1, 2, 3, 4, ...)

Can also substitute a file designation: t_array = (file=filename)

The specified file has one value per line.

DSS property name: T_array, DSS property index: 3

---

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

• include/dss_obj.hpp