STSPixelBinningFeature.h

Go to the documentation of this file.

/***************************************************/
#ifndef STSPIXELBINNINGFEATURE_H
#define STSPIXELBINNINGFEATURE_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/pixel_binning/PixelBinningFeatureInterface.h"

namespace seabreeze {

    class STSSpectrometerFeature;

    class STSPixelBinningFeature : public FeatureImpl,
            public PixelBinningFeatureInterface {
    public:
        STSPixelBinningFeature(std::vector<ProtocolHelper *> helpers,
                STSSpectrometerFeature *spectroFeature);
        virtual ~STSPixelBinningFeature();

        virtual void setPixelBinningFactor(const Protocol &protocol,
                const Bus &bus, const unsigned char binningFactor)
                throw (FeatureException);
        virtual unsigned char getPixelBinningFactor(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);
        virtual void setDefaultPixelBinningFactor(const Protocol &protocol,
                const Bus &bus, const unsigned char binningFactor)
                throw (FeatureException);
        virtual void setDefaultPixelBinningFactor(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);
        virtual unsigned char getDefaultPixelBinningFactor(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);
        virtual unsigned char getMaxPixelBinningFactor(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);

        /* 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);


        virtual FeatureFamily getFeatureFamily();

    protected:
        STSSpectrometerFeature *spectrometerFeature;
    };
}

#endif /* STSPIXELBINNINGFEATURE_H */