Detailed Description

Model of a time interval.

An interval consisits of a lower and upper bound, plus flags to indicate whether the bounds are inclusive or not. The maximum and minimum values of the time data tyle are interpreted as infinity.

Definition at line 83 of file tp_timeinterval.h.

#include <tp_timeinterval.h>

Public Member Functions
	TimeInterval (void)
	Default constructor - sets time interval to (-inf; +inf) More...

	~TimeInterval (void)
	Default destructor. More...

void	LB (Time::Type time)
	Set the lower bound to a given value. More...

void	UB (Time::Type time)
	Set the upper bound to a given value. More...

void	UBincl (bool incl)
	Configures the upper bound to be inclusive. More...

void	LBincl (bool incl)
	Configures the lower bound to be inclusive. More...

void	setUBinf (void)
	Set upper bound to infinity. More...

void	setLBinf (void)
	Set lower bound to infinity. More...

Time::Type	UB (void) const
	Return upper bound. More...

Time::Type	LB (void) const
	Return lower bound. More...

bool	LBincl (void) const
	Test for lower bound inclusive. More...

bool	UBincl (void) const
	Test for upper bound inclusive. More...

bool	LBinf (void) const
	Test for lower bound infinity. More...

bool	UBinf (void) const
	Test for upper bound infinity. More...

void	Canonical (void)
	Convert to canonical representation. More...

void	SetFull (void)
	Set to full (-inf, +inf) More...

void	SetEmpty (void)
	Set to empty (1, -1) More...

void	SetPositive (void)
	Set to positive [0, inf) More...

void	SetNegative (void)
	Set to negative (-inf, 0]. More...

bool	Full (void) const
	Test whether interval is full. More...

bool	Empty (void) const
	Test interval for empty set. More...

bool	IncludesPositive (void) const
	Test whether interval includes [0,inf) More...

bool	IncludesNegative (void) const
	Test whether interval includes (-inf,0]. More...

bool	In (Time::Type time) const
	Test whether a point satisfies interval. More...

bool	operator== (const TimeInterval &rOtherInterval) const
	Test whether two intervals are equal. More...

bool	operator!= (const TimeInterval &rOtherInterval) const
	Test whether two intervals not equal. More...

void	PositiveLeftShift (Time::Type time)
	Transform by left shift and intersection with [0, inf) More...

void	Intersect (const TimeInterval &rOtherInterval)
	Intersect this interval with other interval. More...

void	Merge (const TimeInterval &rOtherInterval)
	Merge this interval with other interval. More...

std::string	Str (void) const
	Pretty printable string. More...

Static Public Member Functions
static TimeInterval	Intersect (const TimeInterval &rInterval1, const TimeInterval &rInterval2)
	Intersection of two time intervals. More...

static TimeInterval	Merge (const TimeInterval &rInterval1, const TimeInterval &rInterval2)
	Merge this interval with other interval. More...

Private Attributes
Time::Type	mstUB
	Upper bound. More...

Time::Type	mstLB
	Lower bound. More...

bool	mbUBincl
	Flag to indicate that the upper bound is part of the interval. More...

bool	mbLBincl
	Flag to indicate that lower boundary is part of the interval. More...

Constructor & Destructor Documentation

◆ TimeInterval()

faudes::TimeInterval::TimeInterval ( void )

inline

Default constructor - sets time interval to (-inf; +inf)

Definition at line 90 of file tp_timeinterval.h.

◆ ~TimeInterval()

faudes::TimeInterval::~TimeInterval ( void )

inline

Default destructor.

Definition at line 95 of file tp_timeinterval.h.

Member Function Documentation

◆ Canonical()

void TimeInterval::Canonical ( void )

Convert to canonical representation.

Uses Time::Step to convert to aleft closed / right opened representation

Definition at line 18 of file tp_timeinterval.cpp.

◆ Empty()

bool TimeInterval::Empty ( void ) const

Test interval for empty set.

Returns: True if interval is empty

Definition at line 32 of file tp_timeinterval.cpp.

◆ Full()

bool faudes::TimeInterval::Full ( void ) const

inline

Test whether interval is full.

Returns: True if interval is (-inf,+inf)

Definition at line 247 of file tp_timeinterval.h.

