//------------------------------------------------------------------------------
// <copyright file="TelemetryPublisherKey.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 TelemetryPublisherKey, a serializable entity class that
//   represents the key used for telemetry publishers (i.e. processes that send
//   telemetry)
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __PAYLOADINTERFACELIB_TELEMETRYPUBLISHERKEY_H__
#define __PAYLOADINTERFACELIB_TELEMETRYPUBLISHERKEY_H__

#include "LqrSMACSharedLib.h"
#include "LqrSMACXmlDOM.h"
#include "PayloadMessage.h"
#include <boost/shared_ptr.hpp>
#include <boost/serialization/access.hpp>
#include <ostream>

namespace LiquidRobotics {
namespace PayloadInterface {

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

	typedef PayloadMessage::BoardAddress BoardAddress;
	typedef PayloadMessage::BoardID BoardID;
	typedef PayloadMessage::TaskID TaskID;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNode XmlNode;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNVPBase XmlNVPBase;

	TelemetryPublisherKey();
	TelemetryPublisherKey(BoardID _boardID, TaskID _taskID);
	TelemetryPublisherKey(BoardAddress boardAddress);

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

	static int Compare(const TelemetryPublisherKey& v1, const TelemetryPublisherKey& v2);

	const BoardAddress GetBoardAddress() const;
	const BoardID GetBoardID() const;
	const TaskID GetTaskID() const;
	void SetBoardAddress(BoardAddress newValue);
	void SetBoardID(BoardID newValue);
	void SetTaskID(TaskID 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(boardID);
		ar & BOOST_SERIALIZATION_NVP(taskID);
	}

	BoardID boardID;
	TaskID taskID;
};

SHARED_LIB_PUBLIC std::ostream& operator<<(std::ostream& stm, const TelemetryPublisherKey& key);

}
}

#endif
