//---------------------------------------------------------------------------------
// <copyright file="TelemetryPublisher.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 TelemetryPublisher, a serializable entity class with settings
//   for an originator of telemetry
// </summary>
//
// <owner>Mike Cookson</owner>
//---------------------------------------------------------------------------------

#ifndef __PAYLOADINTERFACELIB_TELMETRYPUBLISHER_H__
#define __PAYLOADINTERFACELIB_TELMETRYPUBLISHER_H__

#include "LqrSMACSharedLib.h"
#include "LqrSMACXmlDOM.h"
#include "TelemetryPublisherKey.h"
#include "TelemetryReportKey.h"
#include "TelemetryReportParameters.h"
#include <stdint.h>
#include <string>
#include <map>
#include <vector>
#include <boost/shared_ptr.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/map.hpp>

namespace LiquidRobotics {
namespace PayloadInterface {

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

	typedef TelemetryReportKey::FormatCode FormatCode;
	typedef std::vector<FormatCode> FormatCodeArray;
	typedef uint32_t PayloadType;
	typedef boost::shared_ptr<TelemetryPublisher> Ptr;
	typedef std::string string;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNode XmlNode;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNVPBase XmlNVPBase;

	TelemetryPublisher();
	TelemetryPublisher(TelemetryPublisherKey _key, PayloadType _payloadType);

	static int Compare(const TelemetryPublisher& t1, const TelemetryPublisher& t2);

	bool operator==(const TelemetryPublisher& other) const;
	bool operator<(const TelemetryPublisher& other) const;
	bool operator>(const TelemetryPublisher& other) const;

	std::ostream& Describe(std::ostream& stm) const;
	void GetFormatCodes(FormatCodeArray& formatCodes) const;
	FormatCode GetFormatCodeForEvent(const string& eventName) const;
	PayloadType GetPayloadType() const;
	TelemetryPublisherKey GetPublisherKey() const;
	TelemetryReportParameters& GetReportParameters(FormatCode formatCode);
	const TelemetryReportParameters& GetReportParameters(FormatCode formatCode) const;
	bool HaveFormatCodeForEvent(const string& eventName) const;
	bool HaveReportParameters(FormatCode formatCode) const;
	void SetPayloadType(PayloadType newValue);
	void SetPublisherKey(TelemetryPublisherKey newValue);
	void SetFormatCodeAndEvent(FormatCode formatCode, const string& eventName);
	void SetReportParameters(FormatCode formatCode, const TelemetryReportParameters& newValue);

	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(key);
		ar & BOOST_SERIALIZATION_NVP(payloadType);
		ar & BOOST_SERIALIZATION_NVP(eventNameToFormatCode);
		ar & BOOST_SERIALIZATION_NVP(reportParams);
	}

	typedef std::map<string,FormatCode> EventNameToFormatCode;
	typedef std::map<FormatCode,TelemetryReportParameters::Ptr> FormatCodeToReportParameters;

	static int Compare(EventNameToFormatCode::const_iterator it1, EventNameToFormatCode::const_iterator it2);
	static int Compare(FormatCodeToReportParameters::const_iterator it1, FormatCodeToReportParameters::const_iterator it2);

	TelemetryPublisherKey key;
	PayloadType payloadType;
	EventNameToFormatCode eventNameToFormatCode;
	FormatCodeToReportParameters reportParams;
};

#if 0
inline bool operator<(const TelemetryPublisher::Ptr& lhs, const TelemetryPublisher::Ptr& rhs)
{
	if (!lhs && rhs)
		return true;
	else if (!rhs)
		return false;
	else
		return *lhs < *rhs;
}
#endif

SHARED_LIB_PUBLIC std::ostream& operator<<(std::ostream& stm, const TelemetryPublisher& pub);

}
}

#endif
