`dss.ICtrlQueue`#

Module Contents#

Classes#

ICtrlQueue

API#

class dss.ICtrlQueue.ICtrlQueue(api_util, prefer_lists=False)#

Bases: dss._cffi_api_util.Base

property Action: int#

(write-only) Set the active action by index

Original COM help: https://opendss.epri.com/Action.html

property ActionCode: int#

Code for the active action. Integer code to tell the control device what to do.

Use this to determine what the user-defined controls are supposed to do. It can be any 32-bit integer of the user’s choosing and is the same value that the control pushed onto the control queue earlier.

Original COM help: https://opendss.epri.com/ActionCode.html

ClearActions()#

Clear all actions from the Control Proxy’s Action List (they are popped off the list).

Original COM help: https://opendss.epri.com/ClearActions.html

ClearQueue()#

Clear the control queue.

Original COM help: https://opendss.epri.com/ClearQueue.html

Delete(ActionHandle)#

Delete an Action from the DSS Control Queue by the handle that is returned when the action is added.

(The Push function returns the handle.)

Original COM help: https://opendss.epri.com/Delete.html

property DeviceHandle: int#

Handle (User defined) to device that must act on the pending action.

The user-written code driving the interface may support more than one control element as necessary to perform the simulation. This handle is an index returned to the user program that lets the program know which control is to perform the active action.

Original COM help: https://opendss.epri.com/DeviceHandle.html

DoAllQueue()#

Execute all actions currently on the Control Queue.

Side effect: clears the queue.

Original COM help: https://opendss.epri.com/DoAllQueue.html

property NumActions: int#

Number of Actions on the current action list (that have been popped off the control queue by CheckControlActions)

Original COM help: https://opendss.epri.com/NumActions.html

property PopAction: int#

Pops next action off the action list and makes it the active action. Returns zero if none.

Original COM help: https://opendss.epri.com/PopAction.html

Push(Hour: int, Seconds: float, ActionCode: int, DeviceHandle: int)#