//------------------------------------------------------------------------------
// <copyright file="PayloadManagerClientSettings.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 PayloadManagerClientSettings class, an entity class that
//   holds the settings for PayloadManagerClient
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __EVENTLIB_PAYLOADMANAGERCLIENTSETTINGS_H__
#define __EVENTLIB_PAYLOADMANAGERCLIENTSETTINGS_H__

#include "LqrSMACPayloadDescription.h"
#include "LqrSMACSharedLib.h"
#include <ostream>

namespace LiquidRobotics {
namespace EventLib {

class SHARED_LIB_PUBLIC PayloadManagerClientSettings
{
public:

	typedef LiquidRobotics::SMACFramework::PayloadDescription PayloadDescription;
	typedef std::string string;

	PayloadManagerClientSettings();
	PayloadManagerClientSettings(const PayloadManagerClientSettings& other);

	PayloadManagerClientSettings& operator=(const PayloadManagerClientSettings& other);
	bool operator==(const PayloadManagerClientSettings& other) const;

	const string& GetServiceName() const;
	void SetServiceName(const string& newValue);

	const string& GetServiceKind() const;
	void SetServiceKind(const string& newValue);

	const string& GetDeviceAddedEventName() const;
	void SetDeviceAddedEventName(const string& newValue);

	const string& GetDeviceChangedEventName() const;
	void SetDeviceChangedEventName(const string& newValue);

	const string& GetDeviceRemovedEventName() const;
	void SetDeviceRemovedEventName(const string& newValue);

	const string& GetCommonEventType() const;
	void SetCommonEventType(const string& newValue);

	const string& GetCommonEventDomain() const;
	void SetCommonEventDomain(const string& newValue);

	const PayloadDescription& GetPayloadDescription() const;
	void SetPayloadDescription(const PayloadDescription& newValue);

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

private:

	friend class boost::serialization::access;

	template<class Archive>
	void serialize(Archive & ar, const unsigned int version)
	{
		ar & BOOST_SERIALIZATION_NVP(serviceName);
		ar & BOOST_SERIALIZATION_NVP(serviceKind);
		ar & BOOST_SERIALIZATION_NVP(deviceAddedEventName);
		ar & BOOST_SERIALIZATION_NVP(deviceChangedEventName);
		ar & BOOST_SERIALIZATION_NVP(deviceRemovedEventName);
		ar & BOOST_SERIALIZATION_NVP(commonEventType);
		ar & BOOST_SERIALIZATION_NVP(commonEventDomain);
		ar & BOOST_SERIALIZATION_NVP(payloadDescription);
	}

	string serviceName;
	string serviceKind;

	string deviceAddedEventName;

	string deviceChangedEventName;

	string deviceRemovedEventName;

	string commonEventType;
	string commonEventDomain;

	PayloadDescription payloadDescription;
};

SHARED_LIB_PUBLIC std::ostream& operator<<(std::ostream& stm, const PayloadManagerClientSettings& settings);

}
}

#endif
