Inheritance diagram for dss::obj::GenDispatcher:

Collaboration diagram for dss::obj::GenDispatcher:

Classes
struct	Properties

Public Member Functions
	GenDispatcher (APIUtil util=nullptr, void ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.

	GenDispatcher (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".

	GenDispatcher (APIUtil util, char name)
	Create a wrapper for an element given its name.

const char *	name ()
	Returns the object's name.

GenDispatcher &	begin_edit ()
	Marks an object for edition. More...

GenDispatcher &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...

string	Element ()
	Full object name of the circuit element, typically a line or transformer, which the control is monitoring. More...

GenDispatcher &	Element (const string &value)

GenDispatcher &	Element (dss::obj::DSSObj &value)

dss::obj::DSSObj	Element_obj ()
	Full object name of the circuit element, typically a line or transformer, which the control is monitoring. More...

GenDispatcher &	Element_obj (dss::obj::DSSObj &value)

int32_t	Terminal ()
	Number of the terminal of the circuit element to which the GenDispatcher control is connected. More...

GenDispatcher &	Terminal (int32_t value)

double	kWLimit ()
	kW Limit for the monitored element. More...

GenDispatcher &	kWLimit (double value)

double	kWBand ()
	Bandwidth (kW) of the dead band around the target limit.No dispatch changes are attempted if the power in the monitored terminal stays within this band. More...

GenDispatcher &	kWBand (double value)

double	kvarlimit ()
	Max kvar to be delivered through the element. More...

GenDispatcher &	kvarlimit (double value)

strings	GenList ()
	Array list of generators to be dispatched. More...

GenDispatcher &	GenList (strings &value)

VectorXd	Weights ()
	GenDispatcher.Weights. More...

GenDispatcher &	Weights (VectorXd &value)

double	basefreq ()
	Base Frequency for ratings. More...

GenDispatcher &	basefreq (double value)

bool	enabled ()
	{Yes\|No or True\|False} Indicates whether this element is enabled. More...

GenDispatcher &	enabled (bool value)

GenDispatcher &	like (const string &value)
	Make like another object, e.g. More...

GenDispatcher &	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 [] = "GenDispatcher"

static const int32_t	dss_cls_idx = 27

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::GenDispatcher::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 8

◆ begin_edit()

GenDispatcher & dss::obj::GenDispatcher::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

◆ Element()

string dss::obj::GenDispatcher::Element ( )

inline

Full object name of the circuit element, typically a line or transformer, which the control is monitoring.

There is no default; must be specified.

DSS property name: Element, DSS property index: 1

◆ Element_obj()

dss::obj::DSSObj dss::obj::GenDispatcher::Element_obj ( )

inline

Full object name of the circuit element, typically a line or transformer, which the control is monitoring.

There is no default; must be specified.

DSS property name: Element, DSS property index: 1

◆ enabled()

bool dss::obj::GenDispatcher::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 9

◆ end_edit()

GenDispatcher & dss::obj::GenDispatcher::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.

◆ GenList()

strings dss::obj::GenDispatcher::GenList ( )

inline

Array list of generators to be dispatched.

If not specified, all generators in the circuit are assumed dispatchable.

DSS property name: GenList, DSS property index: 6

◆ kvarlimit()

double dss::obj::GenDispatcher::kvarlimit ( )

inline

Max kvar to be delivered through the element.

Uses same dead band as kW.

DSS property name: kvarlimit, DSS property index: 5

◆ kWBand()

double dss::obj::GenDispatcher::kWBand ( )

inline

Bandwidth (kW) of the dead band around the target limit.No dispatch changes are attempted if the power in the monitored terminal stays within this band.

DSS property name: kWBand, DSS property index: 4

◆ kWLimit()

double dss::obj::GenDispatcher::kWLimit ( )

inline

kW Limit for the monitored element.

The generators are dispatched to hold the power in band.

DSS property name: kWLimit, DSS property index: 3

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 10

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 10

◆ Terminal()

int32_t dss::obj::GenDispatcher::Terminal ( )

inline

Number of the terminal of the circuit element to which the GenDispatcher control is connected.

1 or 2, typically. Default is 1. Make sure you have the direction on the power matching the sign of kWLimit.

DSS property name: Terminal, DSS property index: 2

◆ Weights()

VectorXd dss::obj::GenDispatcher::Weights ( )

inline

GenDispatcher.Weights.

DSS property name: Weights, DSS property index: 7

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

include/dss_obj.hpp

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ begin_edit()

◆ Element()

◆ Element_obj()

◆ enabled()

◆ end_edit()

◆ GenList()

◆ kvarlimit()

◆ kWBand()

◆ kWLimit()

◆ like() [1/2]

◆ like() [2/2]

◆ Terminal()

◆ Weights()