Click or drag to resize

CtrlQueue Class

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

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

Inheritance Hierarchy

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

The CtrlQueue type exposes the following members.

Constructors
  NameDescription
Public methodCtrlQueue
Initializes a new instance of the CtrlQueue class
Top
Properties
  NameDescription
Public propertyAction
(write-only) Set the active action by index
Public propertyActionCode
Code for the active action. Long integer code to tell the control device what to do
Public propertyDeviceHandle
Handle (User defined) to device that must act on the pending action.
Public propertyNumActions
Number of Actions on the current actionlist (that have been popped off the control queue by CheckControlActions)
Public propertyPopAction
Pops next action off the action list and makes it the active action. Returns zero if none.
Public propertyQueue
Array of strings containing the entire queue in CSV format
Public propertyQueueSize
Number of items on the OpenDSS control Queue
Top
Methods
  NameDescription
Protected methodCheckForError (Inherited from ContextState.)
Public methodClearActions
Public methodClearQueue
Public methodDelete
Public methodDoAllQueue
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 methodPush
Push a control action onto the DSS control queue by time, action code, and device handle (user defined). Returns Control Queue handle.
Public methodShow
Public methodToString (Inherited from Object.)
Top
Fields
  NameDescription
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
Top
See Also