boost::posix_time::time_duration Class Reference

Base time duration type. More...

#include <posix_time_config.hpp>

Inheritance diagram for boost::posix_time::time_duration:

Collaboration diagram for boost::posix_time::time_duration:

Public Types
typedef time_res_traits	rep_type
typedef time_res_traits::day_type	day_type
typedef time_res_traits::hour_type	hour_type
typedef time_res_traits::min_type	min_type
typedef time_res_traits::sec_type	sec_type
typedef time_res_traits::fractional_seconds_type	fractional_seconds_type
typedef time_res_traits::tick_type	tick_type
typedef time_res_traits::impl_type	impl_type
typedef time_duration	duration_type
typedef time_res_traits	traits_type

Public Member Functions
	time_duration (hour_type hour, min_type min, sec_type sec, fractional_seconds_type fs=0)
	time_duration ()
	time_duration (boost::date_time::special_values sv)
	Construct from special_values. More...
hour_type	hours () const
	Returns number of hours in the duration. More...
min_type	minutes () const
	Returns normalized number of minutes. More...
sec_type	seconds () const
	Returns normalized number of seconds (0..60) More...
sec_type	total_seconds () const
	Returns total number of seconds truncating any fractional seconds. More...
tick_type	total_milliseconds () const
	Returns total number of milliseconds truncating any fractional seconds. More...
tick_type	total_nanoseconds () const
	Returns total number of nanoseconds truncating any sub millisecond values. More...
tick_type	total_microseconds () const
	Returns total number of microseconds truncating any sub microsecond values. More...
fractional_seconds_type	fractional_seconds () const
	Returns count of fractional seconds at given resolution. More...
duration_type	invert_sign () const
bool	is_negative () const
bool	operator< (const time_duration &rhs) const
bool	operator== (const time_duration &rhs) const
duration_type	operator- () const
	unary- Allows for time_duration td = -td1 More...
duration_type	operator- (const duration_type &d) const
duration_type	operator+ (const duration_type &d) const
duration_type	operator/ (int divisor) const
duration_type	operator-= (const duration_type &d)
duration_type	operator+= (const duration_type &d)
duration_type	operator/= (int divisor)
	Division operations on a duration with an integer. More...
duration_type	operator* (int rhs) const
	Multiplication operations an a duration with an integer. More...
duration_type	operator*= (int divisor)
tick_type	ticks () const
bool	is_special () const
	Is ticks_ a special value? More...
bool	is_pos_infinity () const
	Is duration pos-infinity. More...
bool	is_neg_infinity () const
	Is duration neg-infinity. More...
bool	is_not_a_date_time () const
	Is duration not-a-date-time. More...
impl_type	get_rep () const
	Used for special_values output. More...

Static Public Member Functions
static duration_type	unit ()
	Returns smallest representable duration. More...
static tick_type	ticks_per_second ()
	Return the number of ticks in a second. More...
static time_resolutions	resolution ()
	Provide the resolution of this duration type. More...
static unsigned short	num_fractional_digits ()
	Returns number of possible digits in fractional seconds. More...

Protected Member Functions
	time_duration (impl_type tick_count)

Protected Attributes
impl_type	ticks_

Friends
class	date_time::time_duration< time_duration, time_res_traits >

Detailed Description

Base time duration type.

Member Typedef Documentation

typedef time_res_traits::day_type boost::posix_time::time_duration::day_type

typedef time_duration boost::date_time::time_duration< time_duration , time_res_traits >::duration_type

inherited

typedef time_res_traits::fractional_seconds_type boost::posix_time::time_duration::fractional_seconds_type

typedef time_res_traits::hour_type boost::posix_time::time_duration::hour_type

typedef time_res_traits::impl_type boost::posix_time::time_duration::impl_type

typedef time_res_traits::min_type boost::posix_time::time_duration::min_type

typedef time_res_traits boost::posix_time::time_duration::rep_type

typedef time_res_traits::sec_type boost::posix_time::time_duration::sec_type

typedef time_res_traits::tick_type boost::posix_time::time_duration::tick_type

typedef time_res_traits boost::date_time::time_duration< time_duration , time_res_traits >::traits_type

inherited

Constructor & Destructor Documentation

boost::posix_time::time_duration::time_duration ( hour_type  hour, min_type  min, sec_type  sec, fractional_seconds_type  fs = 0  )

inline

boost::posix_time::time_duration::time_duration ( )

inline

