//-------------------------------------------------------------------------------
// <copyright file="TelemetryReportParameters.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 TelemetryReportParmaeters, a serializable entity class that
//   represents the settings for a type of telemetry report.
// </summary>
//
// <owner>Mike Cookson</owner>
//-------------------------------------------------------------------------------

#ifndef __PAYLOADINTERFACELIB_TELEMETRYREPORTPARAMETERS_H__
#define __PAYLOADINTERFACELIB_TELEMETRYREPORTPARAMETERS_H__

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

namespace LiquidRobotics {
namespace PayloadInterface {

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

	typedef PayloadMessage::BoardAddress BoardAddress;
	typedef boost::shared_ptr<TelemetryReportParameters> Ptr;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNode XmlNode;
	typedef LiquidRobotics::SMACFramework::XmlDOM::XmlNVPBase XmlNVPBase;

	TelemetryReportParameters();
	TelemetryReportParameters(uint16_t _maxSamples, time_t _maxRetainTime, BoardAddress _targetAddress = 0);
	TelemetryReportParameters(uint16_t _maxSamples, time_t _maxRetainTime, BoardAddress _targetAddress, const TelemetryFieldList& _reportHeaderFormat, const TelemetryFieldList& _sampleHeaderFormat);

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

	uint16_t GetMaxSamples() const;
	time_t GetMaxRetainTime() const;
	const TelemetryFieldList& GetReportHeaderFormat() const;
	const TelemetryFieldList& GetSampleHeaderFormat() const;
	BoardAddress GetTargetAddress() const;
	void SetMaxSamples(uint16_t newValue);
	void SetMaxRetainTime(time_t newValue);
	void SetReportHeaderFormat(const TelemetryFieldList& newValue);
	void SetSampleHeaderFormat(const TelemetryFieldList& newValue);
	void SetTargetAddress(BoardAddress 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 load(Archive & ar, const unsigned int version)
	{
		ar >> BOOST_SERIALIZATION_NVP(maxSamples);
		ar >> BOOST_SERIALIZATION_NVP(maxRetainTime);
		reportHeaderFormat.Load(ar);
		sampleHeaderFormat.Load(ar);
		ar >> BOOST_SERIALIZATION_NVP(targetAddress);
	}

	template<class Archive>
	void save(Archive & ar, const unsigned int version) const
	{
		ar << BOOST_SERIALIZATION_NVP(maxSamples);
		ar << BOOST_SERIALIZATION_NVP(maxRetainTime);
		reportHeaderFormat.Save(ar);
		sampleHeaderFormat.Save(ar);
		ar << BOOST_SERIALIZATION_NVP(targetAddress);
	}

	BOOST_SERIALIZATION_SPLIT_MEMBER()

	static int Compare(const TelemetryReportParameters& item1, const TelemetryReportParameters& item2);

	uint16_t maxSamples;
	time_t maxRetainTime;
	TelemetryFieldList reportHeaderFormat;
	TelemetryFieldList sampleHeaderFormat;
	BoardAddress targetAddress;
};

SHARED_LIB_PUBLIC std::ostream& operator<<(std::ostream& stm, const TelemetryReportParameters& prm);

}
}

#endif
