dss::obj::LineSpacing Class Reference

Inheritance diagram for dss::obj::LineSpacing:

Collaboration diagram for dss::obj::LineSpacing:

Classes
struct	Properties

Public Member Functions
	LineSpacing (APIUtil *util=nullptr, void *ptr_=nullptr)
	Create wrapper directly by a given object handle/pointer.
	LineSpacing (APIUtil *util, int32_t idx)
	Create a wrapper for an element given by the integer index "idx".
	LineSpacing (APIUtil *util, char *name)
	Create a wrapper for an element given its name.
const char *	name ()
	Returns the object's name.
LineSpacing &	begin_edit ()
	Marks an object for edition. More...
LineSpacing &	end_edit (int32_t num_edits=1)
	Finalizes an object edition. More...
int32_t	nconds ()
	Number of wires in this geometry. More...
LineSpacing &	nconds (int32_t value)
int32_t	nphases ()
	Number of retained phase conductors. More...
LineSpacing &	nphases (int32_t value)
VectorXd	x ()
	Array of wire X coordinates. More...
LineSpacing &	x (VectorXd &value)
VectorXd	h ()
	Array of wire Heights. More...
LineSpacing &	h (VectorXd &value)
DimensionUnits	units ()
	Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined. More...
LineSpacing &	units (int32_t value)
LineSpacing &	units (DimensionUnits value)
LineSpacing &	units (const string &value)
LineSpacing &	units (const char *value)
string	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...
LineSpacing &	units_str (const string &value)
	Units for x and h: {mi|kft|km|m|Ft|in|cm } Initial default is "ft", but defaults to last unit defined. More...
LineSpacing &	like (const string &value)
	Make like another object, e.g. More...
LineSpacing &	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 [] = "LineSpacing"
static const int32_t	dss_cls_idx = 12

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

begin_edit()

LineSpacing & dss::obj::LineSpacing::begin_edit ( )

inline

Marks an object for edition.

Until end_edit is called, some actions are postponed.

end_edit()

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

h()

VectorXd dss::obj::LineSpacing::h ( )

inline

Array of wire Heights.

DSS property name: h, DSS property index: 4

like() [1/2]

LineSpacing & dss::obj::LineSpacing::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]

LineSpacing & dss::obj::LineSpacing::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()

int32_t dss::obj::LineSpacing::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()

int32_t dss::obj::LineSpacing::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()

DimensionUnits dss::obj::LineSpacing::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() [1/2]

string dss::obj::LineSpacing::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

units_str() [2/2]

LineSpacing & dss::obj::LineSpacing::units_str ( const string &  value )

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

VectorXd dss::obj::LineSpacing::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