kstars/kstars/simclockinterface.h

   1 /***************************************************************************
   2                           simclockinterface.h  -  description
   3                              -------------------
   4     begin                : Mon Feb 18 2002
   5     copyright          : (C) 2002 by Mark Hollomon
   6     email                : mhh@mindspring.com
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef KSTARS_SIMCLOCKIF_H_
  19 #define KSTARS_SIMCLOCKIF_H_
  20
  21 #include <dcopobject.h>
  22
  23 #include "kstarsdatetime.h"
  24
  25 /**@class SimclockInterface
  26         *DCOP functions for the KSTars simulation clock.
  27         *@author Mark Hollomon
  28         *@version 1.0
  29         */
  30
  31 class SimClockInterface : virtual public DCOPObject {
  32         K_DCOP
  33
  34         k_dcop:
  35                 /**Stop the clock
  36                         */
  37                 virtual ASYNC stop() = 0;
  38
  39                 /**Start the clock
  40                         */
  41                 virtual ASYNC start() = 0;
  42
  43                 /**Set the clock to the given ExtDateTime value.
  44                         *@p newtime the time/date to adopt
  45                         */
  46                 virtual ASYNC setUTC(const KStarsDateTime &newtime) = 0;
  47
  48                 /**Set the clock scale (the number of simulation seconds that
  49                         *pass per real-time second.
  50                         *@p s the new timescale factor
  51                         */
  52                 virtual ASYNC setClockScale(float s) = 0;
  53 };
  54
  55 #endif