//------------------------------------------------------------------------------
// <copyright file="CRC16.h" company="LiquidRobotics">
//
// Copyright (c) 2014 Liquid Robotics, 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.
//
// This software is associated with a release.  Liquid Robotics makes no
// representation that the design, interfaces or component distribution will
// remain unchanged in future releases.
//
// </copyright>
//
// <summary>
//   Declarations for the CRC16 class, which generates and holds the value of a
//   16-bit CRC (cyclic redundancy check)
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef CRC16_H_
#define CRC16_H_

#include <stdexcept>
#include <string>
#include <vector>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include "LqrSMACByteArray.h"
#include "LqrSMACSharedLib.h"
#include "LqrSMACDeclareException.h"

namespace LiquidRobotics {
namespace PayloadInterface {

class SHARED_LIB_PUBLIC CRC16
{
public:

	typedef SMACFramework::ByteArray::byte byte;
	typedef SMACFramework::ByteArray ByteArray;
	typedef unsigned short CRCType;

	DECLARE_EXCEPTION(FileNotFound, std::runtime_error);
	DECLARE_EXCEPTION(FileIOError, std::runtime_error);

	static const CRCType defaultInitialValue;

	CRC16(CRCType initial = defaultInitialValue)
	: crc(initial)
	{
	}

	CRC16(const void* pData, unsigned dataLength, CRCType initial = defaultInitialValue);

	CRC16(const CRC16& other)
	: crc(other.crc)
	{
	}

	CRC16& operator=(const CRC16& other)
	{
		if (this != &other)
			crc = other.crc;

		return *this;
	}

	bool operator==(const CRC16& other) const
	{
		return crc == other.crc;
	}

	bool operator!=(const CRC16& other) const
	{
		return crc != other.crc;
	}

	void Add(byte b);
	void Add(const void* pData, unsigned dataLength);
	void Add(const ByteArray& data);

	void AddFileContent(const std::string& fileName);

	template<typename T>
	void AddSimpleType(const T& tData)
	{
		Add(&tData, sizeof(tData));
	}

	CRCType Get() const
	{
		return crc;
	}

	void Reset(CRCType initial = defaultInitialValue)
	{
		crc = initial;
	}

	std::string ToString() const;

private:

	friend class boost::serialization::access;

	template<class Archive>
	void serialize(Archive& ar, const unsigned int version)
	{
		ar & BOOST_SERIALIZATION_NVP(crc);
	}

	CRCType crc;
};

std::ostream& operator<<(std::ostream& out, const CRC16& crc);

}
}

#endif /* CRC16_H_ */
