#include <Time.h>

Public Member Functions
	TimePeriod ()

	TimePeriod (Long seconds, long num_ms_or_um=0L, bool is_millisecond=true)

	TimePeriod (long days, long hours, long minutes, long seconds, long num_ms_or_um=0L, bool is_millisecond=true)

	TimePeriod (const timeval &time)

	TimePeriod (const TimePeriod &original)

TimePeriod &	operator= (const Long &time)

TimePeriod &	operator= (const timeval &time)

TimePeriod &	operator= (const TimePeriod &original)

	operator timeval () const

long	to_days () const

long	to_hours () const

long	to_minutes () const

long	to_seconds () const

long	days () const

long	hours () const

long	minutes () const

long	seconds () const

long	microseconds () const

long	milliseconds () const

Long	to_microseconds () const

Long	to_milliseconds () const

void	time_period (Long seconds, long num_ms_or_um=0L, bool is_millisecond=true)

void	time_period (long days, long hours, long minutes, long seconds, long num_ms_or_um=0L, bool is_millisecond=true)

void	time_period (const timeval &time)

AString	to_string () const

AString	to_string_full_precision () const

bool	from_string (const AChar *s)

void	write (OBStream &stream) const

long	read_xml (IBStream &stream)

long	write_xml (OBStream &stream) const

long	read (const CommBuffer &buf)

long	write (CommBuffer &buf) const


TimePeriod	operator+ (const TimePeriod &time) const

TimePeriod	operator- (const TimePeriod &time) const

TimePeriod	operator- () const

TimePeriod &	operator+= (const TimePeriod &time)

TimePeriod &	operator-= (const TimePeriod &time)

TimePeriod	operator* (long value) const

TimePeriod	operator/ (long value) const

TimePeriod	operator% (long value) const

TimePeriod &	operator*= (long value)

TimePeriod &	operator/= (long value)

TimePeriod &	operator%= (long value)

bool	operator< (const TimePeriod &time) const

bool	operator<= (const TimePeriod &time) const

bool	operator> (const TimePeriod &time) const

bool	operator>= (const TimePeriod &time) const

bool	operator== (const TimePeriod &time) const

bool	operator!= (const TimePeriod &time) const

int	compare (const TimePeriod &p) const

Static Public Member Functions
static bool	is_microsecond (long microsecond)

Friends
class	Date

class	Time

class	TimeDate

Detailed Description

Type time duration

Constructor & Destructor Documentation

TimePeriod::TimePeriod ( )

TimePeriod::TimePeriod	(	Long	seconds,
		long	num_ms_or_um = `0L`,
		bool	is_millisecond = `true`
	)

Parameters

seconds	number of seconds in time period
num_ms_or_um	number of miliseconds or microseconds
is_millisecond	if true num_ms_or_um is a number of milliseconds, if false it is a number of microseconds

TimePeriod::TimePeriod	(	long	days,
		long	hours,
		long	minutes,
		long	seconds,
		long	num_ms_or_um = `0L`,
		bool	is_millisecond = `true`
	)

Parameters

days	a number of day in time period
hours	a number of hours
minutes	a number of minute
seconds	a number of second
num_ms_or_um	number of miliseconds or microseconds
is_millisecond	if true nums is a number of milliseconds

TimePeriod::TimePeriod ( const timeval & time )

Parameters

time	a timeval value

TimePeriod::TimePeriod ( const TimePeriod & original )

Member Function Documentation

int TimePeriod::compare ( const TimePeriod & p ) const

long TimePeriod::days ( ) const

Returns: number of days in time period

bool TimePeriod::from_string ( const AChar * s )

Assign time period with string content. Format: ddd:hh:mm:ss.qqqqqq

Parameters

s

long TimePeriod::hours ( ) const

Returns: number of hours remaining

bool TimePeriod::is_microsecond ( long microsecond )

static

Parameters

microsecond

Returns: true if microsecond value is valid

long TimePeriod::microseconds ( ) const

Returns: number of microseconds remaining

