path: root/src/base/timestamp.hpp

/*
 * UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef TIMESTAMP_HPP
#define TIMESTAMP_HPP

namespace usdx
{
	/**
	 * Simple class to store a given point of time and get the duration until
	 * now.
	 */
	class Timestamp
	{
	private:
		/**
		 * internal storage of the point of time represented by the timestamp instance
		 */
		float time;

	public:
		/**
		 * Create a Timestamp instance and store the current time.
		 */
		Timestamp(void);

		/**
		 * Check how many time elapsed since the recorded point of time.
		 *
		 * @param duration how many time may be elapsed
		 * @return true, if the elapsed time is less than the given duration,
		 * otherwise false
		 */
		bool since(float duration) const;

		/**
		 * Update the stored point of time to the current time.
		 */
		void update(void);
	};
}

#endif