rtctk::componentFramework::TimeString Struct Reference

Represents an ISO 8601 time string in format: YYYY-MM-DDThh:mm:ss.sssZ. More...

#include <rtctk/componentFramework/timeString.hpp>

Public Member Functions
	TimeString ()=default
	operator std::string () const
	Implicit conversion to std::string.
const std::string &	ToString () const
	Explicit conversion to std::string.
bool	operator== (const TimeString &) const =default
	Operator to test equality.
	TimeString (const std::string &str)
	Constructs TimeString from std::string.
	TimeString (const char *str)
	Constructs TimeString from c-style string.
template<typename Clock, typename Duration = typename Clock::duration>
	TimeString (std::chrono::time_point< Clock, Duration > timepoint)
	Constructs TimeString from chrono timepoint.
	TimeString (std::chrono::nanoseconds ns_since_epoch)
	Constructs TimeString from chrono::nanoseconds (based on taiclock::TaiClock).
	TimeString (uint64_t ns_since_epoch)
	Constructs TimeString from nanoseconds number (based on taiclock::TaiClock).

Public Attributes
std::string	value

Detailed Description

Represents an ISO 8601 time string in format: YYYY-MM-DDThh:mm:ss.sssZ.

Constructor & Destructor Documentation

TimeString() [1/6]

rtctk::componentFramework::TimeString::TimeString ( )

default

TimeString() [2/6]

rtctk::componentFramework::TimeString::TimeString

(

const std::string &

str

)

Constructs TimeString from std::string.

Exceptions

RtctkException

if format does not match.

TimeString() [3/6]

rtctk::componentFramework::TimeString::TimeString

(

const char *

str

)

Constructs TimeString from c-style string.

Exceptions

RtctkException

if format does not match.

TimeString() [4/6]

template<typename Clock, typename Duration = typename Clock::duration>

rtctk::componentFramework::TimeString::TimeString ( std::chrono::time_point< Clock, Duration > timepoint )

inline

Constructs TimeString from chrono timepoint.

TimeString() [5/6]

rtctk::componentFramework::TimeString::TimeString

(

std::chrono::nanoseconds

ns_since_epoch

)

Constructs TimeString from chrono::nanoseconds (based on taiclock::TaiClock).

TimeString() [6/6]

rtctk::componentFramework::TimeString::TimeString

(

uint64_t

ns_since_epoch

)

Constructs TimeString from nanoseconds number (based on taiclock::TaiClock).

Member Function Documentation

operator std::string()

rtctk::componentFramework::TimeString::operator std::string

(

)

const

Implicit conversion to std::string.

operator==()

bool rtctk::componentFramework::TimeString::operator== ( const TimeString & ) const

default

Operator to test equality.

ToString()

const std::string & rtctk::componentFramework::TimeString::ToString

(

)

const

Explicit conversion to std::string.

Member Data Documentation

value

std::string rtctk::componentFramework::TimeString::value

---

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

• componentFramework/services/common/src/include/rtctk/componentFramework/timeString.hpp
• componentFramework/services/common/src/timeString.cpp