Relays Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.Relays"]
Namespace: dss_sharp
The Relays type exposes the following members.
Name | Description | |
---|---|---|
AllNames |
Array of strings with all Relay names in the circuit.
| |
Count |
Number of Relay objects in active circuit.
| |
First |
Sets the first Relay active. Returns 0 if no more.
| |
idx |
Get/set active Relay by index; index is 1-based: 1..count
| |
MonitoredObj |
Full name of object this Relay is monitoring.
| |
MonitoredTerm |
Number of terminal of monitored element that this Relay is monitoring.
| |
Name |
Sets the active Relay by Name.
| |
Next |
Sets the next Relay active. Returns 0 if no more.
| |
NormalState |
Normal state of relay.
| |
State |
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.
| |
SwitchedObj |
Full name of element that will be switched when relay trips.
| |
SwitchedTerm |
Terminal number of the switched object that will be opened when the relay trips.
|
Name | Description | |
---|---|---|
CheckForError | (Inherited from ContextState.) | |
Close |
Close the switched object controlled by the relay. Resets relay to first operation.
| |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetContextHandle |
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
Open |
Open relay's controlled element and lock out the relay.
| |
Reset |
Reset relay to normal state.
If open, lock out the relay.
If closed, resets relay to first operation.
| |
ToString | (Inherited from Object.) |
Name | Description | |
---|---|---|
apiutil | (Inherited from ContextState.) | |
ctx | (Inherited from ContextState.) |