CircuitAccessInterface Class Reference

The CircuitAccessInterface allows power control drivers to provide TheSky a means to dictact access to a circuit, typically by a built in means of authentication. A locked circuit is still visible but its state cannot be changed. More...

#include <circuitaccessinterface.h>

Public Member Functions
virtual int	circuitAccess (const int &nIndex, bool &bZeroForNoAccessOneForAccess)=0

Detailed Description

The CircuitAccessInterface allows power control drivers to provide TheSky a means to dictact access to a circuit, typically by a built in means of authentication. A locked circuit is still visible but its state cannot be changed.

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

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

Member Function Documentation

circuitAccess()

virtual int CircuitAccessInterface::circuitAccess ( const int &  nIndex, bool &  bZeroForNoAccessOneForAccess  )

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.
bZeroForNoAccessOneForAccess	(out) returns the access state of the circuit, zero means no access, one means access.

---

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

• licensedinterfaces/circuitaccessinterface.h