#include <TimeSpan.h>

Inheritance diagram for utl::TimeSpan:

[legend]

Public Member Functions
	TimeSpan (const Span< Time, Duration > &rhs)
	Constructor. More...

	TimeSpan (const Time &begin, const Time &end)
	Constructor. More...

virtual int	compare (const Object &rhs) const
	Compare with another instance. More...

Duration	duration () const
	Get the duration of the span. More...

uint_t	numSpanned (const Duration &dur) const
	Get the number of times the given duration is spanned. More...

uint_t	numSpanned (uint_t unit) const
	Get the number of times the given unit is spanned. More...

void	shift (const Duration &rhs)
	Add the given duration to the begin and end times. More...

bool	spans (uint_t unit, uint_t num=1) const
	Determine whether self spans the given multiple of the given unit. More...

const TimeSpan &	operator+= (const Duration &rhs)
	Add the given duration to the begin and end times. More...

const TimeSpan &	operator-= (const Duration &rhs)
	Subtract the given duration from the begin and end times. More...

Public Member Functions inherited from utl::ObjectSpan< Time, Duration >
	ObjectSpan (Span< Time, Duration > span)
	Constructor. More...

Public Member Functions inherited from utl::Span< Time, Duration >
	Span (const Time &begin, const Time &end, bool relaxed=false)
	Constructor. More...

Span< Time, Duration > &	clip (const Span< Time, Duration > &span)
	Clip against the given span. More...

Span< Time, Duration > &	clipBegin (const Time &t)
	Clip the beginning against the given value. More...

Span< Time, Duration > &	clipEnd (const Time &t)
	Clip the end against the given value. More...

bool	contains (const Span< Time, Duration > &span) const
	Determine whether self contains the given span. More...

bool	contains (const Time &v) const
	Determine whether self contains the given value. More...

bool	isContainedBy (const Span< Time, Duration > &span) const
	Determine whether self is contained by the given span. More...

void	merge (const Span< Time, Duration > &span)
	Merge with the given span. More...

Span< Time, Duration >	overlap (const Span< Time, Duration > &span) const
	Return the sub-span that overlaps with the given span. More...

bool	overlaps (const Span< Time, Duration > &span) const
	Determine whether self overlaps with the given span. More...

Duration	overlapSize (const Span< Time, Duration > &span) const
	Return the length of the overlap with the given span. More...

Span< Time, Duration >	remove (const Span< Time, Duration > &span)
	Remove the given span from self. More...

Span< Time, Duration >	operator+ (const Span< Time, Duration > &rhs)
	Return self merged with the given span. More...

const Span< Time, Duration > &	operator+= (const Span< Time, Duration > &rhs)
	Merge with the given span. More...

const Time &	begin () const
	Get the beginning of the span. More...

void	setBegin (const Time &begin)
	Set the beginning of the span. More...

const Time &	end () const
	Get the end of the span. More...

void	setEnd (const Time &end)
	Set the end of the span. More...

void	set (const Time &begin, const Time &end)
	Set the beginning and end of the span. More...

bool	isNil () const
	Determine whether the span is nil. More...

void	setNil ()
	Set the span to nil. More...

bool	isRelaxed () const
	Get the relaxed flag. More...

void	setRelaxed (bool relaxed)
	Set the relaxed flag. More...

Duration	size () const
	Return the size (end - begin). More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...

virtual	~FlagsMI ()
	Destructor. More...

void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...

void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...

void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...

uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

uint64_t	getFlags () const
	Get the flags. More...

void	setFlags (uint64_t flags)
	Set the flags. More...

Detailed Description

Time span.

TimeSpan is a specialization of Span for Time values.

Author: Adam McKee

Definition at line 26 of file TimeSpan.h.

Constructor & Destructor Documentation

◆ TimeSpan() [1/2]

utl::TimeSpan::TimeSpan ( const Span< Time, Duration > & rhs )

inline

Constructor.

Parameters

rhs	Span instance to copy

Definition at line 36 of file TimeSpan.h.

References utl::Span< T, D >::begin(), and utl::Span< T, D >::end().

◆ TimeSpan() [2/2]

utl::TimeSpan::TimeSpan	(	const Time &	begin,
		const Time &	end
	)

inline

Constructor.

Parameters

begin	begin time
end	end time

Definition at line 47 of file TimeSpan.h.

References utl::compare().

Member Function Documentation

◆ compare()

virtual int utl::TimeSpan::compare ( const Object & rhs ) const

virtual

Compare with another instance.

Reimplemented from utl::Span< Time, Duration >.

◆ duration()

Duration utl::TimeSpan::duration ( ) const

inline

Get the duration of the span.

Definition at line 57 of file TimeSpan.h.

◆ numSpanned() [1/2]

uint_t utl::TimeSpan::numSpanned ( const Duration & dur ) const

Get the number of times the given duration is spanned.

◆ numSpanned() [2/2]

uint_t utl::TimeSpan::numSpanned ( uint_t unit ) const

Get the number of times the given unit is spanned.

See also: tm_unit_t

◆ shift()

void utl::TimeSpan::shift ( const Duration & rhs )

inline

Add the given duration to the begin and end times.

Definition at line 73 of file TimeSpan.h.

◆ spans()

bool utl::TimeSpan::spans	(	uint_t	unit,
		uint_t	num = `1`
	)		const

inline

Determine whether self spans the given multiple of the given unit.

See also: tm_unit_t

Definition at line 84 of file TimeSpan.h.

◆ operator+=()

const TimeSpan& utl::TimeSpan::operator+= ( const Duration & rhs )

inline

Add the given duration to the begin and end times.

Definition at line 90 of file TimeSpan.h.

◆ operator-=()

const TimeSpan& utl::TimeSpan::operator-= ( const Duration & rhs )

inline

Subtract the given duration from the begin and end times.

Definition at line 97 of file TimeSpan.h.

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

TimeSpan.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeSpan() [1/2]

◆ TimeSpan() [2/2]

Member Function Documentation

◆ compare()

◆ duration()

◆ numSpanned() [1/2]

◆ numSpanned() [2/2]

◆ shift()

◆ spans()

◆ operator+=()

◆ operator-=()