SetCircuitLabelsInterface Class Reference

The SetCircuitLabelsInterface allows power control drivers to provide TheSky a means to edit the text label associated with each circuit. More...

#include <setcircuitlabels.h>

Public Member Functions
virtual int	setCircuitLabel (const int &nZeroBasedIndex, const char *str)=0

Detailed Description

The SetCircuitLabelsInterface allows power control drivers to provide TheSky a means to edit the text label associated with each circuit.

This interface is optional. By default, TheSky will control the text labels associated with each circuit of a power control device. If the power control device is capable and controls text labels associated with each circuit and allows setting them, support this interface.

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

Member Function Documentation

setCircuitLabel()

virtual int SetCircuitLabelsInterface::setCircuitLabel ( const int & nZeroBasedIndex, const char * str )

pure virtual

Called by TheSky to set the text label of a circuit.

Parameters

nZeroBasedIndex	(in) the zero based index of the circuit.
str	(in) the text label associated with this circuit.

---

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

• licensedinterfaces/setcircuitlabels.h