CircuitLabelsInterface Class Reference

The CircuitLabelsInterface allows power control drivers to provide TheSky a text label associated with each circuit. More...

#include <circuitlabels.h>

Public Member Functions
virtual int	circuitLabel (const int &nZeroBasedIndex, BasicStringInterface &str)=0

Detailed Description

The CircuitLabelsInterface allows power control drivers to provide TheSky a 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, support this interface.

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

Member Function Documentation

circuitLabel()

virtual int CircuitLabelsInterface::circuitLabel ( const int & nZeroBasedIndex, BasicStringInterface & str )

pure virtual

Called by TheSky to query (read) the text label of a circuit.

Parameters

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

---

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

• licensedinterfaces/circuitlabels.h