//-----------------------------------------------------------------------------
//
//	TimeStampImpl.h
//
//	OSX implementation of a TimeStamp
//
//	Copyright (c) 2010 Mal Lansell <mal@lansell.org>
//	All rights reserved.
//
//	SOFTWARE NOTICE AND LICENSE
//
//	This file is part of OpenZWave.
//
//	OpenZWave is free software: you can redistribute it and/or modify
//	it under the terms of the GNU Lesser General Public License as published
//	by the Free Software Foundation, either version 3 of the License,
//	or (at your option) any later version.
//
//	OpenZWave is distributed in the hope that it will be useful,
//	but WITHOUT ANY WARRANTY; without even the implied warranty of
//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//	GNU Lesser General Public License for more details.
//
//	You should have received a copy of the GNU Lesser General Public License
//	along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _TimeStampImpl_H
#define _TimeStampImpl_H

#include <stdio.h>
#include <time.h>
#include <sys/time.h>
#include "Defs.h"

namespace OpenZWave
{
	namespace Internal
	{
		namespace Platform
		{
			/** \brief Windows implementation of a timestamp.
			 */
			class TimeStampImpl
			{
				public:
					/**
					 * Constructor.
					 * Creates a TimeStampImpl object.
					 */
					TimeStampImpl();

					/**
					 * Destructor.
					 * Destroys the TimeStampImpl object.
					 */
					~TimeStampImpl();

					/**
					 * SetTime.  Sets the timestamp to now, plus the offset in milliseconds.
					 * \param _milliseconds positive or negative offset from 
					 * now in milliseconds.
					 */
					void SetTime(int32 _milliseconds);

					/**
					 * TimeRemaining.  Gets the difference between now and the timestamp
					 * time in milliseconds.
					 * \return milliseconds remaining until we reach the timestamp.  The 
					 * return value is negative if the timestamp is in the past.
					 */
					int32 TimeRemaining();

					/**
					 * Return as as string
					 */
					string GetAsString();

					/**
					 * Overload the subtract operator to get the difference between
					 * two timestamps in milliseconds.
					 */
					int32 operator-(TimeStampImpl const& _other);

				private:
					TimeStampImpl(TimeStampImpl const&);					// prevent copy
					TimeStampImpl& operator =(TimeStampImpl const&);			// prevent assignment

					struct timespec m_stamp;
			};
		} // namespace Platform
	} // namespace Internal
} // namespace OpenZWave

#endif //_TimeStampImpl_H

