//--------------------------------------------------------------------------------
// <copyright file="SensorControllerBase.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 SensorControllerBase template class, an abstract base class
//	 that defines controller operations that are accessible to the command classes.
//   Its template parameters are:
//
//		- TCmdBase, the abstract base class that defines command operations
//
//		- TCmdID, the type if command ID that is used to track commands
// </summary>
//
// <owner>Mike Cookson</owner>
//--------------------------------------------------------------------------------

#ifndef __EventLib_SensorControllerBase_h__
#define __EventLib_SensorControllerBase_h__

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

namespace LiquidRobotics {
namespace EventLib  {

template<class TCmdBase, class TCmdID>
class SHARED_LIB_PUBLIC SensorControllerBase
{
public:

	typedef TCmdBase TCmd;
	typedef TCmdID TCID;
	typedef SensorControllerBase<TCmdBase,TCmdID> SensorControllerBaseT;
	typedef SensorControllerBaseParsingContext<SensorControllerBaseT,TCmdID> ParsingContext;
	typedef boost::shared_ptr<TCmdBase> CommandPtr;
	typedef std::string string;

	virtual string GetDefaultOutputFormatter() const = 0;
	virtual CommandPtr ParseCommandBuffer(ParsingContext& context) = 0;
	virtual CommandPtr ParseCommand(ParsingContext& context, bool internalCmd = false) = 0;
};

}
}

#endif
