#include <TimePoint_T.h>

Inheritance diagram for OpenDDS::DCPS::TimePoint_T< AceClock >:

Collaboration diagram for OpenDDS::DCPS::TimePoint_T< AceClock >:

[legend]

Public Types
typedef AceClock	ClockType

typedef ACE_Time_Value_T< AceClock >	ValueType

Public Types inherited from OpenDDS::DCPS::SafeBoolBase
typedef void(SafeBoolBase::*	BoolType) () const

Public Member Functions
	TimePoint_T ()

bool	is_zero () const

bool	boolean_test () const

bool	is_max () const

void	set_to_now ()

DDS::Time_t	to_dds_time () const

MonotonicTime_t	to_monotonic_time () const

TimePoint_T< AceClock > &	operator+= (const TimeDuration &td)

TimePoint_T< AceClock > &	operator-= (const TimeDuration &td)


	TimePoint_T (const ACE_Time_Value &ace_time_value)

	TimePoint_T (const ACE_Time_Value_T< AceClock > &ace_time_value)

	TimePoint_T (const DDS::Time_t &dds_time)


const ACE_Time_Value_T< AceClock > &	value () const

void	value (const ACE_Time_Value_T< AceClock > &ace_time_value)

Public Member Functions inherited from OpenDDS::DCPS::SafeBool_T< TimePoint_T< AceClock > >
	operator BoolType () const

Public Member Functions inherited from OpenDDS::DCPS::SafeBoolBase
void	this_type_does_not_support_comparisons () const

Static Public Member Functions
static TimePoint_T< AceClock >	now ()

Static Public Attributes
static const TimePoint_T< AceClock >	zero_value

static const TimePoint_T< AceClock >	max_value

Protected Attributes
ValueType	value_

Static Protected Attributes
static ClockType	clock

Additional Inherited Members
Protected Member Functions inherited from OpenDDS::DCPS::SafeBool_T< TimePoint_T< AceClock > >
	~SafeBool_T ()

Protected Member Functions inherited from OpenDDS::DCPS::SafeBoolBase
	SafeBoolBase ()

	SafeBoolBase (const SafeBoolBase &)

SafeBoolBase &	operator= (const SafeBoolBase &)

	~SafeBoolBase ()

Detailed Description

template<typename AceClock>
class OpenDDS::DCPS::TimePoint_T< AceClock >

Represents a specific time in reference to a ACE_Time_Policy and is based on C++11 std::chrono::time_point.

This wraps an ACE_Time_Value, but is designed to enforce the logic that this represents a specific point in time. For example, you can't directly add two TimePoints like you can add two ACE_Time_Values, because that wouldn't make sense. Following this theme, all the constructors are to be explicit to avoid careless implicit conversions.

See https://opendds.readthedocs.io/en/master/internal/dev_guidelines.html#time (or docs/internal/dev_guidelines.rst) for background and reasoning for this class.

Definition at line 35 of file TimePoint_T.h.

Member Typedef Documentation

◆ ClockType

template<typename AceClock>

typedef AceClock OpenDDS::DCPS::TimePoint_T< AceClock >::ClockType

Definition at line 37 of file TimePoint_T.h.

◆ ValueType

template<typename AceClock>

typedef ACE_Time_Value_T<AceClock> OpenDDS::DCPS::TimePoint_T< AceClock >::ValueType

Definition at line 38 of file TimePoint_T.h.

Constructor & Destructor Documentation

◆ TimePoint_T() [1/4]

template<typename AceClock >

ACE_INLINE OpenDDS::DCPS::TimePoint_T< AceClock >::TimePoint_T ( )

Set to zero_value, which is equal to the epoch (the starting point) of the AceClock.

Definition at line 12 of file TimePoint_T.inl.

 : value_(zero_value.value())
 {
 }

◆ TimePoint_T() [2/4]

template<typename AceClock >

ACE_INLINE OpenDDS::DCPS::TimePoint_T< AceClock >::TimePoint_T ( const ACE_Time_Value & ace_time_value )

explicit

Assign the value directly to the inner value doing conversions as necessary.

Warning: Use these carefully. Make sure ACE_Time_Value is a point in time and of the right clock type. DDS::Time_t should be in system clock time and so shouldn't be used with MonotonicTimePoint.

Definition at line 19 of file TimePoint_T.inl.

 : value_(ace_time_value)
 {
 }

◆ TimePoint_T() [3/4]

