//----------------------------------------------------------------------------------
// <copyright file="SensorControllerBaseCmdID.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 SensorControllerBaseCommandID, which defines an entity class
//	 that can be used to track commands.  It can be initialized with the requester
//	 and the transaction ID from the requester or without parameters.  By convention,
//	 command ID's with either the transaction ID or the requester string left blank
//	 are considered to be "blocking" since there is no way to inform the requester
//   of completion asynchronously.
// </summary>
//
// <owner>Mike Cookson</owner>
//----------------------------------------------------------------------------------

#ifndef __EventLib_SensorControllerBaseCmdID_h__
#define __EventLib_SensorControllerBaseCmdID_h__

#include "LqrSMACSharedLib.h"
#include <ostream>
#include <string>

namespace LiquidRobotics {
namespace EventLib  {

class SHARED_LIB_PUBLIC SensorControllerBaseCommandID
{
public:

	typedef std::string string;

	SensorControllerBaseCommandID();
	SensorControllerBaseCommandID(const string& _requester, const string& _transactionID);
	SensorControllerBaseCommandID(const SensorControllerBaseCommandID& rhs);

	SensorControllerBaseCommandID& operator=(const SensorControllerBaseCommandID& rhs);

	const string& GetRequester() const;
	void SetRequester(const string& newValue);

	const string& GetTransactionID() const;
	void SetTransactionID(const string& newValue);

	bool IsBlocking() const;

private:

	string requester;
	string transactionID;
};

}
}

SHARED_LIB_PUBLIC std::ostream& operator<<(std::ostream& stm, const LiquidRobotics::EventLib::SensorControllerBaseCommandID& cid);

#endif
