//---------------------------------------------------------------------------------------
// <copyright file="GPSListenerPersistentSettings.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 GPSListenerPersistentSettings class, a serializable entity that
//   holds changeable persistent settings for the GPSListener class
// </summary>
//
// <owner>Mike Cookson</owner>
//---------------------------------------------------------------------------------------

#ifndef __GPSLISTENERPERSISTENTSETTINGS_H__
#define __GPSLISTENERPERSISTENTSETTINGS_H__

#include <string>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/version.hpp>
#include <boost/serialization/split_member.hpp>
#include "LqrSMACSharedLib.h"

namespace LiquidRobotics {
namespace GPSListenerLib {

class SHARED_LIB_PUBLIC GPSListenerPersistentSettings
{
public:

	typedef std::string string;

	GPSListenerPersistentSettings();
	virtual ~GPSListenerPersistentSettings();

	void SetDefaultState();

	void ClearDefaultOutputFileName();
	bool HaveDefaultOutputFileName() const;
	const string GetDefaultOutputFileName() const;
	void SetDefaultOutputFileName(const string& newValue);

	bool GetAutoStartOutput() const;
	void SetAutoStartOutput(bool newValue);

	bool Load(const string& fileName, bool throwOnError = true);
	void Save(const string& fileName) const;

private:

	friend class boost::serialization::access;

	template<class Archive>
	void load(Archive & ar, const unsigned int version)
	{
		ar & BOOST_SERIALIZATION_NVP(defaultOutputFileName);
		ar & BOOST_SERIALIZATION_NVP(haveDefaultOutputFileName);
		ar & BOOST_SERIALIZATION_NVP(autoStartOutput);
	}

	template<class Archive>
	void save(Archive & ar, const unsigned int version) const
	{
		ar & BOOST_SERIALIZATION_NVP(defaultOutputFileName);
		ar & BOOST_SERIALIZATION_NVP(haveDefaultOutputFileName);
		ar & BOOST_SERIALIZATION_NVP(autoStartOutput);
	}

	BOOST_SERIALIZATION_SPLIT_MEMBER()

	string defaultOutputFileName;
	bool haveDefaultOutputFileName;
	bool autoStartOutput;
};

}
}

BOOST_CLASS_VERSION(LiquidRobotics::GPSListenerLib::GPSListenerPersistentSettings, 1)

#endif /* __GPSLISTENERPERSISTENTSETTINGS_H__ */
