Inheritance diagram for dss::obj::PriceShapeBatch:

Collaboration diagram for dss::obj::PriceShapeBatch:

Public Types
typedef PriceShape::Properties	Properties

typedef PriceShape	BatchElementClass

typedef PriceShape::PriceShapeAction	PriceShapeAction

Public Member Functions
	PriceShapeBatch (APIUtil *util)
	Create a batch of all PriceShape elements.

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

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

PriceShapeBatch &	begin_edit ()

PriceShapeBatch &	end_edit (int32_t num_edits=1)

BatchInt32ArrayProxy	npts ()
	Max number of points to expect in price shape vectors. More...

PriceShapeBatch &	npts (int32_t value)

template<typename T >
PriceShapeBatch &	npts (T &value)

template<typename T >
PriceShapeBatch &	npts (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	interval ()
	Time interval for fixed interval data, hrs. More...

PriceShapeBatch &	interval (double value)

template<typename T >
PriceShapeBatch &	interval (T &value)

template<typename T >
PriceShapeBatch &	interval (typename T::iterator it_begin, typename T::iterator it_end)

std::vector< VectorXd >	price ()
	Array of Price values. More...

PriceShapeBatch &	price (VectorXd &value)

std::vector< VectorXd >	hour ()
	Array of hour values. More...

PriceShapeBatch &	hour (VectorXd &value)

BatchFloat64ArrayProxy	mean ()
	Mean of the Price curve values. More...

PriceShapeBatch &	mean (double value)

template<typename T >
PriceShapeBatch &	mean (T &value)

template<typename T >
PriceShapeBatch &	mean (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	stddev ()
	Standard deviation of the Prices. More...

PriceShapeBatch &	stddev (double value)

template<typename T >
PriceShapeBatch &	stddev (T &value)

template<typename T >
PriceShapeBatch &	stddev (typename T::iterator it_begin, typename T::iterator it_end)

strings	csvfile ()
	Switch input of Price curve data to a csv file containing (hour, Price) points, or simply (Price) values for fixed time interval data, one per line. More...

PriceShapeBatch &	csvfile (const string &value)

PriceShapeBatch &	csvfile (strings &value)

strings	sngfile ()
	Switch input of Price curve data to a binary file of singles containing (hour, Price) points, or simply (Price) values for fixed time interval data, packed one after another. More...

PriceShapeBatch &	sngfile (const string &value)

PriceShapeBatch &	sngfile (strings &value)

strings	dblfile ()
	Switch input of Price curve data to a binary file of doubles containing (hour, Price) points, or simply (Price) values for fixed time interval data, packed one after another. More...

PriceShapeBatch &	dblfile (const string &value)

PriceShapeBatch &	dblfile (strings &value)

BatchFloat64ArrayProxy	sinterval ()
	Specify fixed interval in SECONDS. More...

PriceShapeBatch &	sinterval (double value)

template<typename T >
PriceShapeBatch &	sinterval (T &value)

template<typename T >
PriceShapeBatch &	sinterval (typename T::iterator it_begin, typename T::iterator it_end)

BatchFloat64ArrayProxy	minterval ()
	Specify fixed interval in MINUTES. More...

PriceShapeBatch &	minterval (double value)

template<typename T >
PriceShapeBatch &	minterval (T &value)

template<typename T >
PriceShapeBatch &	minterval (typename T::iterator it_begin, typename T::iterator it_end)

PriceShapeBatch &	action (int32_t value)
	{DblSave \| SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single. More...

PriceShapeBatch &	action (PriceShape::PriceShapeAction value)
	{DblSave \| SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single. More...

PriceShapeBatch &	action (const string &value)
	{DblSave \| SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single. More...

PriceShapeBatch &	action (const char *value)
	{DblSave \| SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single. More...

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

PriceShapeBatch &	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

◆ action() [1/4]

PriceShapeBatch & dss::obj::PriceShapeBatch::action ( const char * value )

inline

{DblSave | SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single.

The filename is the PriceShape name.

DSS property name: action, DSS property index: 12

◆ action() [2/4]

PriceShapeBatch & dss::obj::PriceShapeBatch::action ( const string & value )

inline

{DblSave | SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single.

The filename is the PriceShape name.

DSS property name: action, DSS property index: 12

◆ action() [3/4]

PriceShapeBatch & dss::obj::PriceShapeBatch::action ( int32_t value )

inline

{DblSave | SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single.

The filename is the PriceShape name.

DSS property name: action, DSS property index: 12

◆ action() [4/4]

PriceShapeBatch & dss::obj::PriceShapeBatch::action ( PriceShape::PriceShapeAction value )

inline

{DblSave | SngSave} After defining Price curve data... Setting action=DblSave or SngSave will cause the present "Price" values to be written to either a packed file of double or single.

The filename is the PriceShape name.

DSS property name: action, DSS property index: 12

◆ csvfile()

strings dss::obj::PriceShapeBatch::csvfile ( )

inline

Switch input of Price curve data to a csv file containing (hour, Price) points, or simply (Price) values for fixed time interval data, one per line.

NOTE: This action may reset the number of points to a lower value.

DSS property name: csvfile, DSS property index: 7

◆ dblfile()

strings dss::obj::PriceShapeBatch::dblfile ( )

inline

Switch input of Price curve data to a binary file of doubles containing (hour, Price) points, or simply (Price) values for fixed time interval data, packed one after another.

NOTE: This action may reset the number of points to a lower value.

DSS property name: dblfile, DSS property index: 9

◆ hour()

std::vector< VectorXd > dss::obj::PriceShapeBatch::hour ( )

inline

Array of hour values.

Only necessary to define this property for variable interval data. If the data are fixed interval, do not use this property. You can also use the syntax: hour = (file=filename) !for text file one value per line hour = (dblfile=filename) !for packed file of doubles hour = (sngfile=filename) !for packed file of singles

DSS property name: hour, DSS property index: 4

◆ interval()

BatchFloat64ArrayProxy dss::obj::PriceShapeBatch::interval ( )

inline

Time interval for fixed interval data, hrs.

Default = 1. If Interval = 0 then time data (in hours) may be at irregular intervals and time value must be specified using either the Hour property or input files. Then values are interpolated when Interval=0, but not for fixed interval data.

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 13

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 13

◆ mean()

BatchFloat64ArrayProxy dss::obj::PriceShapeBatch::mean ( )

inline

Mean of the Price curve values.

This is computed on demand the first time a value is needed. However, you may set it to another value independently. Used for Monte Carlo load simulations.

DSS property name: mean, DSS property index: 5

◆ minterval()

BatchFloat64ArrayProxy dss::obj::PriceShapeBatch::minterval ( )

inline

Specify fixed interval in MINUTES.

Alternate way to specify Interval property.

DSS property name: minterval, DSS property index: 11

◆ npts()

BatchInt32ArrayProxy dss::obj::PriceShapeBatch::npts ( )

inline

Max number of points to expect in price shape vectors.

This gets reset to the number of Price values found if less than specified.

DSS property name: npts, DSS property index: 1

◆ price()

std::vector< VectorXd > dss::obj::PriceShapeBatch::price ( )

inline

Array of Price values.

Units should be compatible with the object using the data. You can also use the syntax: Price = (file=filename) !for text file one value per line Price = (dblfile=filename) !for packed file of doubles Price = (sngfile=filename) !for packed file of singles

Note: this property will reset Npts if the number of values in the files are fewer.

DSS property name: price, DSS property index: 3

◆ sinterval()

BatchFloat64ArrayProxy dss::obj::PriceShapeBatch::sinterval ( )

inline

Specify fixed interval in SECONDS.

Alternate way to specify Interval property.

DSS property name: sinterval, DSS property index: 10

◆ sngfile()

strings dss::obj::PriceShapeBatch::sngfile ( )

inline

Switch input of Price curve data to a binary file of singles containing (hour, Price) points, or simply (Price) values for fixed time interval data, packed one after another.

NOTE: This action may reset the number of points to a lower value.

DSS property name: sngfile, DSS property index: 8

◆ stddev()

BatchFloat64ArrayProxy dss::obj::PriceShapeBatch::stddev ( )

inline

Standard deviation of the Prices.

This is computed on demand the first time a value is needed. However, you may set it to another value independently.Is overwritten if you subsequently read in a curve

Used for Monte Carlo load simulations.

DSS property name: stddev, DSS property index: 6

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

◆ action() [1/4]

◆ action() [2/4]

◆ action() [3/4]

◆ action() [4/4]

◆ csvfile()

◆ dblfile()

◆ hour()

◆ interval()

◆ like() [1/2]

◆ like() [2/2]

◆ mean()

◆ minterval()

◆ npts()

◆ price()

◆ sinterval()

◆ sngfile()

◆ stddev()