//-------------------------------------------------------------------------------------
// <copyright file="TelemetrySettingsChangedEvent.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 TelemetrySettingsChangedEvent, an IEventBase-derived class that
//   defines the data fields for an event that announces changes in telemetry settings.
// </summary>
//
// <owner>Mike Cookson</owner>
//-------------------------------------------------------------------------------------

#ifndef __EVENTLIB_TELEMETRYSETTINGSCHANGEDEVENT_H__
#define __EVENTLIB_TELEMETRYSETTINGSCHANGEDEVENT_H__

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

namespace LiquidRobotics {
namespace EventLib {

class SHARED_LIB_PUBLIC TelemetrySettingsChangedEvent : public TelemetryEventBase
{
public:

	TelemetrySettingsChangedEvent(IObjectBroker& _broker);
	TelemetrySettingsChangedEvent(const EventSettings& _eventSettings, IObjectBroker& _broker);
	TelemetrySettingsChangedEvent(const EventName& _eventName, const EventType& _eventType, IObjectBroker& _broker);
	TelemetrySettingsChangedEvent(const EventName& _eventName, const EventType& _eventType, const IOR& _senderIOR, IObjectBroker& _broker);
	TelemetrySettingsChangedEvent(const TelemetrySettingsChangedEvent& other);

	virtual ostream& Describe(ostream& stm) const;
	virtual IEventBase::Ptr Duplicate() const;

	virtual uint8_t GetFormatCode() const;
	virtual void SetFormatCode(uint8_t newValue);

	enum PendingMessageTreatment { PMT_RETAIN, PMT_PUBLISH, PMT_CLEAR };

	static void FromString(const string& str, PendingMessageTreatment& pmt);
	static string ToString(const PendingMessageTreatment& pmt);

	virtual PendingMessageTreatment GetPendingMessageTreatment() const;
	virtual void SetPendingMessageTreatment(PendingMessageTreatment newValue);

	virtual void ClearMaxSamples();
	virtual uint16_t GetMaxSamples() const;
	virtual bool HaveMaxSamples() const;
	virtual void SetMaxSamples(uint16_t newValue);

	virtual void ClearMaxRetainTime();
	virtual time_t GetMaxRetainTime() const;
	virtual bool HaveMaxRetainTime() const;
	virtual void SetMaxRetainTime(time_t newValue);

	static const PropertyNameType formatCodeTag;
	static const PropertyNameType pendingMessageTreatmentTag;
	static const PropertyNameType maxSamplesTag;
	static const PropertyNameType maxRetainTimeTag;
};

}
}

#endif