template<typename AceClock>

ACE_INLINE OpenDDS::DCPS::TimePoint_T< AceClock >::TimePoint_T ( const ACE_Time_Value_T< AceClock > & ace_time_value )

explicit

Assign the value directly to the inner value doing conversions as necessary.

Warning: Use these carefully. Make sure ACE_Time_Value is a point in time and of the right clock type. DDS::Time_t should be in system clock time and so shouldn't be used with MonotonicTimePoint.

Definition at line 26 of file TimePoint_T.inl.

 : value_(ace_time_value)
 {
 }

◆ TimePoint_T() [4/4]

template<typename AceClock>

ACE_INLINE OpenDDS::DCPS::TimePoint_T< AceClock >::TimePoint_T ( const DDS::Time_t & dds_time )

explicit

Assign the value directly to the inner value doing conversions as necessary.

Warning: Use these carefully. Make sure ACE_Time_Value is a point in time and of the right clock type. DDS::Time_t should be in system clock time and so shouldn't be used with MonotonicTimePoint.

Definition at line 33 of file TimePoint_T.inl.

 : value_(time_to_time_value(dds_time))
 {
 }

Member Function Documentation

◆ boolean_test()

template<typename AceClock>

bool OpenDDS::DCPS::TimePoint_T< AceClock >::boolean_test ( ) const

inline

Definition at line 83 of file TimePoint_T.h.

   {
     return *this != zero_value;
   }

◆ is_max()

template<typename AceClock >

ACE_INLINE bool OpenDDS::DCPS::TimePoint_T< AceClock >::is_max ( ) const

Is the object equal to the maximum possible value, max_value?

Definition at line 73 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test().

 {
   return *this == max_value;
 }

◆ is_zero()

template<typename AceClock >

ACE_INLINE bool OpenDDS::DCPS::TimePoint_T< AceClock >::is_zero ( ) const

Is the object equal to zero_value?

Definition at line 65 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::DataLink::handle_exception(), OpenDDS::DCPS::DataLink::handle_timeout(), OpenDDS::DCPS::DomainParticipantImpl::participant_liveliness_activity_after(), OpenDDS::DCPS::DataReaderImpl::process_deadline(), OpenDDS::DCPS::Service_Participant::repository_lost(), OpenDDS::DCPS::DataLink::schedule_stop(), OpenDDS::DCPS::MessageTracker::wait_messages_pending(), OpenDDS::DCPS::WriteDataContainer::wait_pending(), and OpenDDS::DCPS::ConditionVariable< ACE_Thread_Mutex >::wait_until().

 {
   return *this == zero_value;
 }

◆ now()

template<typename AceClock >

ACE_INLINE TimePoint_T< AceClock > OpenDDS::DCPS::TimePoint_T< AceClock >::now ( )

static

Get a TimePoint representing the current time of the AceClock.

Definition at line 41 of file TimePoint_T.inl.

 {
   return TimePoint_T<AceClock>(clock());
 }

◆ operator+=()

template<typename AceClock >

ACE_INLINE TimePoint_T< AceClock > & OpenDDS::DCPS::TimePoint_T< AceClock >::operator+= ( const TimeDuration & td )

Definition at line 105 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test().

 {
   value_ += td.value();
   return *this;
 }

◆ operator-=()

template<typename AceClock >

ACE_INLINE TimePoint_T< AceClock > & OpenDDS::DCPS::TimePoint_T< AceClock >::operator-= ( const TimeDuration & td )

Definition at line 114 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test().

 {
   value_ -= td.value();
   return *this;
 }

◆ set_to_now()

template<typename AceClock >

ACE_INLINE void OpenDDS::DCPS::TimePoint_T< AceClock >::set_to_now ( )

Set the value to the current time of the AceClock Type.

Definition at line 81 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::DataReaderImpl::accept_sample_processing(), OpenDDS::DCPS::DomainParticipantImpl::assert_liveliness(), OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::filter_delayed(), OpenDDS::ICE::Checklist::indication(), OpenDDS::ICE::Checklist::succeeded(), and OpenDDS::DCPS::DataWriterImpl::write().

 {
   value_ = clock();
 }

◆ to_dds_time()

template<typename AceClock >

ACE_INLINE DDS::Time_t OpenDDS::DCPS::TimePoint_T< AceClock >::to_dds_time ( ) const

