This class represents a TimePeriod in ticks. More...

#include <Imt.Base.OS.WinEC7/TimePeriod.h>

Public Member Functions
virtual	~TimePeriod (void)
	Destructor.

	TimePeriod (const TimePeriod &other)
	Provide the copy constructor so the compiler does not generate the default one. More...

TimePeriod &	operator= (const TimePeriod &other)
	Provide the assignment operator so the compiler does not generate the default one. More...

const TimePeriod &	operator+= (const TimePeriod &timePeriod)
	Operator "+=", this += timePeriod. More...

const TimePeriod &	operator-= (const TimePeriod &timePeriod)
	Operator "-=", this -= timePeriod. More...

bool	operator> (const TimePeriod &timePeriod) const
	Operator ">", bool = this > timePeriod. More...

bool	operator>= (const TimePeriod &timePeriod) const
	Operator ">=", bool = this > timePeriod. More...

bool	operator< (const TimePeriod &timePeriod) const
	Operator "<", bool = this < timePeriod. More...

bool	operator<= (const TimePeriod &timePeriod) const
	Operator "<=", bool = this <= timePeriod. More...

bool	operator== (const TimePeriod &timePeriod) const
	Operator "==", bool = this == timePeriod. More...

bool	operator!= (const TimePeriod &timePeriod) const
	Operator "!=", bool = this != timePeriod. More...

uint32_t	getSeconds (void) const
	Gets the number of seconds represented by this TimePeriod. More...

uint32_t	getMilliSeconds (void) const
	Gets the number of milliseconds represented by this TimePeriod. More...

uint32_t	getMicroSeconds (void) const
	Gets the number of micro seconds represented by this TimePeriod. More...

uint32_t	getTicks (void) const
	Gets the number of ticks represented by this TimePeriod. More...

Static Public Member Functions
static TimePeriod	fromSeconds (uint32_t seconds)
	Creates a TimePeriod from the given amount of seconds. More...

static TimePeriod	fromMilliSeconds (uint32_t milliSeconds)
	Creates a TimePeriod form the given amount of milliseconds. More...

static TimePeriod	fromMicroSeconds (uint32_t microSeconds)
	Creates a TimePeriod from the given amount of microseconds. More...

static TimePeriod	fromTicks (uint32_t ticks)
	Creates a TimePeriod from the given amount of ticks. More...

Detailed Description

This class represents a TimePeriod in ticks.

Attention: internal calculation is done with a uint32_t. This results in a maximum time period of 1.19 h. A tick gets its unit by the concrete implementation of Imt.Dff.OS.WinEC7.SystemTime.

Constructor & Destructor Documentation

◆ TimePeriod()

imt::base::os::winec7::TimePeriod::TimePeriod ( const TimePeriod & other )

Provide the copy constructor so the compiler does not generate the default one.

Parameters

other Another TimePeriod instance whose members get copied.

Member Function Documentation

◆ fromMicroSeconds()

static TimePeriod imt::base::os::winec7::TimePeriod::fromMicroSeconds ( uint32_t microSeconds )

static

Creates a TimePeriod from the given amount of microseconds.

Parameters

microSeconds Number of micro seconds over which the created TimePeriod spans.

Returns: Newly created instance.

◆ fromMilliSeconds()

static TimePeriod imt::base::os::winec7::TimePeriod::fromMilliSeconds ( uint32_t milliSeconds )

static

Creates a TimePeriod form the given amount of milliseconds.

Parameters

milliSeconds Number of milli seconds over which the created TimePeriod spans.

Returns: Newly created instance.

◆ fromSeconds()

static TimePeriod imt::base::os::winec7::TimePeriod::fromSeconds ( uint32_t seconds )

static

Creates a TimePeriod from the given amount of seconds.

Parameters

seconds Number of seconds over which the created TimePeriod spans.

Returns: Newly created instance.

◆ fromTicks()

static TimePeriod imt::base::os::winec7::TimePeriod::fromTicks ( uint32_t ticks )

static

Creates a TimePeriod from the given amount of ticks.

Parameters

ticks Number of ticks over which the created TimePeriod spans.

Returns: Newly created instance.

◆ getMicroSeconds()

uint32_t imt::base::os::winec7::TimePeriod::getMicroSeconds ( void ) const

Gets the number of micro seconds represented by this TimePeriod.

Returns: Number of micro seconds that this TimePeriod represents.

◆ getMilliSeconds()

uint32_t imt::base::os::winec7::TimePeriod::getMilliSeconds ( void ) const

Gets the number of milliseconds represented by this TimePeriod.

Returns: Number of milliseconds that this TimePeriod represents.

◆ getSeconds()

uint32_t imt::base::os::winec7::TimePeriod::getSeconds ( void ) const

Gets the number of seconds represented by this TimePeriod.

Returns: Number of seconds that this TimePeriod represents.

◆ getTicks()

uint32_t imt::base::os::winec7::TimePeriod::getTicks ( void ) const

Gets the number of ticks represented by this TimePeriod.

Returns: Number of ticks that this TimePeriod represents.

◆ operator!=()

bool imt::base::os::winec7::TimePeriod::operator!= ( const TimePeriod & timePeriod ) const

Operator "!=", bool = this != timePeriod.

Parameters

timePeriod Time period to which gets compared.

Returns: True if this != timePeriod.

◆ operator+=()

const TimePeriod& imt::base::os::winec7::TimePeriod::operator+= ( const TimePeriod & timePeriod )

Operator "+=", this += timePeriod.

Parameters

timePeriod Time period that gets added to this.

Returns: This instance.

◆ operator-=()

const TimePeriod& imt::base::os::winec7::TimePeriod::operator-= ( const TimePeriod & timePeriod )

Operator "-=", this -= timePeriod.

Parameters

timePeriod Time period that gets subtracted to this.

Returns: This instance.

◆ operator<()

bool imt::base::os::winec7::TimePeriod::operator< ( const TimePeriod & timePeriod ) const

Operator "<", bool = this < timePeriod.

Parameters

timePeriod Time period to which gets compared.

Returns: True if this < timePeriod.

◆ operator<=()

bool imt::base::os::winec7::TimePeriod::operator<= ( const TimePeriod & timePeriod ) const

Operator "<=", bool = this <= timePeriod.

Parameters

timePeriod Time period to which gets compared.

Returns: True if this <= timePeriod.

◆ operator=()

TimePeriod& imt::base::os::winec7::TimePeriod::operator= ( const TimePeriod & other )

Provide the assignment operator so the compiler does not generate the default one.

Parameters

other Another TimePeriod instance whose members get copied.

Returns: This instance. (The instance to which other as been assighned to.)

◆ operator==()

bool imt::base::os::winec7::TimePeriod::operator== ( const TimePeriod & timePeriod ) const

Operator "==", bool = this == timePeriod.

Parameters

timePeriod Time period to which gets compared.

Returns: True if this == timePeriod.

◆ operator>()

bool imt::base::os::winec7::TimePeriod::operator> ( const TimePeriod & timePeriod ) const

Operator ">", bool = this > timePeriod.

Parameters

timePeriod Time period to which gets compared.

Returns: True if this > timePeriod.

◆ operator>=()

bool imt::base::os::winec7::TimePeriod::operator>= ( const TimePeriod & timePeriod ) const

Operator ">=", bool = this > timePeriod.

Parameters

timePeriod Time period to which gets compared.

Returns: True if this >= timePeriod.

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

D:/_Work/10/s/Imt.Base/Imt.Base.OS.WinEC7/TimePeriod.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TimePeriod()

Member Function Documentation

◆ fromMicroSeconds()

◆ fromMilliSeconds()

◆ fromSeconds()

◆ fromTicks()

◆ getMicroSeconds()

◆ getMilliSeconds()

◆ getSeconds()

◆ getTicks()

◆ operator!=()

◆ operator+=()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()