//---------------------------------------------------------------------------------
// <copyright file="SensorControllerBaseParsingContext.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/implementation of SensorControllerBaseParsingContext template,
//	 which is instantiated whenever a command is parsed and contains references to
//	 to the controller base and the command ID and a copy of the command, itself.
//	 Through the base class, it also has a method of determining if a command
//	 filename has been used more than once.
//
//	 Its template parameters are:
//
//	 	- TSCCmdBase, the controller base class that is made available to all
//		  commands
//
//		- TCmdID, the type if command ID that is used to track commands
// </summary>
//
// <owner>Mike Cookson</owner>
//---------------------------------------------------------------------------------

#ifndef __EventLib_SensorControllerBaseParsingContext_h__
#define __EventLib_SensorControllerBaseParsingContext_h__

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

namespace LiquidRobotics {
namespace EventLib  {

template<typename TSCCmdBase, typename TCmdID>
class SHARED_LIB_PUBLIC SensorControllerBaseParsingContext
: public SensorControllerLoadFileParsingContext
{
public:

	typedef std::string string;

	SensorControllerBaseParsingContext(TSCCmdBase& _ctrl, const string& _cmd, const TCmdID& _cmdID)
	: ctrl(_ctrl)
	, cmd(_cmd)
	, cmdID(_cmdID)
	{
	}

	SensorControllerBaseParsingContext(const SensorControllerBaseParsingContext& rhs)
	: SensorControllerLoadFileParsingContext(rhs)
	, ctrl(rhs.ctrl)
	, cmd(rhs.cmd)
	, cmdID(rhs.cmdID)
	{
	}

	TSCCmdBase& GetController() const				{ return ctrl; }
	const string& GetCmd() const					{ return cmd; }
	void SetCmd(const string& newValue)				{ cmd = newValue; }
	const TCmdID& GetID() const						{ return cmdID; }
	void SetID(const TCmdID& newValue)				{ cmdID = newValue; }

private:

	TSCCmdBase& ctrl;
	string cmd;
	TCmdID cmdID;
};

}
}

#endif
