 | CtrlQueue Class |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:dss_sharp.CtrlQueue"]
Inheritance HierarchyNamespace: dss_sharp
Assembly: dss_sharp (in dss_sharp.dll) Version: 1.0.0
SyntaxThe CtrlQueue type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Action |
(write-only) Set the active action by index
|
| ActionCode |
Code for the active action. Long integer code to tell the control device what to do
|
| DeviceHandle |
Handle (User defined) to device that must act on the pending action.
|
| NumActions |
Number of Actions on the current actionlist (that have been popped off the control queue by CheckControlActions)
|
| PopAction |
Pops next action off the action list and makes it the active action. Returns zero if none.
|
| Queue |
Array of strings containing the entire queue in CSV format
|
| QueueSize |
Number of items on the OpenDSS control Queue
|
Methods| Name | Description | |
|---|---|---|
 | CheckForError | (Inherited from ContextState.) |
 | ClearActions | |
| ClearQueue | |
| Delete | |
| DoAllQueue | |
| 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.) |
| Push |
Push a control action onto the DSS control queue by time, action code, and device handle (user defined). Returns Control Queue handle.
|
| Show | |
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | apiutil | (Inherited from ContextState.) |
| ctx | (Inherited from ContextState.) |
See Also