E::TimeUtil Class Reference

TimerUtil provides utilities for time calculation. Using this class instead of Time variable directly provides better compatibility for further improvement. More...

#include <E_TimeUtil.hpp>

Public Types
enum	TimeUnit {   NSEC , USEC , MSEC , SEC ,   MINUTE , HOUR , DAY , NONE }
	Enumerations for time unit.

Static Public Member Functions
static enum TimeUnit	stringToTimeUnit (const std::string &unit)
	Converts time unit string to TimeUnit enumeration.
static std::string	timeUnitToString (enum TimeUnit unit)
	Converts TimeUnit enumeration to time unit string.
static Size	getMultiplier (enum TimeUnit unit)
	Calculates multiplier for given time unit from the minimal TimeUnit. Current minimal TimeUnit is NSEC. For example, multiplier for millisecond is 1,000,000 and for microsecond is 1,000.
static Time	makeTime (Size time, enum TimeUnit unit)
	Produces nanosecond time from a time in given time unit.
static Size	getTime (Time time, enum TimeUnit unit)
	Converts nanosecond time value to a time in given time unit.
static std::string	printTime (Time time, enum TimeUnit unit)
	Converts nanosecond time value to a time in given time unit in string.

Detailed Description

TimerUtil provides utilities for time calculation. Using this class instead of Time variable directly provides better compatibility for further improvement.

Note

Current unit of Time is unsigned 64bit integer in nanoseconds. However, it may be extended to picosecond resolution or real number resolution. TimerUtil provides consistent view of Time.

Member Function Documentation

getMultiplier()

Size E::TimeUtil::getMultiplier ( enum TimeUnit  unit )

static

Calculates multiplier for given time unit from the minimal TimeUnit. Current minimal TimeUnit is NSEC. For example, multiplier for millisecond is 1,000,000 and for microsecond is 1,000.

Parameters

unit	TimeUtil::TimeUnit enumeration

Returns

Multiplier for given TimeUtil::TimeUnit enumeration

getTime()

Size E::TimeUtil::getTime ( Time  time, enum TimeUnit  unit  )

static

Converts nanosecond time value to a time in given time unit.

Parameters

time	Time value in nanosecond
unit	TimeUtil::TimeUnit enumeration

Returns

Time value in given time unit

makeTime()

Time E::TimeUtil::makeTime ( Size  time, enum TimeUnit  unit  )

static

Produces nanosecond time from a time in given time unit.

Parameters

time	Time value in given time unit
unit	TimeUtil::TimeUnit enumeration

Returns

Time value (currently, in nanosecond)

printTime()

std::string E::TimeUtil::printTime ( Time  time, enum TimeUnit  unit  )

static

Converts nanosecond time value to a time in given time unit in string.

Parameters

time	Time value in nanosecond
unit	TimeUtil::TimeUnit enumeration

Returns

Time string in given time unit

stringToTimeUnit()

enum TimeUtil::TimeUnit E::TimeUtil::stringToTimeUnit ( const std::string &  unit )

static

Converts time unit string to TimeUnit enumeration.

Parameters

unit	Time unit string (e.g. "NSEC", "USEC", etc.)

Returns

TimeUtil::TimeUnit enumeration for given time unit string

timeUnitToString()

std::string E::TimeUtil::timeUnitToString ( enum TimeUnit  unit )

static

Converts TimeUnit enumeration to time unit string.

Parameters

unit	TimeUtil::TimeUnit enumeration

Returns

Time unit string for given TimeUnit enumeration

---

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

• include/E/E_TimeUtil.hpp
• src/E/E_TimeUtil.cpp