ProtocolHint.h

Go to the documentation of this file.

/***************************************************/
#ifndef SEABREEZE_PROTOCOLHINT_H
#define SEABREEZE_PROTOCOLHINT_H

#include "common/SeaBreeze.h"
#include <string>

namespace seabreeze {

    class ProtocolHint {
    public:
        ProtocolHint(int id, std::string desc);

        /* For derived classes that will fill in their own values
         * and for containers to be able to initialize themselves.
         * This does not set any meaningful values and should not be
         * relied on to create a proper instance.
         */
        ProtocolHint();

        virtual ~ProtocolHint();
        std::string getDescription();
        int getID() const;

        /* Overloading the equality operator so that this can be
         * used as a key for hash_map associations without the actual
         * key objects having to be identical.
         */
        bool operator==(const ProtocolHint &that);

    protected:
        int id;
        std::string description;
    };

}

#endif /* SEABREEZE_PROTOCOLHINT_H */