//---------------------------------------------------------------------------------
// <copyright file="LqrSMACTimerWithContext.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 TimerWithContext template class, which represents a timer with
//  a user-specified context variable.
// </summary>
//
// <owner>Mike Cookson</owner>
//---------------------------------------------------------------------------------

#ifndef __LqrSMACTimerWithContext_H__
#define __LqrSMACTimerWithContext_H__

#include "LqrSMACTimer.h"

namespace LiquidRobotics {
namespace SMACFramework {

template<typename CONTEXT>
class TimerWithContext : public Timer
{
public:

	TimerWithContext(const CONTEXT& ctx, TimeUnits initialCounter = 0, bool retriggers = false, bool running = true, TimerCollectionPtr _timerColl = TimerCollectionPtr())
	: Timer(initialCounter, retriggers, running, _timerColl)
	, context(ctx)
	{
	}

	TimerWithContext(TimerWithContext<CONTEXT>& rhs)
	: Timer(rhs)
	, context(rhs.context)
	{
	}

	TimerWithContext<CONTEXT>& operator=(const TimerWithContext<CONTEXT>& rhs)
	{
		if (this != &rhs)
		{
			Timer::operator=(rhs);
			context = rhs.context;
		}

		return *this;
	}

	int Compare(const Timer& rhs) const
	{
		int status = Timer::Compare(rhs);

		if (!status)
			status = CompareT(context, rhs.context);

		return status;
	}

	const CONTEXT& Context() const
	{
		return context;
	}

	void Context(const CONTEXT& newValue)
	{
		context = newValue;
	}

private:

	CONTEXT context;
};

}
}

#endif
