//------------------------------------------------------------------------------
// <copyright file="TelemetryReportKey.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 TelemetryReportKey, a serializable entity class that
//   represents the key used for telemetry reports (i.e. how to identify a
//   a type of report and accumulation of data to report)
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __PAYLOADINTERFACELIB_TELEMETRYREPORTKEY_H__
#define __PAYLOADINTERFACELIB_TELEMETRYREPORTKEY_H__

#include "TelemetryPublisherKey.h"
#include <stdint.h>

namespace LiquidRobotics {
namespace PayloadInterface {

class SHARED_LIB_PUBLIC TelemetryReportKey
{
public:

	typedef TelemetryPublisherKey::BoardAddress BoardAddress;
	typedef TelemetryPublisherKey::BoardID BoardID;
	typedef uint8_t FormatCode;
	typedef TelemetryPublisherKey::TaskID TaskID;

	TelemetryReportKey();
	TelemetryReportKey(BoardAddress _boardAddress, FormatCode _formatCode);
	TelemetryReportKey(BoardID _boardID, TaskID _taskID, FormatCode _formatCode);

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

	int Compare(const TelemetryReportKey& other) const;
	FormatCode GetFormatCode() const;
	const TelemetryPublisherKey& GetPublisherKey() const;
	void SetFormatCode(FormatCode newValue);
	void SetPublisherKey(const TelemetryPublisherKey& newValue);

private:

	friend class boost::serialization::access;

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

	TelemetryPublisherKey publisherKey;
	FormatCode formatCode;
};

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

}
}

#endif
