TAO/tao/TimeBase.pidl

   1 // -*- IDL -*-
   2
   3 /**
   4  *  @file TimeBase.pidl
   5  */
   6
   7 #ifndef TIME_BASE_PIDL
   8 #define TIME_BASE_PIDL
   9
  10 #pragma prefix "omg.org"
  11
  12 /**
  13  * @brief COS Time Service basic types.
  14  *
  15  *
  16  * The standard CORBA Time Service defines a number of data structures
  17  * to manipulate and express time.
  18  * Over time these data structures have found their way into core
  19  * components of CORBA, such as CORBA Messaging, RT CORBA, etc.
  20  */
  21 module TimeBase
  22 {
  23   /// Time in TimeT is expressed in units of 100 nano seconds
  24   /**
  25    * In other words each TimeT is 10^-7 seconds.
  26    * When used for absolute time 0 is to October 15, 1582. Please read
  27    * the spec for further details.
  28    */
  29   typedef unsigned long long TimeT;
  30
  31   /// To express an error estimate for time.
  32   typedef TimeT InaccuracyT;
  33
  34   /// Minutes of displacement from the Greenwich time.
  35   typedef short TdfT;
  36
  37   /**
  38    * @brief A timestamp in UTC time
  39    *
  40    * The inaccuracy is packed into inacclo & inacchi.
  41    * tdf holds the time displacement factor.
  42    *
  43    * There are a total of 16 octets in this struct.
  44    *
  45    * @todo What is exactly the range of time here?
  46    *       Is it [time-inacclo,time+inacchi]?
  47    */
  48   struct UtcT
  49   {
  50     /// The actual time
  51     TimeT time;
  52
  53     /// The lowest bound for inaccuracy
  54     unsigned long inacclo;
  55
  56     /// The upper bound for the inaccuracy
  57     unsigned short inacchi;
  58
  59     /// @todo please document
  60     TdfT tdf;
  61   };
  62
  63   /**
  64    * @brief An UTC time interval
  65    *
  66    */
  67   struct IntervalT
  68   {
  69     /// Lower bound of the interval.
  70     TimeT lower_bound;
  71
  72     /// Upper bound of the interval.
  73     TimeT upper_bound;
  74   };
  75 };
  76
  77 #endif /* TIME_BASE_PIDL */