ui-utilcpp  1.8.5
Public Types | Public Member Functions
UI::Util::RealTimeStamp Class Reference

RealTimeStamp class encapsulating "gettimeofday". More...

#include <Time.hpp>

Inheritance diagram for UI::Util::RealTimeStamp:
Inheritance graph
Collaboration diagram for UI::Util::RealTimeStamp:
Collaboration graph

Public Types

enum  ErrorCode { NegativeStamp_ =1 }
 Error codes for exceptions.
 
typedef CodeException< ErrorCodeException
 This classes exceptions.
 

Public Member Functions

 RealTimeStamp (long int const &sec=0, long int const &usec=0)
 Standard constructor. More...
 
RealTimeStampset (long int const &sec, long int const &usec)
 Set time stamp manually. More...
 
RealTimeStampsetMax ()
 Set this stamp to maximum.
 
RealTimeStampsetMin ()
 Set this stamp to minimum (Epoch)
 
RealTimeStampstamp ()
 Set time stamp from current time. More...
 
long int getSec () const
 Get seconds since Epoch.
 
long int getUSec () const
 Get micro seconds since Epoch+sec.
 
long double getSeconds () const
 Get seconds (since Epoch) as real number (including micro seconds).
 
bool operator== (RealTimeStamp const &rt) const
 Standard == operator.
 
bool operator< (RealTimeStamp const &rt) const
 Standard < operator.
 
bool operator<= (RealTimeStamp const &rt) const
 Standard <= operator.
 
RealTimeStampoperator+= (RealTimeStamp const &rt)
 Standard += operator.
 
RealTimeStamp operator+ (RealTimeStamp const &rt) const
 Standard + operator.
 
RealTimeStampoperator-= (RealTimeStamp const &rt)
 Standard -= operator.
 
RealTimeStamp operator- (RealTimeStamp const &rt) const
 Standard - operator.
 

Detailed Description

RealTimeStamp class encapsulating "gettimeofday".

See also
time(2) (POSIX), gettimeofday(2) (BSD).

Constructor & Destructor Documentation

UI::Util::RealTimeStamp::RealTimeStamp ( long int const &  sec = 0,
long int const &  usec = 0 
)

Standard constructor.

Parameters
secSeconds since Epoch.
usecMicro (10^-6) seconds since Epoch+sec.
Note
Values will be "normalised" (make microseconds < 10^6). Altogether, it must not be a negative date (before Epoch).

Referenced by UI::Util::operator<<().

Member Function Documentation

RealTimeStamp & UI::Util::RealTimeStamp::set ( long int const &  sec,
long int const &  usec 
)

Set time stamp manually.

Parameters
secSeconds since Epoch.
usecMicro (10^-6) seconds since Epoch+sec.
Returns
Reference to itself
RealTimeStamp & UI::Util::RealTimeStamp::stamp ( )

Set time stamp from current time.

Returns
Reference to itself

Referenced by UI::Util::operator<<().


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