Inheritance diagram for dss::classic::ICtrlQueue:

Collaboration diagram for dss::classic::ICtrlQueue:

Public Member Functions
	ICtrlQueue (dss::APIUtil *util)

void	ClearActions ()

void	ClearQueue ()

void	Delete (int32_t ActionHandle)

void	DoAllQueue ()

void	Show ()

int32_t	ActionCode ()
	Code for the active action. More...

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

int32_t	NumActions ()
	Number of Actions on the current actionlist (that have been popped off the control queue by CheckControlActions)

int32_t	Push (int32_t Hour, double Seconds, int32_t ActionCode, int32_t DeviceHandle)
	Push a control action onto the DSS control queue by time, action code, and device handle (user defined). More...

int32_t	PopAction ()
	Pops next action off the action list and makes it the active action. More...

strings	Queue ()
	Array of strings containing the entire queue in CSV format.

int32_t	QueueSize ()
	Number of items on the OpenDSS control Queue.

ICtrlQueue &	Action (int32_t value)
	(write-only) Set the active action by index

Public Member Functions inherited from dss::ContextState
	ContextState (APIUtil *util)

Additional Inherited Members
Public Attributes inherited from dss::ContextState
void *	ctx
	Pointer to the DSSContext for easy access.

APIUtil *	api_util
	API utility functions.

Member Function Documentation

◆ ActionCode()

int32_t dss::classic::ICtrlQueue::ActionCode ( )

inline

Code for the active action.

Long integer code to tell the control device what to do

int32_t dss::classic::ICtrlQueue::PopAction ( )

inline

Pops next action off the action list and makes it the active action.

Returns zero if none.

int32_t dss::classic::ICtrlQueue::Push	(	int32_t	Hour,
		double	Seconds,
		int32_t	ActionCode,
		int32_t	DeviceHandle
	)

inline

Push a control action onto the DSS control queue by time, action code, and device handle (user defined).

Returns Control Queue handle.

The documentation for this class was generated from the following file: