Sirikata::Task::DeltaTime Class Reference

Represents the difference of two time values. More...

#include <Time.hpp>

Collaboration diagram for Sirikata::Task::DeltaTime:

List of all members.

Public Member Functions
	DeltaTime ()
double	operator/ (const DeltaTime &other) const
DeltaTime	operator/ (float32 rhs) const
void	operator/= (float32 rhs)
DeltaTime	operator/ (float64 rhs) const
void	operator/= (float64 rhs)
DeltaTime	operator/ (int32 rhs) const
void	operator/= (int32 rhs)
DeltaTime	operator/ (uint32 rhs) const
void	operator/= (uint32 rhs)
DeltaTime	operator/ (int64 rhs) const
void	operator/= (int64 rhs)
DeltaTime	operator/ (uint64 rhs) const
void	operator/= (uint64 rhs)
DeltaTime	operator* (float32 rhs) const
void	operator*= (float32 rhs)
DeltaTime	operator* (float64 rhs) const
void	operator*= (float64 rhs)
DeltaTime	operator* (int32 rhs) const
void	operator*= (int32 rhs)
DeltaTime	operator* (uint32 rhs) const
void	operator*= (uint32 rhs)
DeltaTime	operator* (int64 rhs) const
void	operator*= (int64 rhs)
DeltaTime	operator* (uint64 rhs) const
void	operator*= (uint64 rhs)
class LocalTime	fromNow () const
	Simple helper function -- returns "LocalTime::now() + (*this)".
DeltaTime	operator- (const DeltaTime &other) const
	Arethmetic operator-- subtract two DeltaTime values.
DeltaTime	operator+ (const DeltaTime &other) const
	Arethmetic operator-- add two DeltaTime values.
DeltaTime	operator+= (const DeltaTime &other)
	Arethmetic operator-- add two DeltaTime values.
DeltaTime	operator-= (const DeltaTime &other)
	Arethmetic operator-- subtract two DeltaTime values.
DeltaTime	operator- () const
	Arethmetic operator-- negate a DeltaTime.
double	toSeconds () const
double	seconds () const
int64	toMilliseconds () const
	Convert to an integer in milliseconds.
int64	milliseconds () const
int64	toMicroseconds () const
	Convert to an integer in microseconds.
int64	microseconds () const
int64	toMicro () const
	Convert to an integer in microseconds.
bool	operator== (const DeltaTime &other) const
	Equality comparison.
bool	operator!= (const DeltaTime &other) const
bool	operator< (const DeltaTime &other) const
	Ordering comparison.
bool	operator<= (const DeltaTime &other) const
bool	operator> (const DeltaTime &other) const
bool	operator>= (const DeltaTime &other) const
String	toString () const
Static Public Member Functions
static DeltaTime	hours (double s)
static DeltaTime	minutes (double s)
static DeltaTime	seconds (double s)
static DeltaTime	milliseconds (double ms)
static DeltaTime	milliseconds (int64 ms)
static DeltaTime	milliseconds (uint64 ms)
static DeltaTime	milliseconds (int32 ms)
static DeltaTime	milliseconds (uint32 ms)
static DeltaTime	microseconds (double us)
static DeltaTime	microseconds (int64 us)
static DeltaTime	microseconds (uint64 us)
static DeltaTime	microseconds (int32 us)
static DeltaTime	microseconds (uint32 us)
static DeltaTime	nanoseconds (int64 ns)
static DeltaTime	nanoseconds (uint64 ns)
static DeltaTime	nanoseconds (int32 ns)
static DeltaTime	nanoseconds (uint32 ns)
static DeltaTime	zero ()
	Return a zero length duration.
Private Member Functions
	DeltaTime (int64 us)
Private Attributes
int64	mDeltaTime

---

Detailed Description

Represents the difference of two time values.

Can be created either by calling the constructor with a double delta time, or by subtracting two absolute times.

To convert x to an absolute time, use LocalTime::now() + x

See also:

LocalTime

---

Constructor & Destructor Documentation

Sirikata::Task::DeltaTime::DeltaTime

(

int64

us

)

[inline, explicit, private]

Sirikata::Task::DeltaTime::DeltaTime

(

)

[inline]

---

Member Function Documentation

LocalTime Sirikata::Task::DeltaTime::fromNow

(

)

const [inline]

Simple helper function -- returns "LocalTime::now() + (*this)".

References Sirikata::Task::LocalTime::now().

static DeltaTime Sirikata::Task::DeltaTime::hours

(

double

s

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::microseconds

(

int64

us

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::microseconds

(

uint64

us

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::microseconds

(

int32

us

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::microseconds

(

uint32

us

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::microseconds

(

double

us

)

[inline, static]

int64 Sirikata::Task::DeltaTime::microseconds

(

)

const [inline]

Referenced by Sirikata::Task::LocalTime::operator-(), and Sirikata::Task::operator>>().

static DeltaTime Sirikata::Task::DeltaTime::milliseconds

(

int32

ms

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::milliseconds

(

uint32

ms

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::milliseconds

(

double

ms

)

[inline, static]

int64 Sirikata::Task::DeltaTime::milliseconds

(

)

const [inline]

Referenced by Sirikata::Task::operator>>().

static DeltaTime Sirikata::Task::DeltaTime::milliseconds

(

int64

ms

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::milliseconds

(

uint64

ms

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::minutes

(

double

s

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::nanoseconds

(

int64

ns

)

[inline, static]

Referenced by zero().

static DeltaTime Sirikata::Task::DeltaTime::nanoseconds

(

int32

ns

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::nanoseconds

(

uint32

ns

)

[inline, static]

static DeltaTime Sirikata::Task::DeltaTime::nanoseconds

(

uint64

ns

)

[inline, static]

bool Sirikata::Task::DeltaTime::operator!=

(

const DeltaTime &

other

)

const [inline]

References mDeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator*

(

int32

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator*

(

float64

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator*

(

uint32

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator*

(

int64

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator*

(

uint64

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator*

(

float32

rhs

)

const [inline]

void Sirikata::Task::DeltaTime::operator*=

(

float32

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator*=

(

float64

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator*=

(

int32

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator*=

(

uint32

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator*=

(

int64

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator*=

(

uint64

rhs

)

[inline]

DeltaTime Sirikata::Task::DeltaTime::operator+

(

const DeltaTime &

other

)

const [inline]

Arethmetic operator-- add two DeltaTime values.

References mDeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator+=

(

const DeltaTime &

other

)

[inline]

Arethmetic operator-- add two DeltaTime values.

References mDeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator-

(

const DeltaTime &

other

)

const [inline]

Arethmetic operator-- subtract two DeltaTime values.

References mDeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator-

(

)

const [inline]

Arethmetic operator-- negate a DeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator-=

(

const DeltaTime &

other

)

[inline]

Arethmetic operator-- subtract two DeltaTime values.

References mDeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator/

(

uint32

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator/

(

float32

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator/

(

float64

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator/

(

int64

rhs

)

const [inline]

DeltaTime Sirikata::Task::DeltaTime::operator/

(

uint64

rhs

)

const [inline]

double Sirikata::Task::DeltaTime::operator/

(

const DeltaTime &

other

)

const [inline]

References mDeltaTime.

DeltaTime Sirikata::Task::DeltaTime::operator/

(

int32

rhs

)

const [inline]

void Sirikata::Task::DeltaTime::operator/=

(

uint64

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator/=

(

int64

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator/=

(

uint32

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator/=

(

int32

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator/=

(

float64

rhs

)

[inline]

void Sirikata::Task::DeltaTime::operator/=

(

float32

rhs

)

[inline]

bool Sirikata::Task::DeltaTime::operator<

(

const DeltaTime &

other

)

const [inline]

Ordering comparison.

References mDeltaTime.

bool Sirikata::Task::DeltaTime::operator<=

(

const DeltaTime &

other

)

const [inline]

References mDeltaTime.

bool Sirikata::Task::DeltaTime::operator==

(

const DeltaTime &

other

)

const [inline]

Equality comparison.

References mDeltaTime.

bool Sirikata::Task::DeltaTime::operator>

(

const DeltaTime &

other

)

const [inline]

References mDeltaTime.

bool Sirikata::Task::DeltaTime::operator>=

(

const DeltaTime &

other

)

const [inline]

References mDeltaTime.

static DeltaTime Sirikata::Task::DeltaTime::seconds

(

double

s

)

[inline, static]

double Sirikata::Task::DeltaTime::seconds

(

)

const [inline]

Referenced by Sirikata::Task::operator>>().

int64 Sirikata::Task::DeltaTime::toMicro

(

)

const [inline]

Convert to an integer in microseconds.

Referenced by Sirikata::Task::LocalTime::operator+(), and Sirikata::Task::LocalTime::operator+=().

int64 Sirikata::Task::DeltaTime::toMicroseconds

(

)

const [inline]

Convert to an integer in microseconds.

Referenced by Sirikata::Task::operator<<().

int64 Sirikata::Task::DeltaTime::toMilliseconds

(

)

const [inline]

Convert to an integer in milliseconds.

double Sirikata::Task::DeltaTime::toSeconds

(

)

const [inline]

Referenced by Sirikata::Graphics::OgreSystemInputHandler::fpsUpdateTick(), Sirikata::Task::operator<<(), and Sirikata::Graphics::OgreSystemInputHandler::renderStatsUpdateTick().

String Sirikata::Task::DeltaTime::toString

(

)

const

static DeltaTime Sirikata::Task::DeltaTime::zero

(

)

[inline, static]

Return a zero length duration.

References nanoseconds().

---

Member Data Documentation

int64 Sirikata::Task::DeltaTime::mDeltaTime [private]

Referenced by operator!=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

---

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

• libcore/include/sirikata/core/task/Time.hpp
• libcore/src/task/Time.cpp