OpenRTM-aist  1.2.1
Public Member Functions | List of all members
coil::TimeValue Class Reference

TimeValue class. More...

#include <TimeValue.h>

Public Member Functions

 TimeValue (long sec=0, long usec=0)
 Constructor. More...
 
 TimeValue (double timeval)
 Constructor. More...
 
long int sec () const
 Get value of second time scale. More...
 
long int usec () const
 Get value of micro second time scale. More...
 
TimeValue operator- (TimeValue &tm)
 Time subtraction. More...
 
TimeValue operator+ (TimeValue &tm)
 Time addition. More...
 
TimeValue operator= (double time)
 Convert double type into time type. More...
 
 operator double () const
 Convert time type into double type. More...
 
int sign () const
 Sign judgment. More...
 
void normalize ()
 Normalize. More...
 

Detailed Description

TimeValue class.

Constructor & Destructor Documentation

coil::TimeValue::TimeValue ( long  sec = 0,
long  usec = 0 
)

Constructor.

Constructor Initialize with the specified second and micro second.

Parameters
secSecond(The default value:0)
usecMicro second(The default value:0)
coil::TimeValue::TimeValue ( double  timeval)

Constructor.

Constructor Initialize with the specified second and micro second.

Parameters
timeval(Second * 1000000 + Micro second)

Member Function Documentation

void coil::TimeValue::normalize ( )

Normalize.

Normalize the value expression into a canonical form.

Referenced by usec().

coil::TimeValue::operator double ( ) const

Convert time type into double type.

Convert held information into double type.

Returns
Result for conversion of double type
TimeValue coil::TimeValue::operator+ ( TimeValue tm)

Time addition.

Add the time given by the argument to the set time.

Parameters
tmAdded time
Returns
Addition result

Referenced by usec().

TimeValue coil::TimeValue::operator- ( TimeValue tm)

Time subtraction.

Subtract the time given by the argument from the set time.

Parameters
tmSubtracted time
Returns
Subtraction result

Referenced by usec().

TimeValue coil::TimeValue::operator= ( double  time)

Convert double type into time type.

Convert double type given by the argument into time type.

Parameters
timethe original value
Returns
Conversion result

Referenced by usec().

long int coil::TimeValue::sec ( ) const
inline

Get value of second time scale.

Get value of second time scale.

Returns
value

Referenced by RTC::Timestamp< DataType >::operator()(), RTC::RingBuffer< DataType >::read(), setTimestamp(), coil::sleep(), and RTC::RingBuffer< DataType >::write().

int coil::TimeValue::sign ( ) const

Sign judgment.

Judge sign of the held contents

Returns
1 if the return value is Plus sign, -1 if Minus, and 0 if 0.

Referenced by usec().

long int coil::TimeValue::usec ( ) const
inline

Get value of micro second time scale.

Get value of micro second time scale.

Returns
value

References normalize(), operator+(), operator-(), operator=(), and sign().

Referenced by RTC::Timestamp< DataType >::operator()(), RTC::RingBuffer< DataType >::read(), setTimestamp(), coil::sleep(), and RTC::RingBuffer< DataType >::write().


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