timesource.h

00001 
00002 /***************************************************************************
00003  *  timesource.h - A clock's timesource
00004  *
00005  *  Created: Sun Jun 03 10:58:19 2007
00006  *  Copyright  2007  Daniel Beck 
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023 
00024 #ifndef __UTILS_TIME_TIMESOURCE_H_
00025 #define __UTILS_TIME_TIMESOURCE_H_
00026 
00027 #include <sys/time.h>
00028 
00029 namespace fawkes {
00030 
00031 /** TimeSource interface.
00032  * This interfaces describes a way to interact with time sources that can be
00033  * given to a Clock (for instance for simulation environments).
00034  * @author Daniel Beck
00035  */
00036 class TimeSource
00037 {
00038  public:
00039   /** Destructor. */
00040   virtual ~TimeSource() {}
00041 
00042   /** Get the current time.
00043    * @param tv the current time is written to this timeval
00044    */
00045   virtual void get_time(timeval* tv) const = 0;
00046 
00047   /** Convert a time given w.r.t. this time sources into system time.
00048    * @param tv the time to convert
00049    * @return the converted time
00050    */
00051   virtual timeval conv_to_realtime(const timeval* tv) const = 0;
00052 };
00053 
00054 } // end namespace fawkes
00055 
00056 #endif /*  __UTILS_TIME_TIMESOURCE_H_ */

Generated on Tue Feb 22 13:31:28 2011 for Fawkes API by  doxygen 1.4.7