//------------------------------------------------------------------------------
// <copyright file="TelemetryFieldLibrary.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 TelemetryFieldLibrary, a dictionary of string keys and
//   EPVFormatConfig shared pointer values.
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __PAYLOADINTERFACELIB_TELEMETRYFIELDLIBRARY_H__
#define __PAYLOADINTERFACELIB_TELEMETRYFIELDLIBRARY_H__

#include "LqrSMACSharedLib.h"
#include "LqrSMACXmlDOM.h"
#include <map>
#include <string>
#include <boost/serialization/access.hpp>
#include <boost/serialization/map.hpp>
#include <boost/shared_ptr.hpp>

namespace boost {
namespace archive {
	class xml_iarchive;
	class xml_oarchive;
}
}

namespace LiquidRobotics {

namespace EventLib {
	class EPVFormatConfig;
}

namespace SMACFramework {
	class IObjectBroker;
}

namespace PayloadInterface {

class SHARED_LIB_PUBLIC TelemetryFieldLibrary
: public LiquidRobotics::SMACFramework::XmlDOM::IXmlDOMPersistent
{
public:

	typedef LiquidRobotics::EventLib::EPVFormatConfig EPVFormatConfig;
	typedef boost::shared_ptr<EPVFormatConfig> EPVFormatConfigPtr;
	typedef LiquidRobotics::SMACFramework::IObjectBroker IObjectBroker;
	typedef std::string string;
	typedef boost::archive::xml_iarchive xml_iarchive;
	typedef boost::archive::xml_oarchive xml_oarchive;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNode XmlNode;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNVPBase XmlNVPBase;

	TelemetryFieldLibrary(IObjectBroker& _broker);
	TelemetryFieldLibrary(const TelemetryFieldLibrary& other);

	TelemetryFieldLibrary& operator=(const TelemetryFieldLibrary& other);

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

	void Add(const string& key, const EPVFormatConfig& val, bool overwrite = false);
	bool ContainsKey(const string& key) const;
	void Load(xml_iarchive& arch);
	const EPVFormatConfig& Lookup(const string& key) const;
	void Remove(const string& key);
	void Save(xml_oarchive& arch) const;

	void Load(XmlNode& node, const XmlNVPBase& nvp);
	void Save(XmlNode& node, const XmlNVPBase& nvp) const;

private:

	friend class boost::serialization::access;

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

	typedef std::map<string,EPVFormatConfigPtr> LibType;

	IObjectBroker& broker;
	LibType lib;
};


}
}

#endif

