powercontroldriverinterface.h

#ifndef _PowerControlDriverInterface_H
#define _PowerControlDriverInterface_H
 
#ifdef THESKYX_FOLDER_TREE
#include "imagingsystem/hardware/interfaces/licensed/driverrootinterface.h"
#include "imagingsystem/hardware/interfaces/licensed/linkinterface.h"
#include "imagingsystem/hardware/interfaces/licensed/deviceinfointerface.h"
#include "imagingsystem/hardware/interfaces/licensed/driverinfointerface.h"
#else
#include "../../licensedinterfaces/driverrootinterface.h"
#include "../../licensedinterfaces/linkinterface.h"
#include "../../licensedinterfaces/deviceinfointerface.h"
#include "../../licensedinterfaces/driverinfointerface.h"
#endif

class PowerControlDriverInterface : public DriverRootInterface, public LinkInterface, public HardwareInfoInterface, public DriverInfoInterface
{
public:
        virtual ~PowerControlDriverInterface(){}

        virtual DeviceType                                                      deviceType(void)                                                          {return DriverRootInterface::DT_POWERCONTROL;}
        virtual int                                                                     queryAbstraction(const char* pszName, void** ppVal) = 0;

        virtual int                                                                     establishLink(void) = 0;
        virtual int                                                                     terminateLink(void) = 0;
        virtual bool                                                            isLinked(void) const = 0;
        virtual bool                                                            isEstablishLinkAbortable(void) const { return false; }

        virtual void                                                            driverInfoDetailedInfo(BasicStringInterface& str) const = 0;
        virtual double                                                          driverInfoVersion(void) const = 0;
 
        //
        virtual void deviceInfoNameShort(BasicStringInterface& str) const = 0;
        virtual void deviceInfoNameLong(BasicStringInterface& str) const = 0;
        virtual void deviceInfoDetailedDescription(BasicStringInterface& str) const = 0;
        virtual void deviceInfoFirmwareVersion(BasicStringInterface& str) = 0;
        virtual void deviceInfoModel(BasicStringInterface& str) = 0;

        virtual int numberOfCircuits(int& nNumber)
        {
                nNumber = 0;
                return 0;
        }

        virtual int circuitState(const int& nZeroBasedIndex, bool& bZeroForOffOneForOn)
        {
                (void)nZeroBasedIndex;
                bZeroForOffOneForOn = 0;
                return 0;
        }

        virtual int setCircuitState(const int& nZeroBasedIndex, const bool& bZeroForOffOneForOn)
        {
                (void)nZeroBasedIndex;
                (void)bZeroForOffOneForOn;
                return 0;
        }
};
 
#endif