dss::obj::UPFCControl Class Reference

Inheritance diagram for dss::obj::UPFCControl:

Collaboration diagram for dss::obj::UPFCControl:

Classes
struct	Properties

Public Member Functions
	UPFCControl (APIUtil *util=nullptr, void *ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.
	UPFCControl (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".
	UPFCControl (APIUtil *util, char *name)
	Create a wrapper for an element given its name.
const char *	name ()
	Returns the object's name.
UPFCControl &	begin_edit ()
	Marks an object for edition. More...
UPFCControl &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...
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...
UPFCControl &	UPFCList (strings &value)
double	basefreq ()
	Base Frequency for ratings. More...
UPFCControl &	basefreq (double value)
bool	enabled ()
	{Yes|No or True|False} Indicates whether this element is enabled. More...
UPFCControl &	enabled (bool value)
UPFCControl &	like (const string &value)
	Make like another object, e.g. More...
UPFCControl &	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 [] = "UPFCControl"
static const int32_t	dss_cls_idx = 36

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

basefreq()

double dss::obj::UPFCControl::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 2

begin_edit()

UPFCControl & dss::obj::UPFCControl::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

enabled()

bool dss::obj::UPFCControl::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 3

end_edit()

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

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

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

strings dss::obj::UPFCControl::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