DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
dss::obj::TCC_CurveBatch Class Reference
Inheritance diagram for dss::obj::TCC_CurveBatch:
[legend]
Collaboration diagram for dss::obj::TCC_CurveBatch:
[legend]

Public Types

typedef TCC_Curve::Properties Properties
 
typedef TCC_Curve BatchElementClass
 

Public Member Functions

 TCC_CurveBatch (APIUtil *util)
 Create a batch of all TCC_Curve elements.
 
 TCC_CurveBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
 Create a batch of all TCC_Curve elements that match an integer property value.
 
 TCC_CurveBatch (APIUtil *util, const char *regexp)
 Create a batch of all TCC_Curve elements that match a regular expression.
 
TCC_CurveBatchbegin_edit ()
 
TCC_CurveBatchend_edit (int32_t num_edits=1)
 
BatchInt32ArrayProxy npts ()
 Number of points to expect in time-current arrays. More...
 
TCC_CurveBatchnpts (int32_t value)
 
template<typename T >
TCC_CurveBatchnpts (T &value)
 
template<typename T >
TCC_CurveBatchnpts (typename T::iterator it_begin, typename T::iterator it_end)
 
std::vector< VectorXd > C_array ()
 Array of current (or voltage) values corresponding to time values (see help on T_Array). More...
 
TCC_CurveBatchC_array (VectorXd &value)
 
std::vector< VectorXd > T_array ()
 Array of time values in sec. More...
 
TCC_CurveBatchT_array (VectorXd &value)
 
TCC_CurveBatchlike (const string &value)
 Make like another object, e.g. More...
 
TCC_CurveBatchlike (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
APIUtilapi_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>
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

◆ C_array()

std::vector< VectorXd > dss::obj::TCC_CurveBatch::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

◆ like() [1/2]

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

BatchInt32ArrayProxy dss::obj::TCC_CurveBatch::npts ( )
inline

Number of points to expect in time-current arrays.

DSS property name: npts, DSS property index: 1

◆ T_array()

std::vector< VectorXd > dss::obj::TCC_CurveBatch::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: