//--------------------------------------------------------------------------------
// <copyright file="SendCommandCompleteEvent.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 SendCommandCompleteEvent class, which models an event that
//   announces asynchronous completion of an ICommandable::SendCommand invocation.
// </summary>
//
// <owner>Mike Cookson</owner>
//--------------------------------------------------------------------------------

#ifndef __EVENTLIB_SENDCOMMANDCOMPLETEEVENT_H__
#define __EVENTLIB_SENDCOMMANDCOMPLETEEVENT_H__

#include "EventBase.h"
#include "LqrSMACSharedLib.h"
#include <string>
#include <vector>
#include <sys/time.h>

namespace LiquidRobotics {
namespace EventLib {

class SHARED_LIB_PUBLIC SendCommandCompleteEvent : public LiquidRobotics::EventLib::EventBase
{
public:

	typedef CORBA::Any CORBAAny;
	typedef CORBA::Any_var CORBAAnyVar;
	typedef LiquidRobotics::EventLib::EventName EventName;
	typedef LiquidRobotics::EventLib::EventType EventType;
	typedef LiquidRobotics::EventLib::IOR IOR;
	typedef boost::shared_ptr<SendCommandCompleteEvent> Ptr;
	typedef std::string string;
	typedef std::vector<string> StringArray;

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

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

	bool Complete() const;
	void Complete(bool newValue = true);

	string Requester() const;
	void Requester(const string& newValue);

	bool Successful() const;
	void Successful(bool success);		// if not called, defaults to successful

	string TransactionID() const;
	void TransactionID(const string& newValue);

	bool HasResult() const;
	CORBAAnyVar Result() const;
	void Result(const CORBAAny& newValue);
	string ResultVariantString() const;
	void ResultVariantString(const string& newValue);

	bool HasResultFile() const;
	string ResultFile() const;
	void ResultFile(const string& newValue, bool receiverTakesFileOwnership = true);
	bool ResultFileOwnedByReceiver() const;

private:

	static const PropertyNameType completeTag;
	static const PropertyNameType requesterTag;
	static const PropertyNameType successTag;
	static const PropertyNameType transactionIDTag;
	static const PropertyNameType resultTag;
	static const PropertyNameType resultFileTag;
	static const PropertyNameType resultFileOwnedByReceiverTag;
};

}
}

#endif
