OpenDDS::DCPS::TimeDuration Class Reference

#include <TimeDuration.h>

Inheritance diagram for OpenDDS::DCPS::TimeDuration:

Collaboration diagram for OpenDDS::DCPS::TimeDuration:

Public Member Functions
	TimeDuration ()
	TimeDuration (const TimeDuration &other)
	TimeDuration (const ACE_Time_Value &ace_time_value)
	TimeDuration (time_t sec, suseconds_t usec=0)
	TimeDuration (const DDS::Duration_t &dds_duration)
const ACE_Time_Value &	value () const
void	value (const ACE_Time_Value &ace_time_value)
bool	is_zero () const
bool	is_max () const
DDS::Duration_t	to_dds_duration () const
bool	boolean_test () const
String	str (unsigned decimal_places=3, bool just_sec=false) const
String	sec_str (unsigned decimal_places=3) const
TimeDuration &	operator+= (const TimeDuration &other)
TimeDuration &	operator-= (const TimeDuration &other)
TimeDuration &	operator= (const TimeDuration &other)
TimeDuration &	operator= (const time_t &other)
TimeDuration &	operator*= (double other)
TimeDuration &	operator/= (double other)
Public Member Functions inherited from OpenDDS::DCPS::SafeBool_T< TimeDuration >
	operator BoolType () const
Public Member Functions inherited from OpenDDS::DCPS::SafeBoolBase
void	this_type_does_not_support_comparisons () const

Static Public Member Functions
static TimeDuration	from_msec (const ACE_UINT64 &ms)
static TimeDuration	from_double (double duration)

Static Public Attributes
static const TimeDuration	zero_value
static const TimeDuration	max_value

Protected Attributes
ACE_Time_Value	value_

Additional Inherited Members
Public Types inherited from OpenDDS::DCPS::SafeBoolBase
typedef void(SafeBoolBase::*	BoolType) () const
Protected Member Functions inherited from OpenDDS::DCPS::SafeBool_T< TimeDuration >
	~SafeBool_T ()
Protected Member Functions inherited from OpenDDS::DCPS::SafeBoolBase
	SafeBoolBase ()
	SafeBoolBase (const SafeBoolBase &)
SafeBoolBase &	operator= (const SafeBoolBase &)
	~SafeBoolBase ()

Detailed Description

Represents a length of time and based on C++11 std::chrono::duration.

This wraps an ACE_Time_Value, and is designed to work with TimePoint_T.

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 29 of file TimeDuration.h.

Constructor & Destructor Documentation

TimeDuration() [1/5]

ACE_INLINE OpenDDS::DCPS::TimeDuration::TimeDuration

(

)

Initialized to zero

Definition at line 29 of file TimeDuration.inl.

References ACE_INLINE.

Referenced by from_double(), from_msec(), OpenDDS::DCPS::operator*(), OpenDDS::DCPS::operator+(), OpenDDS::DCPS::operator-(), and OpenDDS::DCPS::operator/().

: value_(ACE_Time_Value())
{
}

TimeDuration() [2/5]

ACE_INLINE OpenDDS::DCPS::TimeDuration::TimeDuration

(

const TimeDuration &

other

)

Definition at line 35 of file TimeDuration.inl.

References ACE_INLINE.

: value_(other.value_)
{
}

TimeDuration() [3/5]

ACE_INLINE OpenDDS::DCPS::TimeDuration::TimeDuration ( const ACE_Time_Value &  ace_time_value )

explicit

Copy the ACE_Time_Value directly.

Warning

It will accept a ACE_Time_Value that represents a specific point in time, but it is wrong to do so. Use one of the TimePoint_T classes defined in TimeTypes.h that match the clock type.

Definition at line 41 of file TimeDuration.inl.

References ACE_INLINE.

: value_(ace_time_value)
{
}

TimeDuration() [4/5]

ACE_INLINE OpenDDS::DCPS::TimeDuration::TimeDuration ( time_t  sec, suseconds_t  usec = 0  )

explicit

Define the number of seconds and optionally microseconds, passed to ACE_Time_Value's constructor of the same signature.

Definition at line 47 of file TimeDuration.inl.

References ACE_INLINE.

: value_(sec, usec)
{
}

TimeDuration() [5/5]

ACE_INLINE OpenDDS::DCPS::TimeDuration::TimeDuration ( const DDS::Duration_t &  dds_duration )

explicit

Converts the DDS Duration into the equivalent value.

Definition at line 53 of file TimeDuration.inl.

References ACE_INLINE.

