glibmm: Glib::TimeVal Struct Reference

Glib::TimeVal is a wrapper around the glib structure GTimeVal. More...

#include <glibmm/timeval.h>

Inherits GTimeVal.

List of all members.

Public Member Functions

 TimeVal ()
 TimeVal (long seconds, long microseconds)
 TimeVal (const GTimeVal& gtimeval)
TimeValoperator= (const GTimeVal& gtimeval)
void assign_current_time ()
 Assigns the current time to the TimeVal instance.

bool assign_from_iso8601 (const Glib::ustring& iso_date)
 Converts a string containing an ISO 8601 encoded date and time to a Glib::TimeVal and puts it in TimeVal instance.

void add (const TimeVal& rhs)
void subtract (const TimeVal& rhs)
void add_seconds (long seconds)
void subtract_seconds (long seconds)
void add_milliseconds (long milliseconds)
void subtract_milliseconds (long milliseconds)
void add_microseconds (long microseconds)
void subtract_microseconds (long microseconds)
TimeValoperator+= (const TimeVal& gtimeval)
TimeValoperator-= (const TimeVal& gtimeval)
TimeValoperator+= (long seconds)
TimeValoperator-= (long seconds)
double as_double () const
 Returns a double representation of the time interval.

Glib::ustring as_iso8601 () const
 Returns an ISO 8601 encoded string, relative to the Coordinated Universal Time (UTC).

bool negative () const
bool valid () const
 Checks whether the stored time interval is positive.

Related Functions

(Note that these are not member functions.)

TimeVal operator+ (const TimeVal& lhs, const TimeVal& rhs)
TimeVal operator+ (const TimeVal& lhs, long seconds)
TimeVal operator- (const TimeVal& lhs, const TimeVal& rhs)
TimeVal operator- (const TimeVal& lhs, long seconds)
bool operator== (const TimeVal& lhs, const TimeVal& rhs)
bool operator!= (const TimeVal& lhs, const TimeVal& rhs)
bool operator< (const TimeVal& lhs, const TimeVal& rhs)
bool operator> (const TimeVal& lhs, const TimeVal& rhs)
bool operator<= (const TimeVal& lhs, const TimeVal& rhs)
bool operator>= (const TimeVal& lhs, const TimeVal& rhs)

Detailed Description

Glib::TimeVal is a wrapper around the glib structure GTimeVal.

The glib structure GTimeVal itself is equivalent to struct timeval, which is returned by the gettimeofday() UNIX call. Additionally this wrapper provides an assortment of time manipulation functions.


Constructor & Destructor Documentation

Glib::TimeVal::TimeVal ( ) [inline]
Glib::TimeVal::TimeVal ( long  seconds,
long  microseconds 
) [inline]
Glib::TimeVal::TimeVal ( const GTimeVal &  gtimeval) [inline]

Member Function Documentation

void Glib::TimeVal::add ( const TimeVal rhs)
void Glib::TimeVal::add_microseconds ( long  microseconds)
void Glib::TimeVal::add_milliseconds ( long  milliseconds)
void Glib::TimeVal::add_seconds ( long  seconds)
double Glib::TimeVal::as_double ( ) const [inline]

Returns a double representation of the time interval.

This member function converts the time interval, that is internally stored as two long values for seconds and microseconds, to a double representation, whose unit is seconds.

Glib::ustring Glib::TimeVal::as_iso8601 ( ) const

Returns an ISO 8601 encoded string, relative to the Coordinated Universal Time (UTC).

Since glibmm 2.22:
void Glib::TimeVal::assign_current_time ( )

Assigns the current time to the TimeVal instance.

Equivalent to the UNIX gettimeofday() function, but is portable and works also on Win32.

bool Glib::TimeVal::assign_from_iso8601 ( const Glib::ustring iso_date)

Converts a string containing an ISO 8601 encoded date and time to a Glib::TimeVal and puts it in TimeVal instance.

Parameters:
iso_dateISO 8601 encoded string.
Returns:
true if conversion was successful.
Since glibmm 2.22:
bool Glib::TimeVal::negative ( ) const [inline]
TimeVal& Glib::TimeVal::operator+= ( const TimeVal gtimeval) [inline]
TimeVal& Glib::TimeVal::operator+= ( long  seconds) [inline]
TimeVal& Glib::TimeVal::operator-= ( long  seconds) [inline]
TimeVal& Glib::TimeVal::operator-= ( const TimeVal gtimeval) [inline]
TimeVal& Glib::TimeVal::operator= ( const GTimeVal &  gtimeval) [inline]
void Glib::TimeVal::subtract ( const TimeVal rhs)
void Glib::TimeVal::subtract_microseconds ( long  microseconds)
void Glib::TimeVal::subtract_milliseconds ( long  milliseconds)
void Glib::TimeVal::subtract_seconds ( long  seconds)
bool Glib::TimeVal::valid ( ) const [inline]

Checks whether the stored time interval is positive.

Returns true if the stored time / time interval is positive.


Friends And Related Function Documentation

bool operator!= ( const TimeVal lhs,
const TimeVal rhs 
) [related]
TimeVal operator+ ( const TimeVal lhs,
long  seconds 
) [related]
TimeVal operator+ ( const TimeVal lhs,
const TimeVal rhs 
) [related]
TimeVal operator- ( const TimeVal lhs,
long  seconds 
) [related]
TimeVal operator- ( const TimeVal lhs,
const TimeVal rhs 
) [related]
bool operator< ( const TimeVal lhs,
const TimeVal rhs 
) [related]
bool operator<= ( const TimeVal lhs,
const TimeVal rhs 
) [related]
bool operator== ( const TimeVal lhs,
const TimeVal rhs 
) [related]
bool operator> ( const TimeVal lhs,
const TimeVal rhs 
) [related]
bool operator>= ( const TimeVal lhs,
const TimeVal rhs 
) [related]