DataBufferProtocolInterface.h

Go to the documentation of this file.

/***************************************************/
#ifndef DATABUFFERPROTOCOLINTERFACE_H
#define DATABUFFERPROTOCOLINTERFACE_H

#include "common/buses/Bus.h"
#include "common/exceptions/ProtocolException.h"
#include "common/protocols/ProtocolHelper.h"

namespace seabreeze {

    class DataBufferProtocolInterface : public ProtocolHelper {
    public:
        DataBufferProtocolInterface(Protocol *protocol);
        virtual ~DataBufferProtocolInterface();

        virtual void clearBuffer(const Bus &bus, unsigned char bufferIndex)
                throw (ProtocolException) = 0;

        virtual unsigned long getNumberOfElements(const Bus &bus,
                unsigned char bufferIndex)
                throw (ProtocolException) = 0;

        virtual unsigned long getBufferCapacity(const Bus &bus,
                unsigned char bufferIndex)
                throw (ProtocolException) = 0;

        virtual unsigned long getBufferCapacityMinimum(const Bus &bus,
                unsigned char bufferIndex)
                throw (ProtocolException) = 0;

        virtual unsigned long getBufferCapacityMaximum(const Bus &bus,
                unsigned char bufferIndex)
                throw (ProtocolException) = 0;

        virtual void setBufferCapacity(const Bus &bus,
                unsigned char bufferIndex,
                const unsigned long capacity)
                throw (ProtocolException) = 0;
    };

} /* end namespace */

#endif /*  DATABUFFERPROTOCOLINTERFACE_H */