◆ In()

bool TimeInterval::In ( Time::Type time ) const

Test whether a point satisfies interval.

Returns: True if interval includes the point

Definition at line 42 of file tp_timeinterval.cpp.

◆ IncludesNegative()

bool faudes::TimeInterval::IncludesNegative ( void ) const

inline

Test whether interval includes (-inf,0].

Returns: True if interval includes (-inf,0]

Definition at line 272 of file tp_timeinterval.h.

◆ IncludesPositive()

bool faudes::TimeInterval::IncludesPositive ( void ) const

inline

Test whether interval includes [0,inf)

Returns: True if interval includes [0,inf)

Definition at line 263 of file tp_timeinterval.h.

◆ Intersect() [1/2]

TimeInterval TimeInterval::Intersect	(	const TimeInterval &	rInterval1,
		const TimeInterval &	rInterval2
	)

static

Intersection of two time intervals.

Parameters

rInterval1	Reference of first time interval
rInterval2	Reference of second time interval

Returns: Intersection of both intervals.

Definition at line 116 of file tp_timeinterval.cpp.

◆ Intersect() [2/2]

void TimeInterval::Intersect ( const TimeInterval & rOtherInterval )

Intersect this interval with other interval.

Parameters

rOtherInterval

Definition at line 87 of file tp_timeinterval.cpp.

◆ LB() [1/2]

void faudes::TimeInterval::LB ( Time::Type time )

inline

Set the lower bound to a given value.

If the value is minus infinity, it is set exclusive. Otherwise, the exclusive/inclusive flag is kept.

Parameters

time	The new value of lower bound

Definition at line 105 of file tp_timeinterval.h.

◆ LB() [2/2]

Time::Type faudes::TimeInterval::LB ( void ) const

inline

Return lower bound.

Returns: lower bound

Definition at line 177 of file tp_timeinterval.h.

◆ LBincl() [1/2]

void faudes::TimeInterval::LBincl ( bool incl )

inline

Configures the lower bound to be inclusive.

If the lower bound is minus infinity, it stays exclusive.

Parameters

incl

Definition at line 147 of file tp_timeinterval.h.

◆ LBincl() [2/2]

bool faudes::TimeInterval::LBincl ( void ) const

inline

Test for lower bound inclusive.

Returns: true for inclusive

Definition at line 184 of file tp_timeinterval.h.

◆ LBinf()

bool faudes::TimeInterval::LBinf ( void ) const

inline

Test for lower bound infinity.

Returns: true for infinity

Definition at line 198 of file tp_timeinterval.h.

◆ Merge() [1/2]

TimeInterval TimeInterval::Merge	(	const TimeInterval &	rInterval1,
		const TimeInterval &	rInterval2
	)

static

Merge this interval with other interval.

I.e. find smallest superset of the union of the two intervals.

Parameters

rInterval1	Reference of first time interval
rInterval2	Reference of second time interval

Returns: Superset of both intervals.

Definition at line 149 of file tp_timeinterval.cpp.

◆ Merge() [2/2]

void TimeInterval::Merge ( const TimeInterval & rOtherInterval )

Merge this interval with other interval.

I.e. find smallest superset of the union of the two intervals.

Parameters

rOtherInterval Reference to other time interval

Definition at line 127 of file tp_timeinterval.cpp.

◆ operator!=()

bool faudes::TimeInterval::operator!= ( const TimeInterval & rOtherInterval ) const

inline

Test whether two intervals not equal.

Note that the test is strictly based on the internal representation, ie [0,10] is not equal to [0,11). This may change in future implementations to consider the Time::TypeStep

Returns: False on equality

Definition at line 311 of file tp_timeinterval.h.

◆ operator==()

bool faudes::TimeInterval::operator== ( const TimeInterval & rOtherInterval ) const

inline

Test whether two intervals are equal.

Note that the test is strictly based on the internal representation, ie [0,10] is not equal to [0,11). This may change in future implementations to consider the Time::TypeStep

Returns: True on equality

Definition at line 293 of file tp_timeinterval.h.

◆ PositiveLeftShift()

void TimeInterval::PositiveLeftShift ( Time::Type time )

Transform by left shift and intersection with [0, inf)

Parameters

