dss::classic::ISwtControls Class Reference

Inheritance diagram for dss::classic::ISwtControls:

Collaboration diagram for dss::classic::ISwtControls:

Public Member Functions
	ISwtControls (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all SwtControl names in the circuit.
int32_t	Count ()
	Number of SwtControl objects in active circuit.
int32_t	First ()
	Sets the first SwtControl active. More...
string	Name ()
	Get the name of the current active SwtControl.
ISwtControls &	Name (const char *value)
	Sets the active SwtControl by Name.
ISwtControls &	Name (const string &value)
int32_t	Next ()
	Sets the next SwtControl active. More...
int32_t	idx ()
	Get active SwtControl by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active SwtControl by index; index is 1-based: 1..count.
void	Reset ()
int32_t	Action ()
	Open or Close the switch. More...
ISwtControls &	Action (int32_t value)
double	Delay ()
	Time delay [s] betwen arming and opening or closing the switch. More...
ISwtControls &	Delay (double value)
bool	IsLocked ()
	The lock prevents both manual and automatic switch operation.
ISwtControls &	IsLocked (bool value)
int32_t	NormalState ()
	Get/set Normal state of switch (see actioncodes) dssActionOpen or dssActionClose.
ISwtControls &	NormalState (int32_t value)
int32_t	State ()
	Set it to force the switch to a specified state, otherwise read its present state.
ISwtControls &	State (int32_t value)
string	SwitchedObj ()
	Full name of the switched element.
ISwtControls &	SwitchedObj (const char *value)
ISwtControls &	SwitchedObj (const string &value)
int32_t	SwitchedTerm ()
	Terminal number where the switch is located on the SwitchedObj.
ISwtControls &	SwitchedTerm (int32_t value)
Public Member Functions inherited from dss::ContextState
	ContextState (APIUtil *util)

Additional Inherited Members
Public Attributes inherited from dss::ContextState
void *	ctx
	Pointer to the DSSContext for easy access.
APIUtil *	api_util
	API utility functions.

Member Function Documentation

Action()

int32_t dss::classic::ISwtControls::Action ( )

inline

Open or Close the switch.

No effect if switch is locked. However, Reset removes any lock and then closes the switch (shelf state).

Delay()

double dss::classic::ISwtControls::Delay ( )

inline

Time delay [s] betwen arming and opening or closing the switch.

Control may reset before actually operating the switch.

First()

int32_t dss::classic::ISwtControls::First ( )

inline

Sets the first SwtControl active.

Returns 0 if no more.

Next()

int32_t dss::classic::ISwtControls::Next ( )

inline

Sets the next SwtControl active.

Returns 0 if no more.

---

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

• include/dss_classic.hpp