Time Representation and Utilities

Classes
class	pcl::TimePoint
	An instant in any timescale. More...

Functions
TimePoint	pcl::operator+ (const TimePoint &t, double d)
TimePoint	pcl::operator+ (double d, const TimePoint &t)
TimePoint	pcl::operator- (const TimePoint &t, double d)
constexpr double	pcl::operator- (const TimePoint &t1, const TimePoint &t2)
constexpr bool	pcl::operator< (const TimePoint &t1, const TimePoint &t2)
constexpr bool	pcl::operator< (const TimePoint &t1, double jd2)
constexpr bool	pcl::operator< (double jd1, const TimePoint &t2)
constexpr bool	pcl::operator== (const TimePoint &t1, const TimePoint &t2)
constexpr bool	pcl::operator== (const TimePoint &t1, double jd2)
constexpr bool	pcl::operator== (double jd1, const TimePoint &t2)

Detailed Description

Function Documentation

operator+() [1/2]

TimePoint pcl::operator+ ( const TimePoint &  t, double  d  )

inline

Returns the time point resulting after d days transcurred since a time point t.

Definition at line 1236 of file TimePoint.h.

operator+() [2/2]

TimePoint pcl::operator+ ( double  d, const TimePoint &  t  )

inline

Returns the time point resulting after d days transcurred since a time point t. This operator implements the commutative property of scalar time point addition.

Definition at line 1247 of file TimePoint.h.

operator-() [1/2]

TimePoint pcl::operator- ( const TimePoint &  t, double  d  )

inline

Returns the time point d days before a time point t. Note that scalar time point subtraction is not a commutative operation, so 'd-t' cannot be used.

Definition at line 1258 of file TimePoint.h.

operator-() [2/2]

constexpr double pcl::operator- ( const TimePoint &  t1, const TimePoint &  t2  )

inlineconstexpr

Returns the time interval in days elapsed from the specified time point t1 to another time point t2. The returned value is positive if t2 precedes t1, negative if t1 precedes t2.

Definition at line 1226 of file TimePoint.h.

References pcl::TimePoint::JDF(), and pcl::TimePoint::JDI().

operator<() [1/3]

constexpr bool pcl::operator< ( const TimePoint &  t1, const TimePoint &  t2  )

inlineconstexpr

Returns true iff a TimePoint object t1 represents a time point that precedes the time point represented by another object t2.

Invalid TimePoint instances are always in the infinite past: if t1 is invalid, this function returns true; if t1 is valid and t2 is not valid, this function returns false.

Definition at line 1187 of file TimePoint.h.

References pcl::TimePoint::IsValid(), pcl::TimePoint::JDF(), and pcl::TimePoint::JDI().

operator<() [2/3]

constexpr bool pcl::operator< ( const TimePoint &  t1, double  jd2  )

inlineconstexpr

Returns true iff a TimePoint object t1 represents a time point that precedes another time point jd2, expressed as a Julian date.

Invalid TimePoint instances are always in the infinite past: if t1 is invalid, this function returns true.

Definition at line 1201 of file TimePoint.h.

References pcl::TimePoint::IsValid(), and pcl::TimePoint::JD().

operator<() [3/3]

constexpr bool pcl::operator< ( double  jd1, const TimePoint &  t2  )

inlineconstexpr

Returns true iff a time point jd1, expressed as a Julian date, precedes the time point represented by a TimePoint object t2.

Invalid TimePoint instances are always in the infinite past: if t2 is invalid, this function returns false.

Definition at line 1215 of file TimePoint.h.

References pcl::TimePoint::IsValid(), and pcl::TimePoint::JD().

operator==() [1/3]

constexpr bool pcl::operator== ( const TimePoint &  t1, const TimePoint &  t2  )

inlineconstexpr

Returns true iff two TimePoint objects, t1 and t2, represent the same time point.

Definition at line 1151 of file TimePoint.h.

References pcl::TimePoint::JDF(), and pcl::TimePoint::JDI().

operator==() [2/3]

constexpr bool pcl::operator== ( const TimePoint &  t1, double  jd2  )

inlineconstexpr

Returns true iff a TimePoint object t1 represents the specified time point jd2, expressed as a Julian date.

Definition at line 1161 of file TimePoint.h.

References pcl::TimePoint::JD().

operator==() [3/3]

constexpr bool pcl::operator== ( double  jd1, const TimePoint &  t2  )

inlineconstexpr

Returns true iff a TimePoint object t2 represents the specified time point jd1, expressed as a Julian date. This operator implements the commutative property of scalar time point equality.

Definition at line 1172 of file TimePoint.h.

References pcl::TimePoint::JD().