Convert to DDS::Time_t. This is probably only desirable for the system time version of this template class, SystemTimePoint.

Definition at line 89 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test(), OpenDDS::DCPS::InternalDataReader< T >::Instance::can_purge_instance(), OpenDDS::DCPS::InternalDataReader< T >::Instance::dispose(), OpenDDS::DCPS::DomainParticipantImpl::get_current_time(), OpenDDS::FaceTSS::populate_header_received(), OpenDDS::DCPS::InternalDataReader< T >::Instance::purge_samples(), OpenDDS::DCPS::ReceivedDataElement::ReceivedDataElement(), OpenDDS::DCPS::DataWriterImpl::send_request_ack(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::set_instance_state_i(), and OpenDDS::DCPS::InternalDataReader< T >::Instance::unregister_instance().

 {
   return time_value_to_time(value_);
 }

◆ to_monotonic_time()

template<typename AceClock >

ACE_INLINE MonotonicTime_t OpenDDS::DCPS::TimePoint_T< AceClock >::to_monotonic_time ( ) const

Convert to OpenDDS::DCPS::MonotonicTime_t.

Definition at line 97 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test().

 {
   return time_value_to_monotonic_time(value_);
 }

◆ value() [1/2]

template<typename AceClock >

ACE_INLINE const ACE_Time_Value_T< AceClock > & OpenDDS::DCPS::TimePoint_T< AceClock >::value ( void ) const

Get and set the inner ACE_Time_Value based value. Use value() to pass this into ACE code that requires a point in time matching this ones clock type.

Definition at line 49 of file TimePoint_T.inl.

Referenced by OpenDDS::DCPS::operator!=(), OpenDDS::DCPS::operator+(), OpenDDS::DCPS::operator-(), OpenDDS::DCPS::operator<(), OpenDDS::DCPS::operator<=(), OpenDDS::DCPS::operator==(), OpenDDS::DCPS::operator>(), OpenDDS::DCPS::operator>=(), OpenDDS::DCPS::MessageTracker::wait_messages_pending(), OpenDDS::DCPS::WriteDataContainer::wait_pending(), and OpenDDS::DCPS::ConditionVariable< ACE_Thread_Mutex >::wait_until().

 {
   return value_;
 }

◆ value() [2/2]

template<typename AceClock>

ACE_INLINE void OpenDDS::DCPS::TimePoint_T< AceClock >::value ( const ACE_Time_Value_T< AceClock > & ace_time_value )

Get and set the inner ACE_Time_Value based value. Use value() to pass this into ACE code that requires a point in time matching this ones clock type.

Definition at line 57 of file TimePoint_T.inl.

 {
   value_ = ace_time_value;
 }

Member Data Documentation

◆ clock

template<typename AceClock>

AceClock OpenDDS::DCPS::TimePoint_T< AceClock >::clock

staticprotected

Strangely, ACE_Time_Policy must be objects to get their time values, so keep a static object.

Definition at line 117 of file TimePoint_T.h.

◆ max_value

template<typename AceClock>

const TimePoint_T< AceClock > OpenDDS::DCPS::TimePoint_T< AceClock >::max_value

static

Definition at line 41 of file TimePoint_T.h.

◆ value_

template<typename AceClock>

ValueType OpenDDS::DCPS::TimePoint_T< AceClock >::value_

protected

Definition at line 119 of file TimePoint_T.h.

◆ zero_value

template<typename AceClock>

const TimePoint_T< AceClock > OpenDDS::DCPS::TimePoint_T< AceClock >::zero_value

static

Definition at line 40 of file TimePoint_T.h.

Referenced by OpenDDS::DCPS::TimePoint_T< SystemClock >::boolean_test().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

template<typename AceClock> class OpenDDS::DCPS::TimePoint_T< AceClock >

Member Typedef Documentation

◆ ClockType

◆ ValueType

Constructor & Destructor Documentation

◆ TimePoint_T() [1/4]

◆ TimePoint_T() [2/4]

◆ TimePoint_T() [3/4]

◆ TimePoint_T() [4/4]

Member Function Documentation

◆ boolean_test()

◆ is_max()

◆ is_zero()

◆ now()

◆ operator+=()

◆ operator-=()

◆ set_to_now()

◆ to_dds_time()

◆ to_monotonic_time()

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ clock

◆ max_value

◆ value_

◆ zero_value

template<typename AceClock>
class OpenDDS::DCPS::TimePoint_T< AceClock >