Public Member Functions | Static Public Member Functions | Public Attributes | Friends
Time Class Reference

A Time class. More...

#include <Time.hh>

List of all members.

Public Member Functions

 Time ()
 Constructors.
 Time (const Time &time)
 Copy constructor.
 Time (const struct timeval &tv)
 Constructor.
 Time (int32_t sec, int32_t nsec)
 Constructor.
 Time (double time)
 Constuctor.
virtual ~Time ()
 Destructor.
void SetToWallTime ()
 Set the time to the wall time.
void Set (int32_t sec, int32_t nsec)
 Set to sec and nsec.
void Set (double seconds)
 Set to seconds.
double Double () const
 Get the time as a double.
const Timeoperator= (const struct timeval &tv)
 Equal opeator.
const Timeoperator= (const Time &time)
 Equal opeator.
Time operator+ (const struct timeval &tv) const
 Addition operators.
const Timeoperator+= (const struct timeval &tv)
 Addition operators.
Time operator+ (const Time &time) const
 Addition operators.
const Timeoperator+= (const Time &time)
 Addition operators.
Time operator- (const struct timeval &tv) const
 Subtraction operator.
const Timeoperator-= (const struct timeval &tv)
 Subtraction operator.
Time operator- (const Time &time) const
 Subtraction operator.
const Timeoperator-= (const Time &time)
 Subtraction operator.
Time operator* (const struct timeval &tv) const
 Multiplication operators.
const Timeoperator*= (const struct timeval &tv)
 Multiplication operators.
Time operator* (const Time &time) const
 Multiplication operators.
const Timeoperator*= (const Time &time)
 Multiplication operators.
Time operator/ (const struct timeval &tv) const
 Division operators.
const Timeoperator/= (const struct timeval &tv)
 Division operators.
Time operator/ (const Time &time) const
 Division operators.
const Timeoperator/= (const Time &time)
 Division operators.
bool operator== (const struct timeval &tv) const
 Equality operators.
bool operator== (const Time &time) const
 Equality operators.
bool operator== (double time) const
 Equality operators.
bool operator!= (const struct timeval &tv) const
 Equality operators.
bool operator!= (const Time &time) const
 Equality operators.
bool operator!= (double time) const
 Equality operators.
bool operator< (const struct timeval &tv) const
 Equality operators.
bool operator< (const Time &time) const
 Equality operators.
bool operator< (double time) const
 Equality operators.
bool operator<= (const struct timeval &tv) const
 Equality operators.
bool operator<= (const Time &time) const
 Equality operators.
bool operator<= (double time) const
 Equality operators.
bool operator> (const struct timeval &tv) const
 Equality operators.
bool operator> (const Time &time) const
 Equality operators.
bool operator> (double time) const
 Equality operators.
bool operator>= (const struct timeval &tv) const
 Equality operators.
bool operator>= (const Time &time) const
 Equality operators.
bool operator>= (double time) const
 Equality operators.

Static Public Member Functions

static const TimeGetWallTime ()
 Get the wall time.
static Time MSleep (unsigned int _ms)
 Millisecond sleep.

Public Attributes

int32_t sec
 Seconds.
int32_t nsec
 Microseconds.

Friends

std::ostream & operator<< (std::ostream &out, const gazebo::common::Time &time)
 Stream operators.
std::istream & operator>> (std::istream &in, gazebo::common::Time &time)

Detailed Description

A Time class.


Constructor & Destructor Documentation

Time ( const Time time)

Copy constructor.

Parameters:
timeTime to copy
Time ( const struct timeval &  tv)

Constructor.

Parameters:
tvTime to initialize to
Time ( int32_t  sec,
int32_t  nsec 
)

Constructor.

Parameters:
secSeconds
nsecMicroseconds
Time ( double  time)

Constuctor.

Parameters:
timeTime in double format sec.nsec

Member Function Documentation

double Double ( ) const

Get the time as a double.

Returns:
Time as a double
void Set ( int32_t  sec,
int32_t  nsec 
)

Set to sec and nsec.

Parameters:
secSeconds
nsecmicro seconds
void Set ( double  seconds)

Set to seconds.

Parameters:
secondsNumber of seconds

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