EEPROMSlotFeatureBase.h

Go to the documentation of this file.

/***************************************************/
#ifndef EEPROMSLOTFEATUREBASE_H
#define EEPROMSLOTFEATUREBASE_H

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

namespace seabreeze {

    class EEPROMSlotFeatureBase : public FeatureImpl {
        /* Keeping most of this class protected to force use of the derived
         * classes, e.g. EEPROMSlotFeature, which can provide better control
         * over which slots are accessed.
         */

    protected:

        EEPROMSlotFeatureBase();
        virtual ~EEPROMSlotFeatureBase();
        virtual std::vector<byte> *readEEPROMSlot(const Protocol &protocol,
                const Bus &bus, unsigned int slot) throw (FeatureException, IllegalArgumentException);
        virtual int writeEEPROMSlot(const Protocol &protocol,
                const Bus &bus, unsigned int slot, const std::vector<byte> &data)
                throw (FeatureException, IllegalArgumentException);

        /* This is a utility function that reads out the given EEPROM slot and
         * parses it into a double value.  If for some reason the parse fails,
         * this will throw a NumberFormatException.
         */
        double readDouble(const Protocol &protocol, const Bus &bus,
                unsigned int slot) throw (FeatureException, NumberFormatException);

        /* As with readDouble(), this will read a slot and parse into an integer */
        long readLong(const Protocol &protocol, const Bus &bus,
                unsigned int slot) throw (FeatureException, NumberFormatException);

    };

}

#endif /* EEPROMSLOTFEATUREBASE_H */