//-------------------------------------------------------------------------------
// <copyright file="SBDStatisticsEvent.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>
//   Declaration of the SBDStatisticsEvent class, which carries module statistics
//   values.
// </summary>
//
// <owner>Mike Cookson</owner>
//-------------------------------------------------------------------------------

#ifndef __EventLib_SBDStatisticsEvent_h__
#define	__EventLib_SBDStatisticsEvent_h__

#include "TelemetryEventBase.h"

namespace LiquidRobotics {
namespace EventLib {

class SHARED_LIB_PUBLIC SBDStatisticsEvent : public TelemetryEventBase
{
public:

	typedef TelemetryEventBase Base;
	typedef LiquidRobotics::SMACFramework::ByteArray ByteArray;

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

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

	void Init(bool communicating, bool networkOK, bool accessOK, const string& model, const string& serialNum, const string& simNum, unsigned numSent,
		  unsigned numReceived, unsigned numSessions, unsigned numSessionsSuccessful, bool reliable);

	bool GetCommunicating() const;
	bool GetNetworkOK() const;
	bool GetAccessOK() const;
	string GetModel() const;
	string GetSerialNum() const;
	string GetSimNum() const;
	unsigned GetNumSent() const;
	unsigned GetNumReceived() const;
	unsigned GetNumSessions() const;
	unsigned GetNumSessionsSuccessful() const;
	bool GetReliable() const;

private:

	static const PropertyNameType CommunicatingTag;
	static const PropertyNameType NetworkOKTag;
	static const PropertyNameType AccessOKTag;
	static const PropertyNameType ModelTag;
	static const PropertyNameType SerialNumTag;
	static const PropertyNameType SimNumTag;
	static const PropertyNameType NumSentTag;
	static const PropertyNameType NumReceivedTag;
	static const PropertyNameType NumSessionsTag;
	static const PropertyNameType NumSessionsSuccessfulTag;
	static const PropertyNameType ReliableTag;
};

}
}

#endif	/* SBDSTATISTICSEVENT_H */