: value_(duration_to_time_value(dds_duration))
{
}

Member Function Documentation

boolean_test()

bool OpenDDS::DCPS::TimeDuration::boolean_test ( ) const

inline

Definition at line 77 of file TimeDuration.h.

References value(), and value_.

  {
    return value_ != zero_value.value();
  }

from_double()

ACE_INLINE TimeDuration OpenDDS::DCPS::TimeDuration::from_double ( double  duration )

static

Return a TimeDuration from fractional seconds.

Definition at line 21 of file TimeDuration.inl.

References ACE_INLINE, ACE_Time_Value::set(), and TimeDuration().

Referenced by OpenDDS::RTPS::RtpsDiscovery::Config::discovery_config().

{
  ACE_Time_Value rv;
  rv.set(duration);
  return TimeDuration(rv);
}

from_msec()

ACE_INLINE TimeDuration OpenDDS::DCPS::TimeDuration::from_msec ( const ACE_UINT64 &  ms )

static

Return a TimeDuration equivalent to the given number of milliseconds.

Definition at line 12 of file TimeDuration.inl.

References ACE_INLINE, ACE_Time_Value::set_msec(), and TimeDuration().

Referenced by OpenDDS::DCPS::DataLink::DataLink(), OpenDDS::RTPS::RtpsDiscovery::Config::discovery_config(), OpenDDS::DCPS::TransportClient::enable_transport_using_config(), OpenDDS::DCPS::ReliableSession::expire_naks(), OpenDDS::DCPS::instance_handle_to_bit_data(), OpenDDS::DCPS::MulticastInst::MulticastInst(), OpenDDS::DCPS::ReliableSession::nak_delay(), OpenDDS::DCPS::TcpConnection::passive_reconnect_i(), and OpenDDS::DCPS::TcpSynchResource::TcpSynchResource().

{
  ACE_Time_Value rv;
  rv.set_msec(ms);
  return TimeDuration(rv);
}

is_max()

ACE_INLINE bool OpenDDS::DCPS::TimeDuration::is_max

(

)

const

Definition at line 81 of file TimeDuration.inl.

References ACE_INLINE, and max_value.

Referenced by OpenDDS::DCPS::DomainParticipantImpl::LivelinessTimer::execute().

{
  return *this == max_value;
}

is_zero()

ACE_INLINE bool OpenDDS::DCPS::TimeDuration::is_zero

(

)

const

Definition at line 74 of file TimeDuration.inl.

References ACE_INLINE, and zero_value.

Referenced by OpenDDS::DCPS::DomainParticipantImpl::await_handle(), OpenDDS::DCPS::DataDurabilityCache::insert(), OpenDDS::DCPS::Service_Participant::new_pending_timeout_deadline(), OpenDDS::DCPS::DataReaderImpl::time_based_filter_instance(), OpenDDS::DCPS::DataReaderImpl::transport_assoc_done(), OpenDDS::DCPS::TcpTransport::unbind_link(), OpenDDS::DCPS::ThreadStatusManager::Thread::utilization(), and OpenDDS::DCPS::ConditionVariable< ACE_Thread_Mutex >::wait_for().

{
  return *this == zero_value;
}

operator*=()

ACE_INLINE TimeDuration & OpenDDS::DCPS::TimeDuration::operator*=

(

double

other

)

Definition at line 111 of file TimeDuration.inl.

References ACE_INLINE, and value_.

{
  value_ *= other;
  return *this;
}

operator+=()

ACE_INLINE TimeDuration & OpenDDS::DCPS::TimeDuration::operator+=

(

const TimeDuration &

other

)

Definition at line 95 of file TimeDuration.inl.

References ACE_INLINE, value(), and value_.

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

operator-=()

ACE_INLINE TimeDuration & OpenDDS::DCPS::TimeDuration::operator-=

(

const TimeDuration &

other

)

Definition at line 103 of file TimeDuration.inl.

References ACE_INLINE, value(), and value_.

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

operator/=()

ACE_INLINE TimeDuration & OpenDDS::DCPS::TimeDuration::operator/=

(

double

other

)

Definition at line 118 of file TimeDuration.inl.

References ACE_INLINE, and value_.

{
  value_ *= (1.0 / other);
  return *this;
}

operator=() [1/2]

ACE_INLINE TimeDuration & OpenDDS::DCPS::TimeDuration::operator=

(

const TimeDuration &

other

)

Definition at line 126 of file TimeDuration.inl.

References ACE_INLINE, value(), and value_.

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