boost::posix_time::time_duration::time_duration ( boost::date_time::special_values  sv )

inline

Construct from special_values.

boost::posix_time::time_duration::time_duration ( impl_type  tick_count )

inlineexplicitprotected

Member Function Documentation

fractional_seconds_type boost::date_time::time_duration< time_duration , time_res_traits >::fractional_seconds ( ) const

inlineinherited

Returns count of fractional seconds at given resolution.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

impl_type boost::date_time::time_duration< time_duration , time_res_traits >::get_rep ( ) const

inlineinherited

Used for special_values output.

References boost::date_time::time_duration< T, rep_type >::ticks_.

hour_type boost::date_time::time_duration< time_duration , time_res_traits >::hours ( ) const

inlineinherited

Returns number of hours in the duration.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::invert_sign ( ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::is_neg_infinity ( ) const

inlineinherited

Is duration neg-infinity.

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::is_negative ( ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::is_not_a_date_time ( ) const

inlineinherited

Is duration not-a-date-time.

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::is_pos_infinity ( ) const

inlineinherited

Is duration pos-infinity.

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::is_special ( ) const

inlineinherited

Is ticks_ a special value?

References boost::date_time::time_duration< T, rep_type >::ticks_.

min_type boost::date_time::time_duration< time_duration , time_res_traits >::minutes ( ) const

inlineinherited

Returns normalized number of minutes.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

static unsigned short boost::date_time::time_duration< time_duration , time_res_traits >::num_fractional_digits ( )

inlinestaticinherited

Returns number of possible digits in fractional seconds.

Referenced by boost::posix_time::to_iso_string_type(), and boost::posix_time::to_simple_string_type().

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator* ( int  rhs ) const

inlineinherited

Multiplication operations an a duration with an integer.

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator*= ( int  divisor )

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator+ ( const duration_type &  d ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator+= ( const duration_type &  d )

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator- ( ) const

inlineinherited

unary- Allows for time_duration td = -td1

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator- ( const duration_type &  d ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator-= ( const duration_type &  d )

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator/ ( int  divisor ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

duration_type boost::date_time::time_duration< time_duration , time_res_traits >::operator/= ( int  divisor )

inlineinherited

Division operations on a duration with an integer.

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::operator< ( const time_duration< time_duration, time_res_traits > &  rhs ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

bool boost::date_time::time_duration< time_duration , time_res_traits >::operator== ( const time_duration< time_duration, time_res_traits > &  rhs ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

static time_resolutions boost::date_time::time_duration< time_duration , time_res_traits >::resolution ( )

inlinestaticinherited

Provide the resolution of this duration type.

sec_type boost::date_time::time_duration< time_duration , time_res_traits >::seconds ( ) const

inlineinherited

Returns normalized number of seconds (0..60)

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

tick_type boost::date_time::time_duration< time_duration , time_res_traits >::ticks ( ) const

inlineinherited

References boost::date_time::time_duration< T, rep_type >::ticks_.

static tick_type boost::date_time::time_duration< time_duration , time_res_traits >::ticks_per_second ( )

inlinestaticinherited

Return the number of ticks in a second.

tick_type boost::date_time::time_duration< time_duration , time_res_traits >::total_microseconds ( ) const

inlineinherited

Returns total number of microseconds truncating any sub microsecond values.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

tick_type boost::date_time::time_duration< time_duration , time_res_traits >::total_milliseconds ( ) const

inlineinherited

Returns total number of milliseconds truncating any fractional seconds.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

tick_type boost::date_time::time_duration< time_duration , time_res_traits >::total_nanoseconds ( ) const

inlineinherited

Returns total number of nanoseconds truncating any sub millisecond values.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

sec_type boost::date_time::time_duration< time_duration , time_res_traits >::total_seconds ( ) const

inlineinherited

Returns total number of seconds truncating any fractional seconds.

References boost::date_time::time_duration< T, rep_type >::ticks(), and boost::date_time::time_duration< T, rep_type >::ticks_per_second().

static duration_type boost::date_time::time_duration< time_duration , time_res_traits >::unit ( )

inlinestaticinherited

Returns smallest representable duration.

Friends And Related Function Documentation

friend class date_time::time_duration< time_duration, time_res_traits >

friend

Member Data Documentation

impl_type boost::date_time::time_duration< time_duration , time_res_traits >::ticks_

protectedinherited

---

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

• boost_1_57_0/boost/date_time/posix_time/posix_time_config.hpp