/***************************************************//**
 * @file    Protocol.h
 * @date    February 2009
 * @author  Ocean Optics, Inc.
 *
 * This is a simple identifier cookie that will allow two
 * objects to agree on whether they support a given command
 * set (protocol).  Each will hold Protocol objects that they
 * can then compare to see if they agree.  This allows a loose
 * binding between sets of Exchanges (elsewhere called protocols)
 * and buses.
 *
 * LICENSE:
 *
 * SeaBreeze Copyright (C) 2014, Ocean Optics Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject
 * to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *******************************************************/

#ifndef SEABREEZE_PROTOCOL_H
#define SEABREEZE_PROTOCOL_H

#include "common/protocols/ProtocolFamily.h"

namespace seabreeze {

    class Protocol {
    public:
        Protocol(int id);
        /* Copy constructor */
        Protocol(Protocol const &that);
        virtual ~Protocol();
        bool equals(Protocol const &that);

        virtual ProtocolFamily getProtocolFamily() = 0;

    protected:
        /* Protected for derived classes to use. */
        Protocol();
        int id;
    };

}

#endif
