Bus.h

Go to the documentation of this file.

/***************************************************/
#ifndef SEABREEZE_BUS_H
#define SEABREEZE_BUS_H

#include "common/protocols/ProtocolHint.h"
#include "common/buses/TransferHelper.h"
#include "common/buses/BusFamily.h"
#include "common/buses/DeviceLocatorInterface.h"
#include "common/exceptions/IllegalArgumentException.h"

namespace seabreeze {

    class Bus {
    public:
        Bus();
        virtual ~Bus();
        virtual TransferHelper *getHelper(const std::vector<ProtocolHint *> &hints) const = 0;
        virtual BusFamily getBusFamily() const = 0;
        /* Associate this Bus instance with a particular device location.
         * This MUST be done before open or close can be used.
         */
        virtual void setLocation(const DeviceLocatorInterface &location)
                throw (IllegalArgumentException) = 0;
        virtual bool open() = 0;
        virtual void close() = 0;
        virtual DeviceLocatorInterface *getLocation() = 0;
    };

}

#endif