JLANG::JTimeval Class Reference

Auxiliary class for time values. More...

#include <JTimeval.hh>

Inheritance diagram for JLANG::JTimeval:

Public Member Functions
	JTimeval ()
	Default constructor. More...
	JTimeval (const int tv_us)
	Constructor. More...
	JTimeval (const int tv_s, const int tv_us)
	Constructor. More...
const JTimeval &	getTimeval () const
	Get time value. More...
JTimeval &	getTimeval ()
	Get time value. More...
void	setTimeval (const JTimeval &timeval)
	Set time value. More...
bool	less (const JTimeval &value) const
	Less than method. More...
const timeval *	get () const
	Get pointer to time value. More...
timeval *	get ()
	Get pointer to time value. More...
const timeval *	operator& () const
	Address of operator. More...
timeval *	operator& ()
	Address of operator. More...

Static Public Member Functions
static JTimeval	min ()
	Get minimal time value. More...
static JTimeval	max ()
	Get maximal time value. More...

Friends
std::istream &	operator>> (std::istream &in, JTimeval &time)
	Read time value from input. More...
std::ostream &	operator<< (std::ostream &out, const JTimeval &time)
	Write time value to output. More...

Detailed Description

Auxiliary class for time values.

This class encapsulates the timeval data structure.

Definition at line 26 of file JTimeval.hh.

Constructor & Destructor Documentation

JTimeval() [1/3]

JLANG::JTimeval::JTimeval ( )

inline

Default constructor.

Definition at line 34 of file JTimeval.hh.

    {
      this->tv_sec  = 0;
      this->tv_usec = 0;
    }

JTimeval() [2/3]

JLANG::JTimeval::JTimeval ( const int  tv_us )

inline

Constructor.

Parameters

tv_us

time [us]

Definition at line 46 of file JTimeval.hh.

    {
      this->tv_sec  = 0;
      this->tv_usec = tv_us;
    }

JTimeval() [3/3]

JLANG::JTimeval::JTimeval ( const int  tv_s, const int  tv_us  )

inline

Constructor.

Parameters

tv_s	time [s]
tv_us	time [us]

Definition at line 59 of file JTimeval.hh.

    {
      this->tv_sec  = tv_s;
      this->tv_usec = tv_us;
    }

Member Function Documentation

getTimeval() [1/2]

const JTimeval& JLANG::JTimeval::getTimeval ( ) const

inline

Get time value.

Returns

time value

Definition at line 71 of file JTimeval.hh.

    {
      return static_cast<const JTimeval&>(*this);
    }

getTimeval() [2/2]

JTimeval& JLANG::JTimeval::getTimeval ( )

inline

Get time value.

Returns

time value

Definition at line 82 of file JTimeval.hh.

    {
      return static_cast<JTimeval&>(*this);
    }

setTimeval()

void JLANG::JTimeval::setTimeval ( const JTimeval &  timeval )

inline

Set time value.

Parameters

timeval

time value

Definition at line 93 of file JTimeval.hh.

    {
      static_cast<JTimeval&>(*this) = timeval;
    }

less()

bool JLANG::JTimeval::less ( const JTimeval &  value ) const

inline

Less than method.

Parameters

value

time value

Returns

true if this time value less than given time value; else false

Definition at line 105 of file JTimeval.hh.

    {
      if (this->tv_sec == value.tv_sec)
        return this->tv_usec < value.tv_usec;
      else
        return this->tv_sec  < value.tv_sec;
    }

min()

static JTimeval JLANG::JTimeval::min ( )

inlinestatic

Get minimal time value.

Returns

time value

Definition at line 119 of file JTimeval.hh.

    {
      return JTimeval(0, 0);
    }

max()

static JTimeval JLANG::JTimeval::max ( )

inlinestatic

Get maximal time value.

Returns

time value

Definition at line 131 of file JTimeval.hh.

    {
      return JTimeval(std::numeric_limits<int>::max(), std::numeric_limits<int>::max());
    }

get() [1/2]

const timeval* JLANG::JTimeval::get ( ) const

inline

Get pointer to time value.

Returns

pointer to time value

Definition at line 143 of file JTimeval.hh.

    {
      return static_cast<const timeval*>(this);
    }

get() [2/2]

timeval* JLANG::JTimeval::get ( )

inline

Get pointer to time value.

Returns

pointer to time value

Definition at line 154 of file JTimeval.hh.

    {
      return static_cast<timeval*>(this);
    }

operator&() [1/2]

const timeval* JLANG::JTimeval::operator& ( ) const

inline

Address of operator.

Returns

pointer to time value

Definition at line 165 of file JTimeval.hh.

    {
      return get();
    }

operator&() [2/2]

timeval* JLANG::JTimeval::operator& ( )

inline

Address of operator.

Returns

pointer to time value

Definition at line 176 of file JTimeval.hh.

    {
      return get();
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JTimeval &  time  )

friend

Read time value from input.

Parameters

in	input stream
time	time value

Returns

input stream

Definition at line 189 of file JTimeval.hh.

    {
      return in >> time.tv_sec >> time.tv_usec;
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JTimeval &  time  )

friend

Write time value to output.

Parameters

out	output stream
time	time value

Returns

output stream

Definition at line 202 of file JTimeval.hh.

    {
      return out << time.tv_sec << ' ' << time.tv_usec;
    }

---

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

• JTimeval.hh