dss::classic::IRelays Class Reference

Inheritance diagram for dss::classic::IRelays:

Collaboration diagram for dss::classic::IRelays:

Public Member Functions
	IRelays (dss::APIUtil *util)
strings	AllNames ()
	Array of strings with all Relay names in the circuit.
int32_t	Count ()
	Number of Relay objects in active circuit.
int32_t	First ()
	Sets the first Relay active. More...
string	Name ()
	Get the name of the current active Relay.
IRelays &	Name (const char *value)
	Sets the active Relay by Name.
IRelays &	Name (const string &value)
int32_t	Next ()
	Sets the next Relay active. More...
int32_t	idx ()
	Get active Relay by index; index is 1-based: 1..count.
void	idx (int32_t value)
	Get active Relay by index; index is 1-based: 1..count.
string	MonitoredObj ()
	Full name of object this Relay is monitoring.
IRelays &	MonitoredObj (const char *value)
IRelays &	MonitoredObj (const string &value)
int32_t	MonitoredTerm ()
	Number of terminal of monitored element that this Relay is monitoring.
IRelays &	MonitoredTerm (int32_t value)
string	SwitchedObj ()
	Full name of element that will be switched when relay trips.
IRelays &	SwitchedObj (const char *value)
IRelays &	SwitchedObj (const string &value)
int32_t	SwitchedTerm ()
	Terminal number of the switched object that will be opened when the relay trips.
IRelays &	SwitchedTerm (int32_t value)
void	Open ()
	Open relay's controlled element and lock out the relay.
void	Close ()
	Close the switched object controlled by the relay. More...
void	Reset ()
	Reset relay to normal state. More...
int32_t	State ()
	Get/Set present state of relay. More...
IRelays &	State (int32_t value)
int32_t	NormalState ()
	Normal state of relay.
IRelays &	NormalState (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

Close()

void dss::classic::IRelays::Close ( )

inline

Close the switched object controlled by the relay.

Resets relay to first operation.

First()

int32_t dss::classic::IRelays::First ( )

inline

Sets the first Relay active.

Returns 0 if no more.

Next()

int32_t dss::classic::IRelays::Next ( )

inline

Sets the next Relay active.

Returns 0 if no more.

Reset()

void dss::classic::IRelays::Reset ( )

inline

Reset relay to normal state.

If open, lock out the relay. If closed, resets relay to first operation.

State()

int32_t dss::classic::IRelays::State ( )

inline

Get/Set present state of relay.

If set to open, open relay's controlled element and lock out the relay. If set to close, close relay's controlled element and resets relay to first operation.

---

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

• include/dss_classic.hpp