Inheritance diagram for dss::obj::SensorBatch:

Collaboration diagram for dss::obj::SensorBatch:

Public Types
typedef Sensor::Properties	Properties

typedef Sensor	BatchElementClass

Public Member Functions
	SensorBatch (APIUtil *util)
	Create a batch of all Sensor elements.

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

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

SensorBatch &	begin_edit ()

SensorBatch &	end_edit (int32_t num_edits=1)

strings	element ()
	Name (Full Object name) of element to which the Sensor is connected. More...

SensorBatch &	element (dss::obj::DSSObj &value)

SensorBatch &	element (const string &value)

std::vector< dss::obj::DSSObj >	element_obj ()
	Name (Full Object name) of element to which the Sensor is connected. More...

SensorBatch &	element_obj (dss::obj::DSSObj &value)

BatchInt32ArrayProxy	terminal ()
	Number of the terminal of the circuit element to which the Sensor is connected. More...

SensorBatch &	terminal (int32_t value)

template<typename T >
SensorBatch &	terminal (T &value)

template<typename T >
SensorBatch &	terminal (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	kvbase ()
	Voltage base for the sensor, in kV. More...

SensorBatch &	kvbase (double value)

template<typename T >
SensorBatch &	kvbase (T &value)

template<typename T >
SensorBatch &	kvbase (typename T::iterator it_begin, typename T::iterator it_end)

bools	clear ()
	{ Yes \| No }. More...

SensorBatch &	clear (bool value)

SensorBatch &	clear (bools &value)

std::vector< VectorXd >	kVs ()
	Array of Voltages (kV) measured by the voltage sensor. More...

SensorBatch &	kVs (VectorXd &value)

std::vector< VectorXd >	currents ()
	Array of Currents (amps) measured by the current sensor. More...

SensorBatch &	currents (VectorXd &value)

std::vector< VectorXd >	kWs ()
	Array of Active power (kW) measurements at the sensor. More...

SensorBatch &	kWs (VectorXd &value)

std::vector< VectorXd >	kvars ()
	Array of Reactive power (kvar) measurements at the sensor. More...

SensorBatch &	kvars (VectorXd &value)

BatchInt32ArrayProxy	conn ()
	Voltage sensor Connection: { wye \| delta \| LN \| LL }. More...

SensorBatch &	conn (string &value)

SensorBatch &	conn (int32_t value)

SensorBatch &	conn (Connection value)

SensorBatch &	conn (strings &value)

SensorBatch &	conn (std::vector< int32_t > &value)

SensorBatch &	conn (std::vector< Connection > &value)

strings	conn_str ()
	Voltage sensor Connection: { wye \| delta \| LN \| LL }. More...

SensorBatch &	conn_str (string &value)

SensorBatch &	conn_str (strings &value)

BatchInt32ArrayProxy	Deltadirection ()
	{1 or -1} Default is 1: 1-2, 2-3, 3-1. More...

SensorBatch &	Deltadirection (int32_t value)

template<typename T >
SensorBatch &	Deltadirection (T &value)

template<typename T >
SensorBatch &	Deltadirection (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	pctError ()
	Assumed percent error in the measurement. More...

SensorBatch &	pctError (double value)

template<typename T >
SensorBatch &	pctError (T &value)

template<typename T >
SensorBatch &	pctError (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	Weight ()
	Weighting factor: Default is 1. More...

SensorBatch &	Weight (double value)

template<typename T >
SensorBatch &	Weight (T &value)

template<typename T >
SensorBatch &	Weight (typename T::iterator it_begin, typename T::iterator it_end)

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

SensorBatch &	basefreq (double value)

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

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

SensorBatch &	enabled (bool value)

SensorBatch &	enabled (bools &value)

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

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

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 13

◆ clear()

bools dss::obj::SensorBatch::clear ( )

inline

{ Yes | No }.

Clear=Yes clears sensor values. Should be issued before putting in a new set of measurements.

DSS property name: clear, DSS property index: 4

◆ conn()

BatchInt32ArrayProxy dss::obj::SensorBatch::conn ( )

inline

Voltage sensor Connection: { wye | delta | LN | LL }.

Default is wye. Applies to voltage measurement only. Currents are always assumed to be line currents. If wye or LN, voltage is assumed measured line-neutral; otherwise, line-line.

DSS property name: conn, DSS property index: 9

◆ conn_str()

strings dss::obj::SensorBatch::conn_str ( )

inline

Voltage sensor Connection: { wye | delta | LN | LL }.

Default is wye. Applies to voltage measurement only. Currents are always assumed to be line currents. If wye or LN, voltage is assumed measured line-neutral; otherwise, line-line.

DSS property name: conn, DSS property index: 9

◆ currents()

std::vector< VectorXd > dss::obj::SensorBatch::currents ( )

inline

Array of Currents (amps) measured by the current sensor.

Specify this or power quantities; not both.

DSS property name: currents, DSS property index: 6

◆ Deltadirection()

BatchInt32ArrayProxy dss::obj::SensorBatch::Deltadirection ( )

inline

{1 or -1} Default is 1: 1-2, 2-3, 3-1.

For reverse rotation, enter -1. Any positive or negative entry will suffice.

DSS property name: Deltadirection, DSS property index: 10

◆ element()

strings dss::obj::SensorBatch::element ( )

inline

Name (Full Object name) of element to which the Sensor is connected.

DSS property name: element, DSS property index: 1

◆ element_obj()

std::vector< dss::obj::DSSObj > dss::obj::SensorBatch::element_obj ( )

inline

Name (Full Object name) of element to which the Sensor is connected.

DSS property name: element, DSS property index: 1

◆ enabled()

bools dss::obj::SensorBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 14

◆ kvars()

std::vector< VectorXd > dss::obj::SensorBatch::kvars ( )

inline

Array of Reactive power (kvar) measurements at the sensor.

Is converted into Currents along with p=[...]

DSS property name: kvars, DSS property index: 8

◆ kvbase()

BatchFloat64ArrayProxy dss::obj::SensorBatch::kvbase ( )

inline

Voltage base for the sensor, in kV.

If connected to a 2- or 3-phase terminal, specify L-L voltage. For 1-phase devices specify L-N or actual 1-phase voltage. Like many other DSS devices, default is 12.47kV.

DSS property name: kvbase, DSS property index: 3

◆ kVs()

std::vector< VectorXd > dss::obj::SensorBatch::kVs ( )

inline

Array of Voltages (kV) measured by the voltage sensor.

For Delta-connected sensors, Line-Line voltages are expected. For Wye, Line-Neutral are expected.

DSS property name: kVs, DSS property index: 5

◆ kWs()

std::vector< VectorXd > dss::obj::SensorBatch::kWs ( )

inline

Array of Active power (kW) measurements at the sensor.

Is converted into Currents along with q=[...] Will override any currents=[...] specification.

DSS property name: kWs, DSS property index: 7

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 15

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 15

◆ pctError()

BatchFloat64ArrayProxy dss::obj::SensorBatch::pctError ( )

inline

Assumed percent error in the measurement.

Default is 1.

DSS property name: Error, DSS property index: 11

◆ terminal()

BatchInt32ArrayProxy dss::obj::SensorBatch::terminal ( )

inline

Number of the terminal of the circuit element to which the Sensor is connected.

1 or 2, typically. Default is 1.

DSS property name: terminal, DSS property index: 2

◆ Weight()

BatchFloat64ArrayProxy dss::obj::SensorBatch::Weight ( )

inline

Weighting factor: Default is 1.

DSS property name: Weight, DSS property index: 12

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()

◆ clear()

◆ conn()

◆ conn_str()

◆ currents()

◆ Deltadirection()

◆ element()

◆ element_obj()

◆ enabled()

◆ kvars()

◆ kvbase()

◆ kVs()

◆ kWs()

◆ like() [1/2]

◆ like() [2/2]

◆ pctError()

◆ terminal()

◆ Weight()