summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Time/TAO_UTO.h
blob: 4360cf131b75d1ee8ae62f891429b0da16d0b1aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
// -*- C++ -*-
// $Id$

// ============================================================================
//
// = LIBRARY
//    TAO/orbsvcs/Time_Service
//
// = FILENAME
//    TAO_UTO.h
//
// = DESCRIPTION
//    This class implements the CosTime::UTO IDL interface.
//
// = AUTHOR
//    Vishal Kachroo  <vishal@cs.wustl.edu>
//
// ============================================================================

#ifndef TAO_UTO_H
#define	TAO_UTO_H

#include "orbsvcs/TimeServiceS.h"

class TAO_ORBSVCS_Export TAO_UTO : public POA_CosTime::UTO
{
  // = TITLE
  //    Universal Time Object Implementation.
  //
  // = DESCRIPTION
  //    This is an encapsulation of the time. It provides the following
  //    operations on basic time.
  //
  //      - Construction of a UTO from piece parts, and extraction of the
  //        piece parts from a UTO. The piece parts are the readonly
  //        attributes :
  //                      time
  //                      inaccuracy
  //                      time displacement factor
  //                      structure with all the above.
  //
  //      - Comparison of time.
  //
  //      - Conversion from relative to absolute time, and conversion to
  //        an interval (TIO).
public:
  // = Initialization and termination methods.
  TAO_UTO (TimeBase::TimeT time,
	   TimeBase::InaccuracyT inaccuracy,
	   TimeBase::TdfT tdf);
  // Constructor.

  ~TAO_UTO (void);
  // Destructor.

  virtual TimeBase::TimeT time (CORBA::Environment &env);
  // For the readonly attribute <time>.

  virtual TimeBase::InaccuracyT  inaccuracy (CORBA::Environment &env);
  // For the readonly attribute <inaccuracy>.

  virtual TimeBase::TdfT tdf (CORBA::Environment &env);
  // For the readonly attribute <tdf>, which is the "time displacement
  // factor".

  virtual TimeBase::UtcT utc_time (CORBA::Environment &env);
  // For the readonly attribute <utc_time>.

  CosTime::UTO_ptr absolute_time (CORBA::Environment &env);
  // Absolute time = Relative time + Base time.
  // ?? Find out more about the Base Time, UTC and
  //    Distributed Time Sync. Algos. [3

  CosTime::TimeComparison compare_time (CosTime::ComparisonType comparison_type,
					CosTime::UTO_ptr uto,
					CORBA::Environment &env);
  // Compares the time contained in the object with the time in the
  // supplied uto according to the supplied comparison type.

  CosTime::TIO_ptr time_to_interval (CosTime::UTO_ptr,
				     CORBA::Environment &env);
  // Returns a TIO representing the time interval between the time in
  // the object and the time in the UTO passed as a parameter. The
  // interval returned is the interval between the mid-points of the
  // two UTOs. Inaccuracies are ignored.  Note the result of this
  // operation is meaningless if the base times of UTOs are different.

  CosTime::TIO_ptr interval (CORBA::Environment &env);
  // Returns a TIO object representing the error interval around the
  // time value in the UTO.

private:
  TimeBase::UtcT attr_utc_time_;
  // The readonly attribute structure having the time, inaccuracy and
  // displacement.  The get methods for other readonly attributes
  // (time, inaccuracy, tdf) defined in the IDL use the members of
  // this structure and hence need not have separate member variables
  // for them.
};

#endif /* TAO_UTO_H */