//--------------------------------------------------------------------------------
// <copyright file="LqrSMACSerialListenerSettings.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>
//   Declaration of SerialListenerSettings, a serializable entity class that holds
//   the settings for a SerialListener
// </summary>
//
// <owner>Mike Cookson</owner>
//--------------------------------------------------------------------------------

#ifndef __LQRSMACSERIALLISTENERSETTINGS_H__
#define __LQRSMACSERIALLISTENERSETTINGS_H__

#include "LqrSMACSharedLib.h"
#include "LqrSMACLogger.h"
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>

namespace LiquidRobotics {
namespace SMACFramework {

class SHARED_LIB_PUBLIC SerialListenerSettings
{
public:

	typedef boost::posix_time::time_duration TimeSpan;

	SerialListenerSettings();
	SerialListenerSettings(size_t _maxReadSize, TimeSpan _intercharacterGapTimeout);
	SerialListenerSettings(const SerialListenerSettings& rhs);

	size_t GetMaxReadSize() const;
	void SetMaxReadSize(size_t newValue);

	TimeSpan GetIntercharacterGapTimeout() const;
	void SetIntercharacterGapTimeout(TimeSpan newValue);

private:

	friend class boost::serialization::access;

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

		TimeSpan::tick_type intercharacterGapTimeoutMs = intercharacterGapTimeout.total_milliseconds();
		ar & BOOST_SERIALIZATION_NVP(intercharacterGapTimeoutMs);
		intercharacterGapTimeout = boost::posix_time::milliseconds(intercharacterGapTimeoutMs);
	}

	size_t maxReadSize;						// maximum number of bytes to return from the port in a single read
	TimeSpan intercharacterGapTimeout;		// maximum time to wait between bytes to define a single read
};

}
}

#endif
