/***************************************************//**
 * @file    OBPReadRawSpectrum32AndMetadataExchange.h
 * @date    September 2013
 * @author  Ocean Optics, Inc.
 *
 * This message type is intended for the QE-PRO which
 * aligns pixel data to 32-bit words and includes a
 * metadata block at the start of each spectrum.
 *
 * 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 OBPREADRAWSPECTRUM32ANDMETADATAEXCHANGE_H
#define OBPREADRAWSPECTRUM32ANDMETADATAEXCHANGE_H

#include "common/protocols/Transfer.h"

namespace seabreeze {
    namespace oceanBinaryProtocol {
        class OBPReadRawSpectrum32AndMetadataExchange : public Transfer {
        public:
            OBPReadRawSpectrum32AndMetadataExchange(unsigned int numberOfPixels);
            virtual ~OBPReadRawSpectrum32AndMetadataExchange();

            void setNumberOfPixels(int numberOfPixels);

            /* Inherited */
            virtual Data *transfer(TransferHelper *helper) throw (ProtocolException);

        protected:
            unsigned int isLegalMessageType(unsigned int t);
            unsigned int numberOfPixels;
            unsigned int metadataLength;
        };
    }
}

#endif /* OBPREADRAWSPECTRUM32ANDMETADATAEXCHANGE_H */
