Inheritance diagram for dss::obj::SwtControlBatch:

Collaboration diagram for dss::obj::SwtControlBatch:

Public Types
typedef SwtControl::Properties	Properties

typedef SwtControl	BatchElementClass

typedef SwtControl::SwtControlAction	SwtControlAction

typedef SwtControl::SwtControlState	SwtControlState

Public Member Functions
	SwtControlBatch (APIUtil *util)
	Create a batch of all SwtControl elements.

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

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

SwtControlBatch &	begin_edit ()

SwtControlBatch &	end_edit (int32_t num_edits=1)

strings	SwitchedObj ()
	Name of circuit element switch that the SwtControl operates. More...

SwtControlBatch &	SwitchedObj (dss::obj::DSSObj &value)

SwtControlBatch &	SwitchedObj (const string &value)

std::vector< dss::obj::DSSObj >	SwitchedObj_obj ()
	Name of circuit element switch that the SwtControl operates. More...

SwtControlBatch &	SwitchedObj_obj (dss::obj::DSSObj &value)

BatchInt32ArrayProxy	SwitchedTerm ()
	Terminal number of the controlled element switch. More...

SwtControlBatch &	SwitchedTerm (int32_t value)

template<typename T >
SwtControlBatch &	SwitchedTerm (T &value)