operator=() [2/2]

ACE_INLINE TimeDuration & OpenDDS::DCPS::TimeDuration::operator=

(

const time_t &

other

)

Definition at line 134 of file TimeDuration.inl.

References ACE_INLINE, and value_.

{
  value_ = other;
  return *this;
}

sec_str()

String OpenDDS::DCPS::TimeDuration::sec_str ( unsigned  decimal_places = 3 ) const

inline

Definition at line 93 of file TimeDuration.h.

References OpenDDS::DCPS::operator+=().

  {
    return str(decimal_places, true);
  }

str()

String OpenDDS::DCPS::TimeDuration::str	(	unsigned	decimal_places = 3,
		bool	just_sec = false
	)		const

Convert to a string in a humanized format: SECONDS.FRACTIONAL s if the time is less than a minute or just_sec is true, else: [[HOURS:]MINUTES:]SECONDS.FRACTIONAL

decimal_places is the number of decimal places to round to in the fractional seconds.

Definition at line 54 of file TimeDuration.cpp.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL, ACE_Time_Value::sec(), OpenDDS::DCPS::to_dds_string(), ACE_Time_Value::usec(), and value().

Referenced by OpenDDS::DCPS::ShmemInst::dump_to_str(), OpenDDS::DCPS::RtpsUdpInst::dump_to_str(), OpenDDS::DCPS::TransportInst::dump_to_str(), OpenDDS::DCPS::MulticastInst::dump_to_str(), OpenDDS::RTPS::Spdp::handle_participant_data(), OpenDDS::DCPS::DataReaderImpl::process_latency(), and OpenDDS::DCPS::TcpTransport::release_datalink().

{
  String rv;
  time_t sec = value().sec();
  suseconds_t usec = value().usec();
  bool negative = false;
  if (sec < 0) {
    negative = true;
    sec = -sec;
  }
  if (usec < 0) {
    negative = true;
    usec = -usec;
  }
  if (negative) {
    rv += "-";
  }
  time_t carry;
  const time_t numerator = usec_to_rounded_frac(usec, decimal_places, carry);
  const time_t seconds_total = sec + carry;
  const time_t minutes_total = seconds_total / 60;
  just_sec = just_sec || minutes_total == 0;
  if (just_sec) {
    rv += to_dds_string(seconds_total);
  } else {
    const time_t seconds = seconds_total % 60;
    const time_t minutes = minutes_total % 60;
    const time_t hours = minutes_total / 60;
    if (hours > 0) {
      rv += to_dds_string(hours) + ":" + to_zero_pad_str(minutes);
    } else {
      rv += to_dds_string(minutes);
    }
    rv += ":" + to_zero_pad_str(seconds);
  }
  if (decimal_places > 0) {
    rv += "." + to_zero_pad_str(numerator, decimal_places);
  }
  if (just_sec) {
    rv += " s";
  }
  return rv;
}

to_dds_duration()

ACE_INLINE DDS::Duration_t OpenDDS::DCPS::TimeDuration::to_dds_duration

(

)

const

Definition at line 88 of file TimeDuration.inl.

References ACE_INLINE, OpenDDS::DCPS::time_value_to_duration(), and value().

Referenced by OpenDDS::DCPS::RtpsUdpTransport::disable_relay_stun_task(), OpenDDS::RTPS::Spdp::SpdpTransport::disable_relay_stun_task(), OpenDDS::DCPS::RtpsUdpTransport::process_relay_sra(), and OpenDDS::RTPS::Spdp::SpdpTransport::process_relay_sra().

{
  return time_value_to_duration(value());
}

value() [1/2]

ACE_INLINE const ACE_Time_Value & OpenDDS::DCPS::TimeDuration::value

(

void

)

const

Definition at line 60 of file TimeDuration.inl.

References ACE_INLINE, and value_.

