DataBufferFeatureInterface.h

Go to the documentation of this file.

/***************************************************/
#ifndef DATABUFFERFEATUREINTERFACE_H
#define DATABUFFERFEATUREINTERFACE_H

#include "common/protocols/Protocol.h"
#include "common/buses/Bus.h"
#include "common/exceptions/FeatureException.h"

namespace seabreeze {

    typedef unsigned char DataBufferIndex_t;
    typedef DataBufferIndex_t DataBufferCount_t;
    typedef unsigned long DataBufferElementCount_t;

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

        virtual DataBufferCount_t getNumberOfBuffers() = 0;
        virtual void clearBuffer(const Protocol &protocol, const Bus &bus,
                const DataBufferIndex_t bufferIndex) throw (FeatureException) = 0;
        virtual DataBufferElementCount_t getBufferCapacity(const Protocol &protocol,
                const Bus &bus, const DataBufferIndex_t bufferIndex)
                throw (FeatureException) = 0;
        virtual DataBufferElementCount_t getBufferCapacityMaximum(
                const Protocol &protocol, const Bus &bus,
                const DataBufferIndex_t bufferIndex) throw (FeatureException) = 0;
        virtual DataBufferElementCount_t getBufferCapacityMinimum(
                const Protocol &protocol, const Bus &bus,
                const DataBufferIndex_t bufferIndex) throw (FeatureException) = 0;
        virtual DataBufferElementCount_t getNumberOfElements(
                const Protocol &protocol, const Bus &bus,
                const DataBufferIndex_t bufferIndex) throw (FeatureException) = 0;
        virtual void setBufferCapacity(const Protocol &protocol, const Bus &bus,
                const DataBufferIndex_t bufferIndex,
                const DataBufferElementCount_t bufferSize)
                throw (FeatureException) = 0;
    };

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

} /* end namespace */


#endif /* DATABUFFERFEATUREINTERFACE_H */