long TimePeriod::milliseconds ( ) const

Returns: number of milliseconds remaining

long TimePeriod::minutes ( ) const

Returns: number of minutes remaining

TimePeriod::operator timeval ( ) const

bool TimePeriod::operator!= ( const TimePeriod & time ) const

TimePeriod TimePeriod::operator% ( long value ) const

TimePeriod & TimePeriod::operator%= ( long value )

TimePeriod TimePeriod::operator* ( long value ) const

TimePeriod & TimePeriod::operator*= ( long value )

TimePeriod TimePeriod::operator+ ( const TimePeriod & time ) const

Operator on time period

TimePeriod & TimePeriod::operator+= ( const TimePeriod & time )

TimePeriod TimePeriod::operator- ( const TimePeriod & time ) const

TimePeriod TimePeriod::operator- ( ) const

TimePeriod & TimePeriod::operator-= ( const TimePeriod & time )

TimePeriod TimePeriod::operator/ ( long value ) const

TimePeriod & TimePeriod::operator/= ( long value )

bool TimePeriod::operator< ( const TimePeriod & time ) const

bool TimePeriod::operator<= ( const TimePeriod & time ) const

TimePeriod & TimePeriod::operator= ( const Long & time )

TimePeriod & TimePeriod::operator= ( const timeval & time )

TimePeriod & TimePeriod::operator= ( const TimePeriod & original )

bool TimePeriod::operator== ( const TimePeriod & time ) const

bool TimePeriod::operator> ( const TimePeriod & time ) const

bool TimePeriod::operator>= ( const TimePeriod & time ) const

long TimePeriod::read ( const CommBuffer & buf )

Read time period from communication buffer

long TimePeriod::read_xml ( IBStream & stream )

Read time period from text stream. Format: ddd:hh:mm:ss.qqq

long TimePeriod::seconds ( ) const

Returns: number of seconds remaining

void TimePeriod::time_period	(	Long	seconds,
		long	num_ms_or_um = `0L`,
		bool	is_millisecond = `true`
	)

Assign a time period

Parameters

seconds	a number of seconds
num_ms_or_um	number of miliseconds or microseconds
is_millisecond	if true num_ms_or_um is a number of milliseconds

void TimePeriod::time_period	(	long	days,
		long	hours,
		long	minutes,
		long	seconds,
		long	num_ms_or_um = `0L`,
		bool	is_millisecond = `true`
	)

Assign a time period

Parameters

days	a number of day in time period
hours	a number of hours
minutes	a number of minute
seconds	a number of seconds
num_ms_or_um	number of miliseconds or microseconds
is_millisecond	if true num_ms_or_um is a number of milliseconds

void TimePeriod::time_period ( const timeval & time )

Assign a time period

Parameters

time	a timeval value

long TimePeriod::to_days ( ) const

Returns: number total of days in time period

long TimePeriod::to_hours ( ) const

Returns: number total of hours in time period

Long TimePeriod::to_microseconds ( ) const

Returns: number total of microsecond

Long TimePeriod::to_milliseconds ( ) const

Returns: number total of millisecond

long TimePeriod::to_minutes ( ) const

Returns: number total of minutes in time period

long TimePeriod::to_seconds ( ) const

Returns: number total of seconds in time period

AString TimePeriod::to_string ( ) const

Returns: string version of time period. Format: ddd:hh:mm:ss.qqq

AString TimePeriod::to_string_full_precision ( ) const

Returns: string version of time period. Format: ddd:hh:mm:ss.qqqqqq

void TimePeriod::write ( OBStream & stream ) const

Write time period to text stream. Format: ddd:hh:mm:ss.qqq

long TimePeriod::write ( CommBuffer & buf ) const

Write time period to communication buffer

long TimePeriod::write_xml ( OBStream & stream ) const

Write time period to text stream. Format: ddd:hh:mm:ss.qqq

Friends And Related Function Documentation

friend class Date

friend

friend class Time

friend

friend class TimeDate

friend

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

commore/Time.h
commore/src/Time.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation