Inheritance diagram for dss::obj::ESPVLControlBatch:

Collaboration diagram for dss::obj::ESPVLControlBatch:

Public Types
typedef ESPVLControl::Properties	Properties

typedef ESPVLControl	BatchElementClass

typedef ESPVLControl::ESPVLControlType	ESPVLControlType

Public Member Functions
	ESPVLControlBatch (APIUtil *util)
	Create a batch of all ESPVLControl elements.

	ESPVLControlBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all ESPVLControl elements that match an integer property value.

	ESPVLControlBatch (APIUtil util, const char regexp)
	Create a batch of all ESPVLControl elements that match a regular expression.

ESPVLControlBatch &	begin_edit ()

ESPVLControlBatch &	end_edit (int32_t num_edits=1)

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

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

ESPVLControlBatch &	Element (const string &value)

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

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

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

ESPVLControlBatch &	Terminal (int32_t value)

template<typename T >
ESPVLControlBatch &	Terminal (T &value)

template<typename T >
ESPVLControlBatch &	Terminal (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Type ()
	Type of controller. More...

ESPVLControlBatch &	Type (string &value)

ESPVLControlBatch &	Type (int32_t value)

ESPVLControlBatch &	Type (ESPVLControl::ESPVLControlType value)

ESPVLControlBatch &	Type (strings &value)

ESPVLControlBatch &	Type (std::vector< int32_t > &value)

ESPVLControlBatch &	Type (std::vector< ESPVLControl::ESPVLControlType > &value)

strings	Type_str ()
	Type of controller. More...

ESPVLControlBatch &	Type_str (string &value)

ESPVLControlBatch &	Type_str (strings &value)

BatchFloat64ArrayProxy	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...

ESPVLControlBatch &	kWBand (double value)

template<typename T >
ESPVLControlBatch &	kWBand (T &value)

template<typename T >
ESPVLControlBatch &	kWBand (typename T::iterator it_begin, typename T::iterator it_end)

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

ESPVLControlBatch &	kvarlimit (double value)

template<typename T >
ESPVLControlBatch &	kvarlimit (T &value)

template<typename T >
ESPVLControlBatch &	kvarlimit (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< strings >	LocalControlList ()
	Array list of ESPVLControl local controller objects to be dispatched by System Controller. More...

ESPVLControlBatch &	LocalControlList (strings &value)

std::vector< VectorXd >	LocalControlWeights ()
	Array of proportional weights corresponding to each ESPVLControl local controller in the LocalControlList. More...

ESPVLControlBatch &	LocalControlWeights (VectorXd &value)

std::vector< strings >	PVSystemList ()
	Array list of PVSystem objects to be dispatched by a Local Controller. More...

ESPVLControlBatch &	PVSystemList (strings &value)

std::vector< VectorXd >	PVSystemWeights ()
	Array of proportional weights corresponding to each PVSystem in the PVSystemList. More...

ESPVLControlBatch &	PVSystemWeights (VectorXd &value)

std::vector< strings >	StorageList ()
	Array list of Storage objects to be dispatched by Local Controller. More...

ESPVLControlBatch &	StorageList (strings &value)

std::vector< VectorXd >	StorageWeights ()
	Array of proportional weights corresponding to each Storage object in the StorageControlList. More...

ESPVLControlBatch &	StorageWeights (VectorXd &value)

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

ESPVLControlBatch &	basefreq (double value)

template<typename T >
ESPVLControlBatch &	basefreq (T &value)

template<typename T >
ESPVLControlBatch &	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...

ESPVLControlBatch &	enabled (bool value)

ESPVLControlBatch &	enabled (bools &value)

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

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

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 12

◆ Element()

strings dss::obj::ESPVLControlBatch::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()

std::vector< dss::obj::DSSObj > dss::obj::ESPVLControlBatch::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()

bools dss::obj::ESPVLControlBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 13

◆ kvarlimit()

BatchFloat64ArrayProxy dss::obj::ESPVLControlBatch::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()

BatchFloat64ArrayProxy dss::obj::ESPVLControlBatch::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

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 14

◆ LocalControlList()

std::vector< strings > dss::obj::ESPVLControlBatch::LocalControlList ( )

inline

Array list of ESPVLControl local controller objects to be dispatched by System Controller.

If not specified, all ESPVLControl devices with type=local in the circuit not attached to another controller are assumed to be part of this controller's fleet.

DSS property name: LocalControlList, DSS property index: 6

◆ LocalControlWeights()

std::vector< VectorXd > dss::obj::ESPVLControlBatch::LocalControlWeights ( )

inline

Array of proportional weights corresponding to each ESPVLControl local controller in the LocalControlList.

DSS property name: LocalControlWeights, DSS property index: 7

◆ PVSystemList()

std::vector< strings > dss::obj::ESPVLControlBatch::PVSystemList ( )

inline

Array list of PVSystem objects to be dispatched by a Local Controller.

DSS property name: PVSystemList, DSS property index: 8

◆ PVSystemWeights()

std::vector< VectorXd > dss::obj::ESPVLControlBatch::PVSystemWeights ( )

inline

Array of proportional weights corresponding to each PVSystem in the PVSystemList.

DSS property name: PVSystemWeights, DSS property index: 9

◆ StorageList()

std::vector< strings > dss::obj::ESPVLControlBatch::StorageList ( )

inline

Array list of Storage objects to be dispatched by Local Controller.

DSS property name: StorageList, DSS property index: 10

◆ StorageWeights()

std::vector< VectorXd > dss::obj::ESPVLControlBatch::StorageWeights ( )

inline

Array of proportional weights corresponding to each Storage object in the StorageControlList.

DSS property name: StorageWeights, DSS property index: 11

◆ Terminal()

BatchInt32ArrayProxy dss::obj::ESPVLControlBatch::Terminal ( )

inline

Number of the terminal of the circuit element to which the ESPVLControl 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

◆ Type()

BatchInt32ArrayProxy dss::obj::ESPVLControlBatch::Type ( )

inline

Type of controller.

1= System Controller; 2= Local controller.

DSS property name: Type, DSS property index: 3

◆ Type_str()

strings dss::obj::ESPVLControlBatch::Type_str ( )

inline

Type of controller.

1= System Controller; 2= Local controller.

DSS property name: Type, DSS property index: 3

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

include/dss_obj.hpp

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ basefreq()

◆ Element()

◆ Element_obj()

◆ enabled()

◆ kvarlimit()

◆ kWBand()

◆ like() [1/2]

◆ like() [2/2]

◆ LocalControlList()

◆ LocalControlWeights()

◆ PVSystemList()

◆ PVSystemWeights()

◆ StorageList()

◆ StorageWeights()

◆ Terminal()

◆ Type()

◆ Type_str()