//------------------------------------------------------------------------------
// <copyright file="LqrSMACTimeCounter.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 LqrSMACTimeCounter class, which counts time in milliseconds
//   and provides a way of reading how much time is left
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __LQRSMACTIMECOUNTER_H__
#define __LQRSMACTIMECOUNTER_H__

#include "LqrSMACSharedLib.h"
#include "LqrSMACLockableConcept.h"

namespace LiquidRobotics {
namespace SMACFramework {

class SHARED_LIB_PUBLIC TimeCounter : public LockableConceptMutex
{
public:

	TimeCounter(unsigned ms = 0, bool _running = true);
	virtual ~TimeCounter();

	unsigned GetCount() const;
	double GetCountSec() const;
	bool IsRunning() const;
	void Pause();
	unsigned Remaining(unsigned limit) const;
	double RemainingSec(double limit) const;
	void Reset(unsigned ms = 0, bool _running = false);
	void ResetSec(double sec = 0.0, bool _running = false);
	void Resume();
	void SetCount(unsigned ms);
	void SetCountSec(double sec);

private:

	bool running;
	double startTime;
};

}
}

#endif
