Click or drag to resize

Relays Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.Relays"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
Syntax
public class Relays : ContextState

The Relays type exposes the following members.

Constructors
  NameDescription
Public methodRelays
Initializes a new instance of the Relays class
Top
Properties
  NameDescription
Public propertyAllNames
Array of strings with all Relay names in the circuit.
Public propertyCount
Number of Relay objects in active circuit.
Public propertyFirst
Sets the first Relay active. Returns 0 if no more.
Public propertyidx
Get/set active Relay by index; index is 1-based: 1..count
Public propertyMonitoredObj
Full name of object this Relay is monitoring.
Public propertyMonitoredTerm
Number of terminal of monitored element that this Relay is monitoring.
Public propertyName
Sets the active Relay by Name.
Public propertyNext
Sets the next Relay active. Returns 0 if no more.
Public propertyNormalState
Normal state of relay.
Public propertyState
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.
Public propertySwitchedObj
Full name of element that will be switched when relay trips.
Public propertySwitchedTerm
Terminal number of the switched object that will be opened when the relay trips.
Top
Methods
  NameDescription
Protected methodCheckForError (Inherited from ContextState.)
Public methodClose
Close the switched object controlled by the relay. Resets relay to first operation.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodOpen
Open relay's controlled element and lock out the relay.
Public methodReset
Reset relay to normal state. If open, lock out the relay. If closed, resets relay to first operation.
Public methodToString (Inherited from Object.)
Top
Fields
  NameDescription
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
Top
See Also