ThermoElectricFeatureBase.h

Go to the documentation of this file.

/***************************************************/
#ifndef THERMOELECTRICFEATUREBASE_H
#define THERMOELECTRICFEATUREBASE_H

#include "common/buses/Bus.h"
#include "common/protocols/Protocol.h"
#include "common/protocols/ProtocolHelper.h"
#include "common/features/FeatureImpl.h"
#include "common/exceptions/FeatureException.h"
#include "common/exceptions/IllegalArgumentException.h"
#include "vendors/OceanOptics/features/thermoelectric/ThermoElectricFeatureInterface.h"

namespace seabreeze {

    class ThermoElectricFeatureBase : public FeatureImpl,
            public ThermoElectricFeatureInterface {
    public:
        ThermoElectricFeatureBase();
        virtual ~ThermoElectricFeatureBase();
        virtual void setThermoElectricEnable(const Protocol &protocol,
                const Bus &bus, bool enable) throw (FeatureException);
        virtual double getTemperatureCelsius(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);
        virtual void setTemperatureSetPointCelsius(const Protocol &protocol,
                const Bus &bus, double degreesC)
                throw (FeatureException, IllegalArgumentException);

        /* These remain abstract because the limits of any given device will
         * depend on its implementation.  They will either need to be hardcoded
         * into the implementation or be queried from the device.
         */
        virtual double getDefaultSetPointCelsius(const Protocol &protocol,
                const Bus &bus) throw (FeatureException) = 0;
        virtual bool getDefaultThermoElectricEnable(const Protocol &protocol,
                const Bus &bus) throw (FeatureException) = 0;

        /* Inherited from Feature */
        /* This is still abstract in case the device needs to do anything
         * special with regards to defaults when it is initialized.
         */
        virtual bool initialize(const Protocol &protocol, const Bus &bus)
            throw (FeatureException) = 0;

        virtual FeatureFamily getFeatureFamily();
    };

}

#endif /* THERMOELECTRICFEATUREBASE_H */