 | SwtControls Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.SwtControls"]
Inheritance HierarchyNamespace: dss_sharp
Assembly: dss_sharp (in dss_sharp.dll) Version: 1.0.0
SyntaxThe SwtControls type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SwtControls | Initializes a new instance of the SwtControls class |
Properties| Name | Description | |
|---|---|---|
 | Action |
Open or Close the switch. No effect if switch is locked. However, Reset removes any lock and then closes the switch (shelf state).
|
| AllNames |
Array of strings with all SwtControl names in the circuit.
|
| Count |
Number of SwtControl objects in active circuit.
|
| Delay |
Time delay [s] betwen arming and opening or closing the switch. Control may reset before actually operating the switch.
|
| First |
Sets the first SwtControl active. Returns 0 if no more.
|
| idx |
Get/set active SwtControl by index; index is 1-based: 1..count
|
| IsLocked |
The lock prevents both manual and automatic switch operation.
|
| Name |
Sets the active SwtControl by Name.
|
| Next |
Sets the next SwtControl active. Returns 0 if no more.
|
| NormalState |
Get/set Normal state of switch (see actioncodes) dssActionOpen or dssActionClose
|
| State |
Set it to force the switch to a specified state, otherwise read its present state.
|
| SwitchedObj |
Full name of the switched element.
|
| SwitchedTerm |
Terminal number where the switch is located on the SwitchedObj
|
Methods| Name | Description | |
|---|---|---|
 | CheckForError | (Inherited from ContextState.) |
| 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.) |
| Reset | |
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | apiutil | (Inherited from ContextState.) |
| ctx | (Inherited from ContextState.) |
See Also