template<typename T >
SwtControlBatch &	SwitchedTerm (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Action ()
	{Open \| Close} After specified delay time, and if not locked, causes the controlled switch to open or close. More...

SwtControlBatch &	Action (string &value)

SwtControlBatch &	Action (int32_t value)

SwtControlBatch &	Action (SwtControl::SwtControlAction value)

SwtControlBatch &	Action (strings &value)

SwtControlBatch &	Action (std::vector< int32_t > &value)

SwtControlBatch &	Action (std::vector< SwtControl::SwtControlAction > &value)

strings	Action_str ()
	{Open \| Close} After specified delay time, and if not locked, causes the controlled switch to open or close. More...

SwtControlBatch &	Action_str (string &value)

SwtControlBatch &	Action_str (strings &value)

bools	Lock ()
	{Yes \| No} Delayed action. More...

SwtControlBatch &	Lock (bool value)

SwtControlBatch &	Lock (bools &value)

BatchFloat64ArrayProxy	Delay ()
	Operating time delay (sec) of the switch. More...

SwtControlBatch &	Delay (double value)

template<typename T >
SwtControlBatch &	Delay (T &value)

template<typename T >
SwtControlBatch &	Delay (typename T::iterator it_begin, typename T::iterator it_end)

BatchInt32ArrayProxy	Normal ()
	{Open \| Closed] Normal state of the switch. More...

SwtControlBatch &	Normal (string &value)

SwtControlBatch &	Normal (int32_t value)

SwtControlBatch &	Normal (SwtControl::SwtControlState value)

SwtControlBatch &	Normal (strings &value)

SwtControlBatch &	Normal (std::vector< int32_t > &value)

SwtControlBatch &	Normal (std::vector< SwtControl::SwtControlState > &value)

strings	Normal_str ()
	{Open \| Closed] Normal state of the switch. More...

SwtControlBatch &	Normal_str (string &value)

SwtControlBatch &	Normal_str (strings &value)

BatchInt32ArrayProxy	State ()
	{Open \| Closed] Present state of the switch. More...

SwtControlBatch &	State (string &value)

SwtControlBatch &	State (int32_t value)

SwtControlBatch &	State (SwtControl::SwtControlState value)

SwtControlBatch &	State (strings &value)

SwtControlBatch &	State (std::vector< int32_t > &value)

SwtControlBatch &	State (std::vector< SwtControl::SwtControlState > &value)

strings	State_str ()
	{Open \| Closed] Present state of the switch. More...

SwtControlBatch &	State_str (string &value)

SwtControlBatch &	State_str (strings &value)

SwtControlBatch &	Reset (bool value)
	{Yes \| No} If Yes, forces Reset of switch to Normal state and removes Lock independently of any internal reset command for mode change, etc. More...

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

SwtControlBatch &	basefreq (double value)

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

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

SwtControlBatch &	enabled (bool value)

SwtControlBatch &	enabled (bools &value)

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

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

BatchInt32ArrayProxy dss::obj::SwtControlBatch::Action ( )

inline

{Open | Close} After specified delay time, and if not locked, causes the controlled switch to open or close.

DSS property name: Action, DSS property index: 3

◆ Action_str()

strings dss::obj::SwtControlBatch::Action_str ( )

inline

{Open | Close} After specified delay time, and if not locked, causes the controlled switch to open or close.

DSS property name: Action, DSS property index: 3

◆ basefreq()

BatchFloat64ArrayProxy dss::obj::SwtControlBatch::basefreq ( )

inline

Base Frequency for ratings.

DSS property name: basefreq, DSS property index: 9

◆ Delay()

BatchFloat64ArrayProxy dss::obj::SwtControlBatch::Delay ( )

inline

Operating time delay (sec) of the switch.

Defaults to 120.

DSS property name: Delay, DSS property index: 5

◆ enabled()

bools dss::obj::SwtControlBatch::enabled ( )

inline

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

DSS property name: enabled, DSS property index: 10

◆ like() [1/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 11

◆ like() [2/2]

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

inline

Make like another object, e.g.

:

New Capacitor.C2 like=c1 ...

DSS property name: like, DSS property index: 11

◆ Lock()

bools dss::obj::SwtControlBatch::Lock ( )

inline

{Yes | No} Delayed action.

Sends CTRL_LOCK or CTRL_UNLOCK message to control queue. After delay time, controlled switch is locked in its present open / close state or unlocked. Switch will not respond to either manual (Action) or automatic (COM interface) control or internal OpenDSS Reset when locked.

DSS property name: Lock, DSS property index: 4

◆ Normal()

BatchInt32ArrayProxy dss::obj::SwtControlBatch::Normal ( )

inline

{Open | Closed] Normal state of the switch.

If not Locked, the switch reverts to this state for reset, change of mode, etc. Defaults to first Action or State specified if not specifically declared.

DSS property name: Normal, DSS property index: 6

◆ Normal_str()

strings dss::obj::SwtControlBatch::Normal_str ( )

inline

{Open | Closed] Normal state of the switch.

If not Locked, the switch reverts to this state for reset, change of mode, etc. Defaults to first Action or State specified if not specifically declared.

DSS property name: Normal, DSS property index: 6

◆ Reset()

SwtControlBatch & dss::obj::SwtControlBatch::Reset ( bool value )

inline

{Yes | No} If Yes, forces Reset of switch to Normal state and removes Lock independently of any internal reset command for mode change, etc.

DSS property name: Reset, DSS property index: 8

◆ State()

BatchInt32ArrayProxy dss::obj::SwtControlBatch::State ( )

inline

{Open | Closed] Present state of the switch.

Upon setting, immediately forces state of switch.

DSS property name: State, DSS property index: 7

◆ State_str()

strings dss::obj::SwtControlBatch::State_str ( )

inline

{Open | Closed] Present state of the switch.

Upon setting, immediately forces state of switch.

DSS property name: State, DSS property index: 7

◆ SwitchedObj()

strings dss::obj::SwtControlBatch::SwitchedObj ( )

inline

Name of circuit element switch that the SwtControl operates.

Specify the full object class and name.

DSS property name: SwitchedObj, DSS property index: 1

◆ SwitchedObj_obj()

std::vector< dss::obj::DSSObj > dss::obj::SwtControlBatch::SwitchedObj_obj ( )

inline

Name of circuit element switch that the SwtControl operates.

Specify the full object class and name.

DSS property name: SwitchedObj, DSS property index: 1

◆ SwitchedTerm()

BatchInt32ArrayProxy dss::obj::SwtControlBatch::SwitchedTerm ( )

inline

Terminal number of the controlled element switch.

1 or 2, typically. Default is 1.

DSS property name: SwitchedTerm, DSS property index: 2

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

◆ Action_str()

◆ basefreq()

◆ Delay()

◆ enabled()

◆ like() [1/2]

◆ like() [2/2]

◆ Lock()

◆ Normal()

◆ Normal_str()

◆ Reset()

◆ State()

◆ State_str()

◆ SwitchedObj()

◆ SwitchedObj_obj()

◆ SwitchedTerm()