dss::obj::LineSpacingBatch Class Reference

Inheritance diagram for dss::obj::LineSpacingBatch:

Collaboration diagram for dss::obj::LineSpacingBatch:

Public Types
typedef LineSpacing::Properties	Properties
typedef LineSpacing	BatchElementClass

Public Member Functions
	LineSpacingBatch (APIUtil *util)
	Create a batch of all LineSpacing elements.
	LineSpacingBatch (APIUtil *util, int32_t prop_idx, int32_t prop_value)
	Create a batch of all LineSpacing elements that match an integer property value.
	LineSpacingBatch (APIUtil *util, const char *regexp)
	Create a batch of all LineSpacing elements that match a regular expression.
LineSpacingBatch &	begin_edit ()
LineSpacingBatch &	end_edit (int32_t num_edits=1)
BatchInt32ArrayProxy	nconds ()
	Number of wires in this geometry. More...
LineSpacingBatch &	nconds (int32_t value)
template<typename T >
LineSpacingBatch &	nconds (T &value)
template<typename T >
LineSpacingBatch &	nconds (typename T::iterator it_begin, typename T::iterator it_end)
BatchInt32ArrayProxy	nphases ()
	Number of retained phase conductors. More...
LineSpacingBatch &	nphases (int32_t value)
template<typename T >
LineSpacingBatch &	nphases (T &value)
template<typename T >
LineSpacingBatch &	nphases (typename T::iterator it_begin, typename T::iterator it_end)
std::vector< VectorXd >	x ()
	Array of wire X coordinates. More...
LineSpacingBatch &	x (VectorXd &value)
std::vector< VectorXd >	h ()
	Array of wire Heights. More...
LineSpacingBatch &	h (VectorXd &value)
BatchInt32ArrayProxy	units ()
	Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined. More...
LineSpacingBatch &	units (string &value)
LineSpacingBatch &	units (int32_t value)
LineSpacingBatch &	units (DimensionUnits value)
LineSpacingBatch &	units (strings &value)
LineSpacingBatch &	units (std::vector< int32_t > &value)
LineSpacingBatch &	units (std::vector< DimensionUnits > &value)
strings	units_str ()
	Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined. More...
LineSpacingBatch &	units_str (string &value)
LineSpacingBatch &	units_str (strings &value)
LineSpacingBatch &	like (const string &value)
	Make like another object, e.g. More...
LineSpacingBatch &	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

h()

std::vector< VectorXd > dss::obj::LineSpacingBatch::h ( )

inline

Array of wire Heights.

DSS property name: h, DSS property index: 4

like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 6

like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 6

nconds()

BatchInt32ArrayProxy dss::obj::LineSpacingBatch::nconds ( )

inline

Number of wires in this geometry.

Default is 3. Triggers memory allocations. Define first!

DSS property name: nconds, DSS property index: 1

nphases()

BatchInt32ArrayProxy dss::obj::LineSpacingBatch::nphases ( )

inline

Number of retained phase conductors.

If less than the number of wires, list the retained phase coordinates first.

DSS property name: nphases, DSS property index: 2

units()

BatchInt32ArrayProxy dss::obj::LineSpacingBatch::units ( )

inline

Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined.

DSS property name: units, DSS property index: 5

units_str()

strings dss::obj::LineSpacingBatch::units_str ( )

inline

Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined.

DSS property name: units, DSS property index: 5

x()

std::vector< VectorXd > dss::obj::LineSpacingBatch::x ( )

inline

Array of wire X coordinates.

DSS property name: x, DSS property index: 3

---

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

• include/dss_obj.hpp