Feature.h

Go to the documentation of this file.

/***************************************************/
#ifndef FEATURE_H
#define FEATURE_H

#include "common/SeaBreeze.h"
#include "common/buses/Bus.h"
#include "common/features/FeatureFamily.h"
#include "common/exceptions/FeatureException.h"
#include "common/protocols/Protocol.h"
#include <vector>

namespace seabreeze {

    class Feature {
    public:
        virtual ~Feature() = 0;

        /* Allow the object that represents a given feature to initialize
         * itself by reading from the corresponding feature on the real
         * device, and/or put the real device feature into a known state.
         * This should return true if the feature is ready to be used, and false
         * otherwise.
         */
        virtual bool initialize(const Protocol &protocol, const Bus &bus)
            throw (FeatureException) = 0;

        virtual FeatureFamily getFeatureFamily() = 0;
    };

    /* Default implementation for (otherwise) pure virtual destructor */
    inline Feature::~Feature() {}
}

#endif /* FEATURE_H */