//---------------------------------------------------------------------------------
// <copyright file="DataSetEvent.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 DataSetEvent, a telemetry type of event that carries a named
//   data set.  This format can be used to send whole files to remote destinations.
// </summary>
//
// <owner>Mike Cookson</owner>
//---------------------------------------------------------------------------------

#ifndef __EVENTLIB_DATASETEVENT_H__
#define __EVENTLIB_DATASETEVENT_H__

#include "TelemetryEventBase.h"

namespace LiquidRobotics {
namespace EventLib {

class SHARED_LIB_PUBLIC DataSetEvent : public TelemetryEventBase
{
public:

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

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

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

	void ClearDataSetName();
	EventPropertyValue::String GetDataSetName() const;
	bool HasDataSetName() const;
	void SetDataSetName(const EventPropertyValue::String& newValue);

	void GetContent(ByteArray& content, size_t startOffset, size_t length) const;
	string GetContentFileName() const;
	size_t GetContentLength() const;
	void GetNonFileContent(ByteArray& content) const;
	bool HasContentFileName() const;
	bool HasNonFileContent() const;
	bool ReceiverOwnsFile() const;
	void SaveContentToFile(const string& fileName, bool deleteFileIfOwned = true) const;
	void SetContent(const ByteArray& content);
	void SetContent(const string& fileName, bool receiverOwnsFile);
	string SuggestSaveFileName(const string& directoryName, bool useContentSpecificExtension = true, size_t maxFileName = 0) const;
	string GetOriginalFileName (const string& directoryName) const;

private:

	static const PropertyNameType DataSetNameTag;
	static const PropertyNameType ContentTag;
	static const PropertyNameType ContentFileNameTag;
	static const PropertyNameType ReceiverOwnsContentTag;
};

}
}

#endif
