CircuitLockedInterface Class Reference

The CircuitLockedInterface allows power control drivers to provide TheSky a means to lock a circuit. A locked circuit is still visible but its state cannot be changed. More...

#include <circuitlockedinterface.h>

Public Member Functions
virtual int	circuitLocked (const int &nIndex, bool &bZeroForNoOneForLocked)=0

Detailed Description

The CircuitLockedInterface allows power control drivers to provide TheSky a means to lock a circuit. A locked circuit is still visible but its state cannot be changed.

This interface is optional. By default, TheSky will consider all circuits unlocked.

Don't forget to respond accordingly in your queryAbstraction().

Member Function Documentation

circuitLocked()

virtual int CircuitLockedInterface::circuitLocked ( const int &  nIndex, bool &  bZeroForNoOneForLocked  )

pure virtual

Called by TheSky to query if a particular circuit is locked or not.

Parameters

nZeroBasedIndex	(in) the zero based index of the circuit.
bZeroForNoOneForLocked	(out) returns if the circuit is locked or not.

---

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

• licensedinterfaces/circuitlockedinterface.h