Referenced by OpenDDS::DCPS::WriterStats::add_stat(), boolean_test(), OpenDDS::RTPS::Spdp::build_local_pdata(), OpenDDS::DCPS::DataReaderImpl::LivelinessTimer::check_liveliness_i(), OpenDDS::DCPS::DataWriterImpl::enable(), OpenDDS::DCPS::PeriodicTask::enable_i(), OpenDDS::DCPS::MultiTask::enable_i(), OpenDDS::ICE::ScheduleTimerCommand::execute(), OpenDDS::DCPS::SporadicTask::execute_i(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), OpenDDS::DCPS::DomainParticipantImpl::find_topic(), OpenDDS::DCPS::DataLink::handle_exception(), OpenDDS::RTPS::Spdp::handle_participant_data(), OpenDDS::DCPS::DataWriterImpl::handle_timeout(), OpenDDS::DCPS::Service_Participant::initializeScheduling(), OpenDDS::DCPS::DataDurabilityCache::insert(), OpenDDS::DCPS::UdpDataLink::open(), OpenDDS::DCPS::operator!=(), OpenDDS::DCPS::operator*(), OpenDDS::DCPS::operator+(), operator+=(), OpenDDS::DCPS::TimePoint_T< SystemClock >::operator+=(), OpenDDS::DCPS::operator-(), operator-=(), OpenDDS::DCPS::TimePoint_T< SystemClock >::operator-=(), OpenDDS::DCPS::operator/(), OpenDDS::DCPS::operator<(), OpenDDS::DCPS::operator<=(), operator=(), OpenDDS::DCPS::operator==(), OpenDDS::DCPS::operator>(), OpenDDS::DCPS::operator>=(), OpenDDS::DCPS::TcpConnection::passive_reconnect_i(), OpenDDS::DCPS::resend_data_expired(), str(), to_dds_duration(), and OpenDDS::DCPS::ThreadSynchResource::wait_to_unclog().

{
  return value_;
}

value() [2/2]

ACE_INLINE void OpenDDS::DCPS::TimeDuration::value

(

const ACE_Time_Value &

ace_time_value

)

Definition at line 67 of file TimeDuration.inl.

References ACE_INLINE, and value_.

{
  value_ = ace_time_value;
}

Member Data Documentation

max_value

const TimeDuration OpenDDS::DCPS::TimeDuration::max_value

static

Definition at line 32 of file TimeDuration.h.

Referenced by OpenDDS::DCPS::WriteDataContainer::cancel_deadline(), OpenDDS::DCPS::WriteDataContainer::extend_deadline(), is_max(), OpenDDS::DCPS::PublisherImpl::liveliness_check_interval(), OpenDDS::DCPS::DataWriterImpl::liveliness_check_interval(), OpenDDS::DCPS::DomainParticipantImpl::liveliness_check_interval(), OpenDDS::RTPS::rtps_duration_to_time_duration(), and OpenDDS::DCPS::WriteDataContainer::set_deadline_period().

value_

ACE_Time_Value OpenDDS::DCPS::TimeDuration::value_

protected

Definition at line 106 of file TimeDuration.h.

Referenced by operator*=(), operator+=(), operator-=(), operator/=(), operator=(), and value().

zero_value

const TimeDuration OpenDDS::DCPS::TimeDuration::zero_value

static

Definition at line 31 of file TimeDuration.h.

Referenced by OpenDDS::RTPS::Spdp::attempt_authentication(), OpenDDS::DCPS::RtpsUdpTransport::configure_i(), OpenDDS::DCPS::RtpsUdpTransport::disable_relay_stun_task(), OpenDDS::RTPS::Spdp::SpdpTransport::disable_relay_stun_task(), OpenDDS::DCPS::RtpsUdpDataLink::disable_response_queue(), OpenDDS::RTPS::Spdp::SpdpTransport::enable_periodic_tasks(), OpenDDS::RTPS::Spdp::handle_participant_data(), is_zero(), OpenDDS::DCPS::RtpsUdpTransport::make_datalink(), OpenDDS::DCPS::operator-(), OpenDDS::DCPS::TcpConnection::passive_reconnect_i(), OpenDDS::DCPS::RtpsUdpTransport::process_relay_sra(), OpenDDS::RTPS::Spdp::SpdpTransport::process_relay_sra(), OpenDDS::DCPS::TcpTransport::release_datalink(), OpenDDS::DCPS::RtpsUdpTransport::rtps_relay_address_change(), OpenDDS::DCPS::RtpsUdpTransport::rtps_relay_only_now(), OpenDDS::RTPS::Spdp::rtps_relay_only_now(), OpenDDS::RTPS::Spdp::spdp_rtps_relay_address_change(), OpenDDS::RTPS::Spdp::update_rtps_relay_application_participant_i(), OpenDDS::DCPS::ThreadStatusManager::update_thread_status(), OpenDDS::DCPS::RtpsUdpTransport::use_rtps_relay_now(), OpenDDS::RTPS::Spdp::use_rtps_relay_now(), and OpenDDS::DCPS::ThreadStatusManager::Thread::utilization().

---

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

• TimeDuration.h
• TimeDuration.cpp
• TimeDuration.inl