time	Amount to shift left

Definition at line 51 of file tp_timeinterval.cpp.

◆ SetEmpty()

void faudes::TimeInterval::SetEmpty ( void )

inline

Set to empty (1, -1)

Definition at line 225 of file tp_timeinterval.h.

◆ SetFull()

void faudes::TimeInterval::SetFull ( void )

inline

Set to full (-inf, +inf)

Definition at line 219 of file tp_timeinterval.h.

◆ setLBinf()

void faudes::TimeInterval::setLBinf ( void )

inline

Set lower bound to infinity.

Definition at line 162 of file tp_timeinterval.h.

◆ SetNegative()

void faudes::TimeInterval::SetNegative ( void )

inline

Set to negative (-inf, 0].

Definition at line 238 of file tp_timeinterval.h.

◆ SetPositive()

void faudes::TimeInterval::SetPositive ( void )

inline

Set to positive [0, inf)

Definition at line 231 of file tp_timeinterval.h.

◆ setUBinf()

void faudes::TimeInterval::setUBinf ( void )

inline

Set upper bound to infinity.

Definition at line 156 of file tp_timeinterval.h.

◆ Str()

std::string TimeInterval::Str ( void ) const

Pretty printable string.

Returns: printable string.

Definition at line 61 of file tp_timeinterval.cpp.

◆ UB() [1/2]

void faudes::TimeInterval::UB ( Time::Type time )

inline

Set the upper bound to a given value.

If the value is infinity, it is set exclusive. Otherwise, the exclusive/inclusive flag is kept.

Parameters

time	The new value of upper bound

Definition at line 121 of file tp_timeinterval.h.

◆ UB() [2/2]

Time::Type faudes::TimeInterval::UB ( void ) const

inline

Return upper bound.

Returns: upper bound

Definition at line 170 of file tp_timeinterval.h.

◆ UBincl() [1/2]

void faudes::TimeInterval::UBincl ( bool incl )

inline

Configures the upper bound to be inclusive.

If the upper bound is infinity, it stays exclusive.

Parameters

incl

Definition at line 135 of file tp_timeinterval.h.

◆ UBincl() [2/2]

bool faudes::TimeInterval::UBincl ( void ) const

inline

Test for upper bound inclusive.

Returns: true for inclusive

Definition at line 191 of file tp_timeinterval.h.

◆ UBinf()

bool faudes::TimeInterval::UBinf ( void ) const

inline

Test for upper bound infinity.

Returns: true for infinity

Definition at line 205 of file tp_timeinterval.h.

Member Data Documentation

◆ mbLBincl

bool faudes::TimeInterval::mbLBincl

private

Flag to indicate that lower boundary is part of the interval.

Definition at line 387 of file tp_timeinterval.h.

◆ mbUBincl

bool faudes::TimeInterval::mbUBincl

private

Flag to indicate that the upper bound is part of the interval.

Definition at line 384 of file tp_timeinterval.h.

◆ mstLB

Time::Type faudes::TimeInterval::mstLB

private

Lower bound.

Definition at line 381 of file tp_timeinterval.h.

◆ mstUB

Time::Type faudes::TimeInterval::mstUB

private

Upper bound.

Definition at line 378 of file tp_timeinterval.h.

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

Detailed Description

Public Member Functions

Static Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ TimeInterval()

◆ ~TimeInterval()

Member Function Documentation

◆ Canonical()

◆ Empty()

◆ Full()

◆ In()

◆ IncludesNegative()

◆ IncludesPositive()

◆ Intersect() [1/2]

◆ Intersect() [2/2]

◆ LB() [1/2]

◆ LB() [2/2]

◆ LBincl() [1/2]

◆ LBincl() [2/2]

◆ LBinf()

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ operator!=()

◆ operator==()

◆ PositiveLeftShift()

◆ SetEmpty()

◆ SetFull()

◆ setLBinf()

◆ SetNegative()

◆ SetPositive()

◆ setUBinf()

◆ Str()

◆ UB() [1/2]

◆ UB() [2/2]

◆ UBincl() [1/2]

◆ UBincl() [2/2]

◆ UBinf()

Member Data Documentation

◆ mbLBincl

◆ mbUBincl

◆ mstLB

◆ mstUB