NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
system_time_interface.h
Go to the documentation of this file.
1 #ifndef SDK_SYSTEM_TIME_INTERFACE_H_
11 #define SDK_SYSTEM_TIME_INTERFACE_H_
12 
14 
15 namespace sdk {
16 namespace base {
17 
18 FWD_DECL_INTERFACE(ISystemTime);
19 
23 {
27 };
28 
32 {
33 public:
35  virtual SDKResult SDK_CALLTYPE GetUTCTime(SDKTime& time) const throw() = 0;
37  virtual SDKResult SDK_CALLTYPE GetLocalTime(SDKTime& time) const throw() = 0;
39  virtual SDKResult SDK_CALLTYPE UTCToLocal(
40  const SDKTime& utc_time,
41  SDKTime& local_time) const throw() = 0;
43  virtual SDKResult SDK_CALLTYPE LocalToUTC(
44  const SDKTime& local_time,
45  SDKTime& utc_time) const throw() = 0;
47  virtual SDKResult SDK_CALLTYPE AdjustTime(
48  const SDKTime& current_time) throw() = 0;
50  virtual SDKResult SDK_CALLTYPE ResetTimeCorrection() throw() = 0;
51  // ISDKProperties
52  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, const SDKAny& value) throw() = 0;
53  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, SDKAny& value) const throw() = 0;
54 
55  SDK_IMPLEMENT_IID(ISystemTime)
56  SDK_END_INTERFACE(ISystemTime)
57 };
58 SDK_DECLARE_IID(ISystemTime)
59 
60 } // namespace base
61 } // namespace sdk
62 
63 #endif // SDK_SYSTEM_TIME_INTERFACE_H_
sdk::base::SystemTimeProperties
SystemTimeProperties
System time properties.
Definition: system_time_interface.h:22
properties_interface.h
Object generic properties interface.
sdk::base::ISystemTime::GetLocalTime
virtual SDKResult SDK_CALLTYPE GetLocalTime(SDKTime &time) const =0
Gets Local time.
sdk::base::ISystemTime::GetUTCTime
virtual SDKResult SDK_CALLTYPE GetUTCTime(SDKTime &time) const =0
Gets UTC time.
sdk::base::kSystemTimeProperty_TimeZoneBias
@ kSystemTimeProperty_TimeZoneBias
Time zone bias.
Definition: system_time_interface.h:24
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
sdk::base::ISystemTime::AdjustTime
virtual SDKResult SDK_CALLTYPE AdjustTime(const SDKTime &current_time)=0
Adjusts time.
sdk::base::ISystemTime::UTCToLocal
virtual SDKResult SDK_CALLTYPE UTCToLocal(const SDKTime &utc_time, SDKTime &local_time) const =0
Converts UTC time to Local time.
sdk::ISDKProperties
Provides access to members that control the properties.
Definition: properties_interface.h:32
sdk::base::kSystemTimeProperty_TimeCorrection
@ kSystemTimeProperty_TimeCorrection
Time correction (only get).
Definition: system_time_interface.h:26
sdk::base::kSystemTimeProperty_DaylightSavingBias
@ kSystemTimeProperty_DaylightSavingBias
Daylight savings bias.
Definition: system_time_interface.h:25
sdk::base::ISystemTime::ResetTimeCorrection
virtual SDKResult SDK_CALLTYPE ResetTimeCorrection()=0
Reset the time correction.
SDKTime
SDK_END_NAMESPACE typedef SDKInt64 SDKTime
Milliseconds from Unix epoch.
Definition: base_types.h:56
sdk::base::ISystemTime
System time manager interface.
Definition: system_time_interface.h:31
sdk::base::ISystemTime::LocalToUTC
virtual SDKResult SDK_CALLTYPE LocalToUTC(const SDKTime &local_time, SDKTime &utc_time) const =0
Converts Local time to UTC time.
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.