//------------------------------------------------------------------------------
// <copyright file="SBDModemSettings.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 the SBDModemSettings class, a serializable entity that is
//  used to configure the options for a SBDModem instance
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __PPPHOSTLIB_SBDMODEMSETTINGS_H__
#define __PPPHOSTLIB_SBDMODEMSETTINGS_H__

#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/version.hpp>
#include "LqrSMACBooleanParser.h"
#include "LqrSMACSerialListenerSettings.h"
#include "LqrSMACSerialPortSettings.h"
#include "LqrSMACSharedLib.h"
#include <boost/shared_ptr.hpp>

namespace LiquidRobotics {
namespace PPPHostLib {

class SHARED_LIB_PUBLIC SBDModemSettings
{
public:

	typedef boost::shared_ptr<SBDModemSettings> Ptr;
	typedef std::string string;

	typedef LiquidRobotics::SMACFramework::SerialPortSettings SerialPortSettings;
	typedef LiquidRobotics::SMACFramework::SerialListenerSettings SerialListenerSettings;

	SBDModemSettings();
	virtual ~SBDModemSettings();

	unsigned GetAckTimeoutMS() const;
	void SetAckTimeoutMS(unsigned newValue);

	bool GetDebugShowSerialReceive() const;
	void SetDebugShowSerialReceive(bool newValue);

	unsigned GetLongTransactionTimeoutMS() const;
	void SetLongTransactionTimeoutMS(unsigned newValue);

	unsigned GetShortTransactionTimeoutMS() const;
	void SetShortTransactionTimeoutMS(unsigned newValue);

	unsigned GetMaxTries() const;
	void SetMaxTries(unsigned newValue);

	const SerialListenerSettings& GetSerialListenerSettings() const;
	void SetSerialListenerSettings(const SerialListenerSettings& newValue);

	const SerialPortSettings& GetSerialPortSettings() const;
	void SetSerialPortSettings(const SerialPortSettings& newValue);

	void Load(const string& fileName);
	void Save(const string& fileName);

private:

	friend class boost::serialization::access;

	template<class Archive>
	void save(Archive& ar, const unsigned int version) const
	{
        using namespace LiquidRobotics::SMACFramework::BooleanParser;

        ar & BOOST_SERIALIZATION_NVP(ackTimeoutMS);
    	save_boolean_to_archive(ar, debugShowSerialReceive, "debugShowSerialReceive");
		ar & BOOST_SERIALIZATION_NVP(longTransactionTimeoutMS);
		ar & BOOST_SERIALIZATION_NVP(shortTransactionTimeoutMS);
		ar & BOOST_SERIALIZATION_NVP(maxTries);
		ar & BOOST_SERIALIZATION_NVP(serialPortSettings);
		ar & BOOST_SERIALIZATION_NVP(serialListenerSettings);
	}

	template<class Archive>
	void load(Archive& ar, const int version)
	{
        using namespace LiquidRobotics::SMACFramework::BooleanParser;

        ar & BOOST_SERIALIZATION_NVP(ackTimeoutMS);
		if (version >= 2)
        	load_boolean_from_archive(ar, debugShowSerialReceive, "debugShowSerialReceive");
		ar & BOOST_SERIALIZATION_NVP(longTransactionTimeoutMS);
		ar & BOOST_SERIALIZATION_NVP(shortTransactionTimeoutMS);
		ar & BOOST_SERIALIZATION_NVP(maxTries);
		ar & BOOST_SERIALIZATION_NVP(serialPortSettings);
		ar & BOOST_SERIALIZATION_NVP(serialListenerSettings);
	}

	BOOST_SERIALIZATION_SPLIT_MEMBER()

	unsigned ackTimeoutMS;
	bool debugShowSerialReceive;
	unsigned longTransactionTimeoutMS;
	unsigned shortTransactionTimeoutMS;
	unsigned maxTries;
	SerialPortSettings serialPortSettings;
	SerialListenerSettings serialListenerSettings;
};

}
}

BOOST_CLASS_VERSION(LiquidRobotics::PPPHostLib::SBDModemSettings, 2)

#endif
