dss::obj::UPFCControlBatch Class Reference

Inheritance diagram for dss::obj::UPFCControlBatch:

Collaboration diagram for dss::obj::UPFCControlBatch:

Public Types
typedef UPFCControl::Properties	Properties
typedef UPFCControl	BatchElementClass

Public Member Functions
	UPFCControlBatch (APIUtil *util)
	Create a batch of all UPFCControl elements.
	UPFCControlBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all UPFCControl elements that match an integer property value.
	UPFCControlBatch (APIUtil *util, const char *regexp)
	Create a batch of all UPFCControl elements that match a regular expression.
UPFCControlBatch &	begin_edit ()
UPFCControlBatch &	end_edit (int32_t num_edits=1)
std::vector< strings >	UPFCList ()
	The list of all the UPFC devices to be controlled by this controller, If left empty, this control will apply for all UPFCs in the model. More...
UPFCControlBatch &	UPFCList (strings &value)
BatchFloat64ArrayProxy	basefreq ()
	Base Frequency for ratings. More...
UPFCControlBatch &	basefreq (double value)
template<typename T >
UPFCControlBatch &	basefreq (T &value)
template<typename T >
UPFCControlBatch &	basefreq (typename T::iterator it_begin, typename T::iterator it_end)
bools	enabled ()
	{Yes|No or True|False} Indicates whether this element is enabled. More...
UPFCControlBatch &	enabled (bool value)
UPFCControlBatch &	enabled (bools &value)
UPFCControlBatch &	like (const string &value)
	Make like another object, e.g. More...
UPFCControlBatch &	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

basefreq()

BatchFloat64ArrayProxy dss::obj::UPFCControlBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 2

enabled()

bools dss::obj::UPFCControlBatch::enabled ( )

inline

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: enabled, DSS property index: 3

like() [1/2]

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

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 4

UPFCList()

std::vector< strings > dss::obj::UPFCControlBatch::UPFCList ( )

inline

The list of all the UPFC devices to be controlled by this controller, If left empty, this control will apply for all UPFCs in the model.

DSS property name: UPFCList, DSS property index: 1

---

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

• include/dss_obj.hpp